CrystalSpace

Public API Reference

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

csVirtualClock Class Reference

This is an implementation of a virtual clock. More...

#include <csutil/virtclk.h>

Inheritance diagram for csVirtualClock:

iVirtualClock iBase List of all members.

Public Member Functions

virtual void Advance ()
 Advance the engine's virtual-time clock.
virtual csTicks GetCurrentTicks () const
 Returns the absolute time of the last call to Advance().
virtual csTicks GetElapsedTicks () const
 Query the time elapsed between the two most recent invocations of Advance().
virtual void Resume ()
 Resume the engine's virtual-time clock.
virtual void Suspend ()
 Suspend the engine's virtual-time clock.

Public Attributes

 SCF_DECLARE_IBASE

Detailed Description

This is an implementation of a virtual clock.

Using this clock you can easily keep track of elapsed and current time in a virtual setting.

Definition at line 31 of file virtclk.h.


Member Function Documentation

virtual void csVirtualClock::Advance  )  [virtual]
 

Advance the engine's virtual-time clock.

Implements iVirtualClock.

virtual csTicks csVirtualClock::GetCurrentTicks  )  const [inline, virtual]
 

Returns the absolute time of the last call to Advance().

Implements iVirtualClock.

Definition at line 63 of file virtclk.h.

virtual csTicks csVirtualClock::GetElapsedTicks  )  const [inline, virtual]
 

Query the time elapsed between the two most recent invocations of Advance().

Implements iVirtualClock.

Definition at line 59 of file virtclk.h.

virtual void csVirtualClock::Resume  )  [inline, virtual]
 

Resume the engine's virtual-time clock.

Implements iVirtualClock.

Definition at line 54 of file virtclk.h.

virtual void csVirtualClock::Suspend  )  [inline, virtual]
 

Suspend the engine's virtual-time clock.

Implements iVirtualClock.

Definition at line 50 of file virtclk.h.


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