FIFE  6e1afdbeda11afe9ac53e6023a4be96ef88f1dc6
FIFE::TimeEvent Class Referenceabstract

Interface for events to be registered with TimeManager. More...

#include <timeevent.h>

+ Inheritance diagram for FIFE::TimeEvent:
+ Collaboration diagram for FIFE::TimeEvent:

Public Member Functions

 TimeEvent (int32_t period=-1)
 Default constructor. More...
 
virtual ~TimeEvent ()
 Destructor. More...
 
virtual void updateEvent (uint32_t time)=0
 Update function to be overridden by client. More...
 
void managerUpdateEvent (uint32_t time)
 Called by TimeManager to update the event. More...
 
void setPeriod (int32_t period)
 Set the period of the event. More...
 
int32_t getPeriod ()
 Get the period of the event. More...
 
uint32_t getLastUpdateTime ()
 Get the last time the event was updated. More...
 
void setLastUpdateTime (uint32_t ms)
 Set the last time the event was updated. More...
 

Private Attributes

int32_t m_period
 
uint32_t m_last_updated
 

Detailed Description

Interface for events to be registered with TimeManager.

To register a class with TimeManager firstly derive a class from this and override the updateEvent() function. updateEvent() will be called periodically depending on the value of getPeriod() which can be set using the constructor or setPeriod(). A value of -1 will never be updated, 0 will updated every frame and a value over 0 defines the number of milliseconds between updates.

See also
TimeManager

Definition at line 48 of file timeevent.h.

Constructor & Destructor Documentation

FIFE::TimeEvent::TimeEvent ( int32_t  period = -1)

Default constructor.

Parameters
periodThe period of the event. See class description.

Definition at line 37 of file timeevent.cpp.

FIFE::TimeEvent::~TimeEvent ( )
virtual

Destructor.

Definition at line 42 of file timeevent.cpp.

Member Function Documentation

uint32_t FIFE::TimeEvent::getLastUpdateTime ( )

Get the last time the event was updated.

Returns
Time of last update.

Definition at line 64 of file timeevent.cpp.

References m_last_updated.

int32_t FIFE::TimeEvent::getPeriod ( )

Get the period of the event.

Returns
The period of the event. See class description.

Definition at line 60 of file timeevent.cpp.

References m_period.

void FIFE::TimeEvent::managerUpdateEvent ( uint32_t  time)

Called by TimeManager to update the event.

Parameters
timeCurrent time. Used To check if its time to update.

Definition at line 46 of file timeevent.cpp.

References m_last_updated, m_period, and updateEvent().

void FIFE::TimeEvent::setLastUpdateTime ( uint32_t  ms)

Set the last time the event was updated.

Parameters
msTime of last update.

Definition at line 68 of file timeevent.cpp.

References m_last_updated.

Referenced by FIFE::Timer::start().

+ Here is the caller graph for this function:

void FIFE::TimeEvent::setPeriod ( int32_t  period)

Set the period of the event.

Parameters
periodThe period of the event. See class description.

Definition at line 56 of file timeevent.cpp.

References m_period.

Referenced by FIFE::Timer::setInterval().

+ Here is the caller graph for this function:

virtual void FIFE::TimeEvent::updateEvent ( uint32_t  time)
pure virtual

Update function to be overridden by client.

Parameters
timeTime delta.

Implemented in FIFE::Timer.

Referenced by managerUpdateEvent().

+ Here is the caller graph for this function:

Member Data Documentation

uint32_t FIFE::TimeEvent::m_last_updated
private

Definition at line 102 of file timeevent.h.

Referenced by getLastUpdateTime(), managerUpdateEvent(), and setLastUpdateTime().

int32_t FIFE::TimeEvent::m_period
private

Definition at line 99 of file timeevent.h.

Referenced by getPeriod(), managerUpdateEvent(), and setPeriod().


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