gedi::AlarmClock

gedi::AlarmClock Class Reference

#include <AlarmClock.h>

Collaboration diagram for gedi::AlarmClock:

[legend]
List of all members.

Public Member Functions

 AlarmClock (void)
void Register (gedi::AlarmListener *kListener, void *pHandback)
void Register (gedi::AlarmUntilListener *kListener, void *pHandback)
void Update (void)
gedi::RealTime GetElapsed (void)
gedi::RealTime GetDelta (void)
gedi::RealTime GetStep (void)

Detailed Description

This class provides a structured, callback pattern for managing game clocks. Clients register listeners with the alarm clock and the listeners are invoked when the alarm goes off. Listeners can be disable or deregistered. Although the AlarmClock takes pointers to listeners, AlarmClock does not manage memory. Clients must manage listener memory resources.

Constructor & Destructor Documentation

gedi::AlarmClock::AlarmClock ( void   )  [inline]

Default constructor.

Member Function Documentation

void gedi::AlarmClock::Register ( gedi::AlarmListener *  kListener,
void *  pHandback 
)

Registers a listener.

Parameters:
kListener A listener.
pHandback Pointer to handback object.

void gedi::AlarmClock::Register ( gedi::AlarmUntilListener *  kListener,
void *  pHandback 
)

Registers a listener.

Parameters:
kListener A listener.
pHandback Pointer to handback object.

void gedi::AlarmClock::Update ( void   ) 

Update the clock, possibly dispatching event calls.

gedi::RealTime gedi::AlarmClock::GetElapsed ( void   )  [inline]

Gets the elapsed time since clock initialized.

Returns:
Elapsed time.

gedi::RealTime gedi::AlarmClock::GetDelta ( void   )  [inline]

Gets the delta time, a.k.a., "step".

Returns:
Delta time.

gedi::RealTime gedi::AlarmClock::GetStep ( void   )  [inline]

Gets the time step, a.k.a., delta.

Returns:
Time step.

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