LRT14  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator
Event Class Referenceabstract

Base class for events, which are used to control automation routines. More...

#include <Event.h>

Inheritance diagram for Event:

Public Member Functions

virtual bool CheckCondition ()=0
 Checks if the condition required to fire this event is met, regardless of the last cycle.
 
virtual bool Fired ()
 Checks if the event fired this cycle (condition not true last cycle but true this cycle).
 
virtual void Update ()
 Updates the event. Should be called at the end of the cycle.
 
void AddStartListener (Automation *routine)
 Adds an automation routine to be started when this event fires.
 
void AddAbortListener (Automation *routine)
 Adds an automation routine to be aborted when this event fires.
 
void AddContinueListener (Automation *routine)
 Adds an automation routine to be continued when this event fires.
 
std::vector< Automation * > & GetStartListeners ()
 Gets the automation routines that are started by this event.
 
std::vector< Automation * > & GetAbortListeners ()
 Gets the automation routines that are aborted by this event.
 
std::vector< Automation * > & GetContinueListeners ()
 Gets the automation routines that are continued by this event.
 

Detailed Description

Base class for events, which are used to control automation routines.

Member Function Documentation

void Event::AddAbortListener ( Automation routine)

Adds an automation routine to be aborted when this event fires.

Parameters
routinethe routine to add
void Event::AddContinueListener ( Automation routine)

Adds an automation routine to be continued when this event fires.

Parameters
routinethe routine to add
void Event::AddStartListener ( Automation routine)

Adds an automation routine to be started when this event fires.

Parameters
routinethe routine to add
virtual bool Event::CheckCondition ( )
pure virtual

Checks if the condition required to fire this event is met, regardless of the last cycle.

Returns
if the condition is met

Implemented in GameModeChangeEvent, MultipleEvent, JoystickMovedEvent, JoystickPressedEvent, JoystickReleasedEvent, DelayedEvent, and ValueChangeEvent< T >.

Here is the caller graph for this function:

bool Event::Fired ( )
virtual

Checks if the event fired this cycle (condition not true last cycle but true this cycle).

Returns
if the event fired

Reimplemented in GameModeChangeEvent.

Here is the caller graph for this function:

vector< Automation * > & Event::GetAbortListeners ( )

Gets the automation routines that are aborted by this event.

Returns
a vector of automation routines to be aborted
vector< Automation * > & Event::GetContinueListeners ( )

Gets the automation routines that are continued by this event.

Returns
a vector of automation routines to be continued
vector< Automation * > & Event::GetStartListeners ( )

Gets the automation routines that are started by this event.

Returns
a vector of automation routines to be started

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