 |
VR-Forces Developer's Guide
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
|
VR-Forces Developer's Guide
|
File: recTimer.h.
Class: DtRecurringTimer
Description: A recurring timer resets itself after firing to fire 'recurTime' seconds after the time at which it fired.
Public Member Functions | |
| DtRecurringTimer (const DtClock *clock, const unsigned int type, const DtTime recurTime, const DtTimerCallbackFcn callback, void *usr) | |
| virtual | ~DtRecurringTimer () |
| virtual void | fire () |
 Public Member Functions inherited from DtTimer | |
| DtTimer (const unsigned int type, const DtTime fireTime, const DtTimerCallbackFcn callback, void *usr) | |
| DtTimer (const DtTimer &orig) | |
| DtTimer & | operator= (const DtTimer &orig) |
| virtual | ~DtTimer () |
| virtual bool | tick (const DtTime simTime) |
| virtual void | reset (const DtTime fireTime) |
| virtual void | cancel () |
| virtual bool | fired () const |
| virtual DtTime | fireTime () const |
| virtual unsigned int | timerType () const |
| virtual void * | usrData () |
| virtual bool | cancelled () const |
| virtual void | setResortPending () |
| virtual void | clearResortPending () |
| virtual bool | resortPending () const |
| virtual void | setDeleteAfterFire () |
| virtual void | clearDeleteAfterFire () |
| virtual bool | deleteAfterFire () const |
| virtual bool | managed () const |
| virtual void | setScheduler (DtScheduler *scheduler) |
| virtual bool | periodIsRealTime () const |
Protected Member Functions | |
| DtRecurringTimer & | operator= (const DtRecurringTimer &orig) |
Protected Attributes | |
| const DtTime | myRecurTime |
| const DtClock * | myClock |
| Protected Attributes inherited from DtTimer | |
| DtScheduler * | myScheduler |
| const DtTimerCallbackFcn | myCallback |
| const unsigned int | myType |
| void * | myUsrData |
| bool | myFired |
| bool | myDeleteAfterFire |
| bool | myCancelled |
| DtTime | myFireTime |
| bool | myResortPending |
| DtRecurringTimer::DtRecurringTimer | ( | const DtClock * | clock, |
| const unsigned int | type, | ||
| const DtTime | recurTime, | ||
| const DtTimerCallbackFcn | callback, | ||
| void * | usr | ||
| ) |
The usr pointer points to some user-specified data that will be passed in to the given callback when the timer fires. The usr pointer is owned by the caller (who is therefore responsible for destroying it) and it should not be modified by this class in any way.
|
virtual |
|
protected |
not defined
|
virtual |
Sets off (fires) the timer. Sets the fired state to true. If a callback exists, invokes the callback. If myScheduler has been set, calls scheduler's reSort() member passing in this object as the argument.
Reimplemented from DtTimer.
|
protected |
|
protected |