HBhvSensor
-
class
HBhvSensor The
HBhvSensorclass encapsulates an animation sensor.A
HBhvSensorobjects holds a list of conditions which are usually related to an object in the segment hierachy and actions that should be performed based on whether these conditions are met.
Methods
-
HBhvSensor::HBhvSensor(char const *name, bool active, HBhvBehaviorManager *BehaviorManager) Constructs an
HBhvSensorobject.Parameters
name: The name of the sensor.
active: The activity state. Pass true if you want this sensor to be active by default.
BehaviorManager: A pointer to the
HBhvBehaviorManagerobject.
-
virtual
HBhvSensor::~HBhvSensor() virtual
-
void
HBhvSensor::AddCondition(HBhvCondition *condition) Adds a new condition to the condition list.
Parameters
condition: A pointer to condition object to be added.
-
void
HBhvSensor::Serialize(HUtilityXMLGenerator *xmlgen) Writes XML data to a buffer.
-
HBhvBehaviorManager *
HBhvSensor::GetBehaviorManager() Returns
A pointer toHBhvBehaviorManagerobject
-
void
HBhvSensor::Activate(int delay = 0) This method activates the sensor. It fires the sensor activated event and registers the items in the conditions array.
Parameters
delay: The delay time in ticks before activation.
-
void
HBhvSensor::DeActivate() This method deactivates the sensor and unregisters all the items in the conditions array.
-
bool
HBhvSensor::GetDefaultActive() Returns
True if the sensor is active by default or false if the sensor is inactive by default.
-
bool
HBhvSensor::GetCurrentlyActive() Returns
True if the sensor is currently active or false if ensor is not currently active.
-
bool
HBhvSensor::Evaluate() Evaluates the sensor conditions. If the conditions are met, then the actions list is executed.
Returns
True if the conditions are met to true or false if conditions are not met.
-
void
HBhvSensor::AddAction(HBhvAction *action) Adds a new item to the action list.
Parameters
action: A pointer to the action object you want added.
-
char const *
HBhvSensor::GetName() Returns
A pointer to the name of the sensor.
-
void
HBhvSensor::Tick() Performs any time based sensor action.
-
static void *
HBhvSensor::XMLCallback(HUtilityXMLTag *xt, bool open, void *m_pExtraData) static
This is XML read callback which parses XML data and then populates the member variables with the associated values.
Variables
-
char
HBhvSensor::m_Name[256] protected
charThe sensor name
-
HBhvBehaviorManager *
HBhvSensor::m_pBehaviorManager protected
A pointer to behaviour manager for this sensor.
-
struct vlist_s *
HBhvSensor::m_ConditionList protected
struct vlist_sThe list of conditions.
-
struct vlist_s *
HBhvSensor::m_ActionList protected
struct vlist_sThe list of actions.
-
bool
HBhvSensor::m_bCurrentlyActive protected
boolThe value is true if the sensor is currently active or false if the sensor not active.
-
bool
HBhvSensor::m_bDefaultActive protected
boolThe value is true if the sensor is active by default, false if the sensor not active by default.
-
int
HBhvSensor::m_Delay protected
intThe delay before the sensor activates.