The HBhvSensor class encapsulates an animation sensor.
More...
#include <HBhvSensor.h>
|
static void * | XMLCallback (HUtilityXMLTag *xt, bool open, void *m_pExtraData) |
|
The HBhvSensor class encapsulates an animation sensor.
A HBhvSensor objects 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.
◆ HBhvSensor()
HBhvSensor::HBhvSensor |
( |
const char * |
name, |
|
|
bool |
active, |
|
|
HBhvBehaviorManager * |
BehaviorManager |
|
) |
| |
Constructs an HBhvSensor object.
- 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 HBhvBehaviorManager object. |
◆ Activate()
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. |
◆ AddAction()
Adds a new item to the action list.
- Parameters
-
action | A pointer to the action object you want added. |
◆ AddCondition()
Adds a new condition to the condition list.
- Parameters
-
condition | A pointer to condition object to be added. |
◆ DeActivate()
void HBhvSensor::DeActivate |
( |
| ) |
|
This method deactivates the sensor and unregisters all the items in the conditions array.
◆ Evaluate()
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.
◆ GetBehaviorManager()
◆ GetCurrentlyActive()
bool HBhvSensor::GetCurrentlyActive |
( |
| ) |
|
|
inline |
- Returns
- True if the sensor is currently active or false if ensor is not currently active.
◆ GetDefaultActive()
bool HBhvSensor::GetDefaultActive |
( |
| ) |
|
|
inline |
- Returns
- True if the sensor is active by default or false if the sensor is inactive by default.
◆ GetName()
const char* HBhvSensor::GetName |
( |
| ) |
|
|
inline |
- Returns
- A pointer to the name of the sensor.
◆ Serialize()
void HBhvSensor::Serialize |
( |
HUtilityXMLGenerator * |
xmlgen | ) |
|
Writes XML data to a buffer.
◆ Tick()
void HBhvSensor::Tick |
( |
| ) |
|
Performs any time based sensor action.
◆ XMLCallback()
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.
◆ m_ActionList
struct vlist_s* HBhvSensor::m_ActionList |
|
protected |
◆ m_bCurrentlyActive
bool HBhvSensor::m_bCurrentlyActive |
|
protected |
The value is true if the sensor is currently active or false if the sensor not active.
◆ m_bDefaultActive
bool HBhvSensor::m_bDefaultActive |
|
protected |
The value is true if the sensor is active by default, false if the sensor not active by default.
◆ m_ConditionList
struct vlist_s* HBhvSensor::m_ConditionList |
|
protected |
◆ m_Delay
The delay before the sensor activates.
◆ m_Name
char HBhvSensor::m_Name[256] |
|
protected |
◆ m_pBehaviorManager
A pointer to behaviour manager for this sensor.
The documentation for this class was generated from the following file: