CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

csEventTimer Class Reference

This class implements a timer. More...

#include <timer.h>

Inheritance diagram for csEventTimer:

iEventTimer iBase List of all members.

Public Methods

virtual void AddTimerEvent (iTimerEvent *ev, csTicks delay)
 Add a timer event to be scheduled later. More...

virtual void RemoveTimerEvent (iTimerEvent *ev)
 Remove a timer event. More...

virtual void RemoveAllTimerEvents ()
 Clear all timer events. More...


Static Public Methods

csPtr< iEventTimerGetStandardTimer (iObjectRegistry *object_reg)
 This is a static method to easily get the standard global timer (name 'crystalspace.timer.standard' in the object registry). More...


Detailed Description

This class implements a timer.

You can add operations to it and they will be performed at the dedicated time.

Definition at line 37 of file csutil/timer.h.


Member Function Documentation

virtual void csEventTimer::AddTimerEvent iTimerEvent   ev,
csTicks    delay
[virtual]
 

Add a timer event to be scheduled later.

Implements iEventTimer.

csPtr<iEventTimer> csEventTimer::GetStandardTimer iObjectRegistry   object_reg [static]
 

This is a static method to easily get the standard global timer (name 'crystalspace.timer.standard' in the object registry).

If that timer doesn't exist yet it will be created.

virtual void csEventTimer::RemoveAllTimerEvents   [virtual]
 

Clear all timer events.

Implements iEventTimer.

virtual void csEventTimer::RemoveTimerEvent iTimerEvent   ev [virtual]
 

Remove a timer event.

Implements iEventTimer.


The documentation for this class was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14