SoSystemTimer Class Reference
[Components]

VSG extension Common interface to expose system dependent timers More...

#include <Inventor/sensors/SoSystemTimer.h>

Inheritance diagram for SoSystemTimer:
SoRefCounter QtTimer WinTimer WinTimer

List of all members.

Public Member Functions

virtual void start ()=0
virtual void stop ()=0
virtual void setDelay (int time)=0
virtual bool isPending () const =0
virtual void setRepeat (bool flag)=0
virtual void setTask (SoSystemTimerTask *task)=0

Detailed Description

VSG extension Common interface to expose system dependent timers

The timer implementation usually depends on the window toolkit used (Qt, Wx, Awt, Swt...). The purpose of this class is to expose a common interface for system dependent timers. When the timer is triggered, it must call the run() method of its SoSystemTimerTask (given by the setTask method).

SEE ALSO

SoSensorHandler


Member Function Documentation

virtual bool SoSystemTimer::isPending (  )  const [pure virtual]

Return true if the timer is running.

Implemented in WinTimer, QtTimer, and WinTimer.

virtual void SoSystemTimer::setDelay ( int  time  )  [pure virtual]

Set the timer's timeout in milliseconds.

Implemented in WinTimer, QtTimer, and WinTimer.

virtual void SoSystemTimer::setRepeat ( bool  flag  )  [pure virtual]

If set to true, the timer will be triggered periodically at the rate defined by setDelay.

Implemented in WinTimer, QtTimer, and WinTimer.

virtual void SoSystemTimer::setTask ( SoSystemTimerTask task  )  [pure virtual]

Sets the task executed when the timer is triggered.

When the timer is is triggered, it calls the run() method of task.

Implemented in WinTimer, QtTimer, and WinTimer.

virtual void SoSystemTimer::start (  )  [pure virtual]

Start the timer.

If it is already started, stop it and restart

Implemented in WinTimer, QtTimer, and WinTimer.

virtual void SoSystemTimer::stop (  )  [pure virtual]

Stop the timer.

Implemented in WinTimer, QtTimer, and WinTimer.


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

Open Inventor by FEI reference manual, generated on 21 Sep 2015
Copyright © FEI S.A.S. All rights reserved.
http://www.vsg3d.com