orxonox::Trigger Class Reference

#include <src/orxonox/objects/worldentities/triggers/Trigger.h>

Inheritance diagram for orxonox::Trigger:

orxonox::StaticEntity orxonox::Tickable orxonox::WorldEntity orxonox::OrxonoxClass orxonox::BaseObject orxonox::Synchronisable orxonox::OrxonoxClass orxonox::OrxonoxClass orxonox::EventTrigger orxonox::PlayerTrigger orxonox::DistanceTrigger orxonox::CheckPoint

List of all members.

Public Member Functions

void addTrigger (Trigger *trigger)
virtual void changedVisibility ()
 This function gets called if the visibility of the object changes.
int getActivations () const
float getDelay () const
bool getInvert () const
TriggerMode::Value getMode () const
bool getStayActive () const
bool getSwitch () const
const TriggergetTrigger (unsigned int index) const
bool isActive () const
 Returns the state of the objects activity.
void setActivations (int activations)
void setDelay (float delay)
void setInvert (bool bInvert)
void setMode (TriggerMode::Value mode)
void setMode (const std::string &modeName)
void setStayActive (bool bStayActive)
void setSwitch (bool bSwitch)
void setVisible (bool visibility)
 Sets the state of the objects visibility.
bool switchState ()
virtual void tick (float dt)
 Gets called every frame.
 Trigger (BaseObject *creator)
virtual void XMLPort (Element &xmlelement, XMLPort::Mode mode)
 XML loading and saving.
virtual ~Trigger ()

Static Public Member Functions

static void debugFlares (bool bVisible)

Protected Member Functions

virtual bool isTriggered (TriggerMode::Value mode)
bool isTriggered ()
virtual void triggered (bool bIsTriggered)

Private Member Functions

bool checkAnd ()
bool checkOr ()
bool checkXor ()
std::string getModeString () const
void setBillboardColour (const ColourValue &colour)
void storeState ()

Private Attributes

bool bActive_
 True = the object is active.
bool bFirstTick_
bool bInvertMode_
bool bStayActive_
bool bSwitch_
bool bTriggered_
std::set< Trigger * > children_
BillboardSet debugBillboard_
float delay_
char latestState_
TriggerMode::Value mode_
int remainingActivations_
float remainingTime_
std::queue< std::pair< float,
char > > 
stateChanges_
float timeSinceLastEvent_


Constructor & Destructor Documentation

orxonox::Trigger::Trigger ( BaseObject creator  ) 

orxonox::Trigger::~Trigger (  )  [virtual]


Member Function Documentation

void orxonox::Trigger::addTrigger ( Trigger trigger  ) 

References children_.

Referenced by XMLPort().

void orxonox::Trigger::changedVisibility (  )  [virtual]

This function gets called if the visibility of the object changes.

Reimplemented from orxonox::BaseObject.

References debugBillboard_, orxonox::BaseObject::isVisible(), orxonox::BillboardSet::setVisible(), and SUPER.

bool orxonox::Trigger::checkAnd (  )  [private]

References children_.

Referenced by isTriggered().

bool orxonox::Trigger::checkOr (  )  [private]

References children_.

Referenced by isTriggered().

bool orxonox::Trigger::checkXor (  )  [private]

References children_.

Referenced by isTriggered().

void orxonox::Trigger::debugFlares ( bool  bVisible  )  [static]

int orxonox::Trigger::getActivations (  )  const [inline]

Referenced by XMLPort().

float orxonox::Trigger::getDelay (  )  const [inline]

Referenced by XMLPort().

bool orxonox::Trigger::getInvert (  )  const [inline]

Referenced by XMLPort().

TriggerMode::Value orxonox::Trigger::getMode ( void   )  const [inline]

std::string orxonox::Trigger::getModeString (  )  const [private]

bool orxonox::Trigger::getStayActive (  )  const [inline]

Referenced by XMLPort().

bool orxonox::Trigger::getSwitch (  )  const [inline]

Referenced by XMLPort().

const Trigger * orxonox::Trigger::getTrigger ( unsigned int  index  )  const

References children_.

Referenced by XMLPort().

bool orxonox::Trigger::isActive ( void   )  const [inline]

Returns the state of the objects activity.

Returns:
The state of the activity

Reimplemented from orxonox::BaseObject.

bool orxonox::Trigger::isTriggered ( TriggerMode::Value  mode  )  [protected, virtual]

bool orxonox::Trigger::isTriggered (  )  [inline, protected]

void orxonox::Trigger::setActivations ( int  activations  )  [inline]

Referenced by XMLPort().

void orxonox::Trigger::setBillboardColour ( const ColourValue &  colour  )  [private]

void orxonox::Trigger::setDelay ( float  delay  ) 

References delay_, and timeSinceLastEvent_.

Referenced by XMLPort().

void orxonox::Trigger::setInvert ( bool  bInvert  )  [inline]

Referenced by XMLPort().

void orxonox::Trigger::setMode ( TriggerMode::Value  mode  )  [inline]

void orxonox::Trigger::setMode ( const std::string modeName  ) 

void orxonox::Trigger::setStayActive ( bool  bStayActive  )  [inline]

void orxonox::Trigger::setSwitch ( bool  bSwitch  )  [inline]

Referenced by XMLPort().

void orxonox::Trigger::setVisible ( bool  bVisible  )  [inline]

Sets the state of the objects visibility.

Parameters:
bVisible True = visible

Reimplemented from orxonox::BaseObject.

void orxonox::Trigger::storeState (  )  [private]

bool orxonox::Trigger::switchState (  ) 

void orxonox::Trigger::tick ( float  dt  )  [virtual]

void orxonox::Trigger::triggered ( bool  bIsTriggered  )  [protected, virtual]

void orxonox::Trigger::XMLPort ( Element &  xmlelement,
XMLPort::Mode  mode 
) [virtual]

XML loading and saving.

Parameters:
xmlelement The XML-element
loading Loading (true) or saving (false)
Returns:
The XML-element

Reimplemented from orxonox::WorldEntity.

Reimplemented in orxonox::CheckPoint, orxonox::DistanceTrigger, and orxonox::PlayerTrigger.

References addTrigger(), getActivations(), getDelay(), getInvert(), getModeString(), getStayActive(), getSwitch(), getTrigger(), setActivations(), setDelay(), setInvert(), setMode(), setStayActive(), setSwitch(), SUPER, XMLPortObject, XMLPortParam, and XMLPortParamTemplate.


Member Data Documentation

True = the object is active.

Reimplemented from orxonox::BaseObject.

Referenced by tick(), and Trigger().

Referenced by tick(), and Trigger().

Referenced by tick(), and Trigger().

Referenced by switchState(), and Trigger().

Referenced by tick(), and Trigger().

Referenced by tick(), and Trigger().

std::set<Trigger*> orxonox::Trigger::children_ [private]

float orxonox::Trigger::delay_ [private]

Referenced by setDelay(), tick(), and Trigger().

Referenced by storeState(), switchState(), tick(), and Trigger().

Referenced by getModeString(), and Trigger().

Referenced by switchState(), and Trigger().

Referenced by storeState(), tick(), and Trigger().

std::queue<std::pair<float, char> > orxonox::Trigger::stateChanges_ [private]

Referenced by storeState(), and tick().

Referenced by setDelay(), storeState(), tick(), and Trigger().


The documentation for this class was generated from the following files:

Generated on Tue Jul 28 16:23:12 2009 for Orxonox by  doxygen 1.5.6