OgreHaptics::Timer Class Reference

Abstract class defining the interface of a Timer to be implemented by rendering systems. More...

#include <OgreHapticsTimer.h>

List of all members.

Public Member Functions

 Timer ()
 Standard constructor.
virtual ~Timer ()
 Virtual destructor.
virtual double getSeconds (void)=0
 Returns the number of seconds since the start of timings.
virtual double getMilliseconds (void)=0
 Returns the number of milliseconds since the start of timings.
virtual double getMicroseconds (void)=0
 Returns the number of microseconds since the start of timings.


Detailed Description

Abstract class defining the interface of a Timer to be implemented by rendering systems.

Remarks:
The Ogre::Timer needs to be bound to a specific single core on multi processor machines to calculate correct high performance timings. Using this timer would cause both the graphic and haptic rendering to be virtually performed on a single core, leaving other cores almost idle.
Some haptic API's provide their own timers. This class provides a unified interface to wrap these timers. This is useful in the abstract Device class, allowing to request the timer of its creator (e.g. RenderSystem) and as such using consistent timings in its calculations.
For client application it is advised not to use these timers, unless it is used in calculations needed for haptic rendering.

Definition at line 50 of file OgreHapticsTimer.h.


Constructor & Destructor Documentation

OgreHaptics::Timer::Timer (  ) 

Standard constructor.

Definition at line 54 of file OgreHapticsTimer.h.

virtual OgreHaptics::Timer::~Timer (  )  [virtual]

Virtual destructor.

Definition at line 56 of file OgreHapticsTimer.h.


Member Function Documentation

virtual double OgreHaptics::Timer::getSeconds ( void   )  [pure virtual]

Returns the number of seconds since the start of timings.

Remarks:
The actual number of seconds is API specific.

virtual double OgreHaptics::Timer::getMilliseconds ( void   )  [pure virtual]

Returns the number of milliseconds since the start of timings.

Remarks:
The actual number of milliseconds is API specific.

virtual double OgreHaptics::Timer::getMicroseconds ( void   )  [pure virtual]

Returns the number of microseconds since the start of timings.

Remarks:
The actual number of microseconds is API specific.


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

Last modified Tue Jan 6 22:31:27 2009