#include <spStoryboardTrigger.hpp>

Inheritance diagram for sp::tool::Trigger:

Public Member Functions
virtual	~Trigger ()
virtual bool	active () const
	Returns true if any of the trigger's parents is already being triggered or this trigger has no parents.
virtual bool	needLoopUpdate () const
virtual bool	canTrigger () const
	Returns true if this trigger can be triggered. By default true.
void	trigger ()
void	untrigger ()
virtual void	connect (Trigger *ChildTrigger)
virtual void	disconnect (Trigger *ChildTrigger)
virtual void	clearTriggers ()
virtual void	onTriggered ()
	Event callback function when the trigger will be triggerd.
virtual void	onUntriggered ()
	Event callback function when the trigger will be untriggerd.
virtual void	onRunning ()
	Event callback function during the trigger is running.
const std::vector< Trigger * > &	getChildList () const
const std::vector< Trigger * > &	getParentList () const
bool	triggered () const
	Returns true if this trigger is currently being triggered.
Protected Member Functions
	Trigger ()
void	addToLoopUpdate ()
void	removeFromLoopUpdate ()
void	updateStates ()
Protected Attributes
bool	IsTriggered_
bool	WasActive_

Constructor & Destructor Documentation

virtual sp::tool::Trigger::~Trigger ( ) [virtual]

sp::tool::Trigger::Trigger ( ) [protected]

Member Function Documentation

virtual bool sp::tool::Trigger::active ( ) const [virtual]

Returns true if any of the trigger's parents is already being triggered or this trigger has no parents.

Returns true if this trigger is active. For this it must be triggerd and all its parents must be active.

Reimplemented in sp::tool::LogicGate.

void sp::tool::Trigger::addToLoopUpdate ( ) [protected]

virtual bool sp::tool::Trigger::canTrigger ( ) const [virtual]

Returns true if this trigger can be triggered. By default true.

Reimplemented in sp::tool::TriggerCounter.

virtual void sp::tool::Trigger::clearTriggers ( ) [virtual]

virtual void sp::tool::Trigger::connect ( Trigger * ChildTrigger ) [virtual]

virtual void sp::tool::Trigger::disconnect ( Trigger * ChildTrigger ) [virtual]

const std::vector<Trigger*>& sp::tool::Trigger::getChildList ( ) const [inline]

const std::vector<Trigger*>& sp::tool::Trigger::getParentList ( ) const [inline]

virtual bool sp::tool::Trigger::needLoopUpdate ( ) const [virtual]

Returns true if this trigger class needs to be updated every frame when it's active. By default false. Overwrite this function if you need a loop update.

Reimplemented in sp::tool::LogicGate.

virtual void sp::tool::Trigger::onRunning ( ) [virtual]

Event callback function during the trigger is running.

virtual void sp::tool::Trigger::onTriggered ( ) [virtual]

Event callback function when the trigger will be triggerd.

Reimplemented in sp::tool::EventTimer, sp::tool::TriggerCounter, and sp::tool::TriggerSwitch.

virtual void sp::tool::Trigger::onUntriggered ( ) [virtual]

Event callback function when the trigger will be untriggerd.

Reimplemented in sp::tool::TriggerSwitch.

void sp::tool::Trigger::removeFromLoopUpdate ( ) [protected]

void sp::tool::Trigger::trigger ( )

bool sp::tool::Trigger::triggered ( ) const [inline]