Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

ZE::ZTimer Class Reference

#include <ZE_ZTimer.h>

Inherits ZE::ZObject.

List of all members.


Detailed Description

ZTimer timing class, class wraps common features of SDL timer. Inherited from ZObject and tied to ZEngine main timer.


Public Methods

 ZTimer (bool useZEngine=true)
 Constructs a new Timer.

void Reset ()
 Reset Timer.

void Pause ()
 Pause Timer.

void Unpause ()
 Unpause Timer.

Uint32 GetTime ()
 Get Time of Timer.

bool IsPaused ()
 Get paused state.


Protected Methods

Uint32 GetParentTime ()
 Get time from parent timer.


Protected Attributes

bool rPaused
 Paused / Unpaused state of Timer.

bool rUseZEngine
 Using ZEngine timer or SDL global timer.

Uint32 rPausedTime
 Total time this timer has been paused.

Uint32 rLastPause
 Time this Timer was paused.


Constructor & Destructor Documentation

ZE::ZTimer::ZTimer bool    useZEngine = true
 

Sets TimePaused to current ZEngine time if useZEngine is true, otherwise uses SDL timer.

Parameters:
useZEngine Tells if timer should use ZEngine or SDL.


Member Function Documentation

Uint32 ZE::ZTimer::GetParentTime   [protected]
 

Protected method to get time from whichever timer is parent.

Returns:
Time on parent timer.

void ZE::ZTimer::Reset  
 

Set Timer back to Zero, will also unpause timer if it was paused.

void ZE::ZTimer::Pause  
 

Pause the timer if it is unpaused.

void ZE::ZTimer::Unpause  
 

Unpause the timer if it is paused.

Uint32 ZE::ZTimer::GetTime  
 

Get current time accounting for time paused.

Returns:
Current Timer Time.

bool ZE::ZTimer::IsPaused  
 

Find out paused state of timer.

Returns:
Paused state for timer.


The documentation for this class was generated from the following files:
Generated on Wed Nov 20 01:18:06 2002 for ZEngine by doxygen1.3-rc1