version 3.3

VRS::FPSClock Class Reference

Frame-per-Second Clock. More...

#include <vrs/sg/fpsclock.h>

Inheritance diagram for VRS::FPSClock:

VRS::Clock VRS::SharedObj VRS::Visitable

List of all members.

Public Member Functions

 FPSClock (const VRSTime &start=VRSTime::zero(), const VRSTime &end=VRSTime::maxTime(), const VRSTime &delta=1.0)
const VRSTimegetStart () const
const VRSTimegetEnd () const
const VRSTimegetCurrent () const
const VRSTimegetDelta () const
bool isBeyondEnd () const
void setStart (const VRSTime &start)
void setEnd (const VRSTime &end)
void setCurrent (const VRSTime &current)
void setRange (const VRSTime &start, const VRSTime &end)
void setDelta (const VRSTime &delta)
void setRangeDelta (const VRSTime &start, const VRSTime &end, const VRSTime &delta)
void advance ()
virtual VRSTime time ()
 Returns the current (model) time.
 VRS_TYPEINFO (FPSClock, Clock)


Detailed Description

Frame-per-Second Clock.

Constructor & Destructor Documentation

VRS::FPSClock::FPSClock ( const VRSTime start = VRSTime::zero(),
const VRSTime end = VRSTime::maxTime(),
const VRSTime delta = 1.0 
)

A frame-per-second clock sends time events within an explicitly given time interval. The progress of time is handled manually by 'advance()'. It is not a real-time clock.


Member Function Documentation

const VRSTime & VRS::FPSClock::getStart (  )  const [inline]

const VRSTime & VRS::FPSClock::getEnd (  )  const [inline]

const VRSTime & VRS::FPSClock::getCurrent (  )  const [inline]

const VRSTime & VRS::FPSClock::getDelta (  )  const [inline]

bool VRS::FPSClock::isBeyondEnd (  )  const [inline]

void VRS::FPSClock::setStart ( const VRSTime start  ) 

void VRS::FPSClock::setEnd ( const VRSTime end  ) 

void VRS::FPSClock::setCurrent ( const VRSTime current  ) 

void VRS::FPSClock::setRange ( const VRSTime start,
const VRSTime end 
)

void VRS::FPSClock::setDelta ( const VRSTime delta  ) 

void VRS::FPSClock::setRangeDelta ( const VRSTime start,
const VRSTime end,
const VRSTime delta 
)

void VRS::FPSClock::advance (  ) 

Time progress by one step. The step size is defined by the delta value. Advance calls 'tick', i.e., all associated time managers get informed about the new, current time.

virtual VRSTime VRS::FPSClock::time (  )  [virtual]

Returns the current (model) time.

Reimplemented from VRS::Clock.

VRS::FPSClock::VRS_TYPEINFO ( FPSClock  ,
Clock   
)


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

Generated on Tue May 21 06:00:31 2013 by Doxygen 1.5.6
© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact