Benoit Bolsee
fda00bc034
Introduction of a new Delay sensor that can be used to generate positive and negative triggers at precise time, expressed in number of frames. The delay parameter defines the length of the initial OFF period. A positive trigger is generated at the end of this period. The duration parameter defines the length of the ON period following the OFF period. A negative trigger is generated at the end of the ON period. If duration is 0, the sensor stays ON and there is no negative trigger. The sensor runs the OFF-ON cycle once unless the repeat option is set: the OFF-ON cycle repeats indefinately (or the OFF cycle if duration is 0). The new generic SCA_ISensor::reset() Python function can be used at any time to restart the sensor: the current cycle is interrupted and no trigger is generated.
87 lines
2.2 KiB
Python
87 lines
2.2 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
|
|
"""
|
|
def reset():
|
|
"""
|
|
Reset sensor internal state, effect depends on the type of sensor and settings.
|
|
|
|
The sensor is put in its initial state as if it was just activated.
|
|
"""
|
|
|