forked from bartvdbraak/blender
81 lines
2.0 KiB
Python
81 lines
2.0 KiB
Python
# $Id$
|
|
# Documentation for SCA_ISensor
|
|
from SCA_ILogicBrick import *
|
|
|
|
class SCA_ISensor(SCA_ILogicBrick):
|
|
"""
|
|
Base class for all sensor logic bricks.
|
|
"""
|
|
|
|
def isPositive():
|
|
"""
|
|
True if this sensor brick has been activated.
|
|
"""
|
|
|
|
def getUsePosPulseMode():
|
|
"""
|
|
True if the sensor is in positive pulse mode.
|
|
"""
|
|
def setUsePosPulseMode(pulse):
|
|
"""
|
|
Sets positive pulse mode.
|
|
|
|
@type pulse: boolean
|
|
@param pulse: If True, will activate positive pulse mode for this sensor.
|
|
"""
|
|
def getFrequency():
|
|
"""
|
|
The frequency for pulse mode sensors.
|
|
|
|
@rtype: integer
|
|
@return: the pulse frequency in 1/50 sec.
|
|
"""
|
|
def setFrequency(freq):
|
|
"""
|
|
Sets the frequency for pulse mode sensors.
|
|
|
|
@type freq: integer
|
|
@return: the pulse frequency in 1/50 sec.
|
|
"""
|
|
def getUseNegPulseMode():
|
|
"""
|
|
True if the sensor is in negative pulse mode.
|
|
"""
|
|
def setUseNegPulseMode(pulse):
|
|
"""
|
|
Sets negative pulse mode.
|
|
|
|
@type pulse: boolean
|
|
@param pulse: If True, will activate negative pulse mode for this sensor.
|
|
"""
|
|
def getInvert():
|
|
"""
|
|
True if this sensor activates on negative events.
|
|
"""
|
|
def setInvert(invert):
|
|
"""
|
|
Sets if this sensor activates on positive or negative events.
|
|
|
|
@type invert: boolean
|
|
@param invert: true if activates on negative events; false if activates on positive events.
|
|
"""
|
|
def getLevel():
|
|
"""
|
|
Returns whether this sensor is a level detector or a edge detector.
|
|
It makes a difference only in case of logic state transition (state actuator).
|
|
A level detector will immediately generate a pulse, negative or positive
|
|
depending on the sensor condition, as soon as the state is activated.
|
|
A edge detector will wait for a state change before generating a pulse.
|
|
|
|
@rtype: boolean
|
|
@return: true if sensor is level sensitive, false if it is edge sensitive
|
|
"""
|
|
def setLevel(level):
|
|
"""
|
|
Set whether to detect level or edge transition when entering a state.
|
|
|
|
@param level: Detect level instead of edge? (KX_TRUE, KX_FALSE)
|
|
@type level: boolean
|
|
"""
|
|
|