CrystalSpace

Public API Reference

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

csEventTimer Class Reference

This class implements a timer. More...

#include <csutil/timer.h>

Inheritance diagram for csEventTimer:

iEventTimer iBase List of all members.

Public Member Functions

virtual void AddTimerEvent (iTimerEvent *ev, csTicks delay)
 Add a timer event to be scheduled later.
virtual void RemoveTimerEvent (iTimerEvent *ev)
 Remove a timer event.
virtual void RemoveAllTimerEvents ()
 Clear all timer events.

Static Public Member Functions

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).

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 38 of file 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.3.9.1