ITrackerTimer Class Reference

#include <ITrackerTimer.h>

Inheritance diagram for ITrackerTimer:

Public Member Functions
virtual void	StartTimer (ITracker *callBack, uint32 milliSeconds, uint32 mouseMoveDelay=kDefaultMouseMoveDelay, uint32 mouseSteadyDelay=kDefaultMouseSteadyDelay)=0
virtual void	StopTimer ()=0
Public Member Functions inherited from IIdleTask
virtual uint32	RunTask (uint32 appFlags, IdleTimer *timeCheck)=0
virtual void	InstallTask (uint32 millisecsBeforeFirstRun)=0
virtual void	UninstallTask ()=0
virtual const char *	TaskName ()=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Additional Inherited Members
Public Types inherited from IIdleTask
enum	{ kDefaultIID = IID_IIDLETASK }
enum	{ kEndOfTime = ~(uint32)0, kOnFlagChange = ~(uint32)1, kNextEventCycle = ~(uint32)2 }
enum	{ kMaxTaskNameLength = 1023 }

Detailed Description

Defines an interface used to start a timer during tracking. Typically a timer is started in BeginTracking and stopped in EndTracking.

See Also

ITracker.h

IIdleTask.h

Member Function Documentation

virtual void ITrackerTimer::StartTimer ( ITracker *  callBack, uint32  milliSeconds, uint32  mouseMoveDelay = kDefaultMouseMoveDelay, uint32  mouseSteadyDelay = kDefaultMouseSteadyDelay  )

pure virtual

Start a timer that will be run periodically during tracking after a certain amount of time elapses. Used internally by some tracker to start up patient user mode.

Parameters

callBack	[IN] ITracker* object to initiate timer with (you can use to store the object for use by by timer. e.g. callback to ITracker->TimerMessage).
milliSeconds	[IN] how frequently in milliseconds before first RunTask is called.
mouseMoveDelay	[IN] how frequently in milliseconds RunTask is called while mouse is moving.
mouseSteadyDelay	[IN] how frequently in milliseconds RunTask is called while mouse is not moving.

See Also

IIdleTask.h

kPatientUserBoss

virtual void ITrackerTimer::StopTimer ( )

pure virtual

Stop the timer