Facebook Twitter YouTube

class TriggerObject

Defined in:  TSTriggers.h
The TriggerObject class encapsulates data pertaining to a trigger.
Definition

class TriggerObject : public Object, public VolumeObject

Member Functions
TriggerObject::GetTriggerType Returns the specific type of a trigger.
TriggerObject::GetTriggerFlags Returns the trigger flags.
TriggerObject::SetTriggerFlags Sets the trigger flags.
TriggerObject::GetTargetConnectorKey Returns the connector key for the trigger's target node.
TriggerObject::SetTargetConnectorKey Sets the connector key for the trigger's target node.
Constructor

TriggerObject(TriggerType type, Volume *volume);

Parameters
type The type of the trigger. See below for a list of possible types.
volume A pointer to the generic volume object representing the trigger.
Description
The TriggerObject class is the base class for all types of trigger objects, and it stores data that is common to all of them. Each specific type of trigger has an associated object that is a subclass of the TriggerObject class.

A trigger object can have one of the following types.
kTriggerBox Box trigger.
kTriggerCylinder Cylinder trigger.
kTriggerSphere Sphere trigger.
Base Classes
Object A TriggerObject is an object that can be shared by multiple trigger nodes.
VolumeObject Used internally by the engine for generic volume objects.
See Also

Trigger

Wiki Articles

Triggers