FIFE::TimeManager Class Reference

#include <timemanager.h>

Inheritance diagram for FIFE::TimeManager:
Inheritance graph
[legend]
Collaboration diagram for FIFE::TimeManager:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 TimeManager ()
virtual ~TimeManager ()
void update ()
void registerEvent (TimeEvent *event)
void unregisterEvent (TimeEvent *event)
unsigned long getTime () const
unsigned long getTimeDelta () const
double getAverageFrameTime () const
void printStatistics () const

Detailed Description

Time Manager

This class is in charge of storing the current time, average frame time, as well as controlling periodic events. Users of this class will have to manually register and unregister events.

See also:
TimeEvent

Definition at line 49 of file timemanager.h.


Constructor & Destructor Documentation

FIFE::TimeManager::TimeManager (  ) 

Default constructor.

Definition at line 41 of file timemanager.cpp.

FIFE::TimeManager::~TimeManager (  )  [virtual]

Destructor.

Definition at line 47 of file timemanager.cpp.


Member Function Documentation

double FIFE::TimeManager::getAverageFrameTime (  )  const

Gets average frame time

Returns:
Average frame time in milliseconds.

Definition at line 107 of file timemanager.cpp.

unsigned long FIFE::TimeManager::getTime (  )  const

Get the time.

Returns:
The time in milliseconds.

Definition at line 99 of file timemanager.cpp.

unsigned long FIFE::TimeManager::getTimeDelta (  )  const

Get the time since the last frame.

Returns:
Time since last frame in milliseconds.

Definition at line 103 of file timemanager.cpp.

void FIFE::TimeManager::printStatistics (  )  const

Prints Timer statistics

Definition at line 111 of file timemanager.cpp.

void FIFE::TimeManager::registerEvent ( TimeEvent event  ) 

Adds a TimeEvent.

The event will be updated regularly, depending on its settings.

Parameters:
event The TimeEvent object to be added.

Definition at line 83 of file timemanager.cpp.

void FIFE::TimeManager::unregisterEvent ( TimeEvent event  ) 

Removes a TimeEvent.

Removes an event from the list. It will not be deleted.

Parameters:
event The TimeEvent object to be removed.

Definition at line 88 of file timemanager.cpp.

void FIFE::TimeManager::update (  ) 

Called once a frame and updates the timer objects and events.

Definition at line 50 of file timemanager.cpp.


The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.2-20100208