Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
SoTimerQueueSensor Class Reference

The SoTimerQueueSensor class is the abstract base class for sensors triggering on certain timer events. More...

#include <Inventor/sensors/SoTimerQueueSensor.h>

Inheritance diagram for SoTimerQueueSensor:
SoSensor SoAlarmSensor SoTimerSensor

Public Member Functions

 SoTimerQueueSensor (void)
 SoTimerQueueSensor (SoSensorCB *func, void *data)
virtual ~SoTimerQueueSensor (void)
const SbTimegetTriggerTime (void) const
virtual void schedule (void)
virtual void unschedule (void)
virtual SbBool isScheduled (void) const
virtual void trigger (void)
- Public Member Functions inherited from SoSensor
 SoSensor (void)
 SoSensor (SoSensorCB *func, void *data)
virtual ~SoSensor (void)
void setFunction (SoSensorCB *callbackfunction)
SoSensorCBPtr getFunction (void) const
void setData (void *callbackdata)
void * getData (void) const
void setNextInQueue (SoSensor *next)
SoSensorgetNextInQueue (void) const

Protected Member Functions

void setTriggerTime (const SbTime &time)

Protected Attributes

SbBool scheduled
- Protected Attributes inherited from SoSensor
void * funcData

Additional Inherited Members

- Static Public Member Functions inherited from SoSensor
static void initClass (void)

Detailed Description

The SoTimerQueueSensor class is the abstract base class for sensors triggering on certain timer events.

Timer sensors triggers upon specific points in time.

This class is an abstract superclass which collects the common interface of the various non-abstract timer sensor classes. See the documentation of the subclasses for information on what ways there are to specify base times, intervals, alarm-style single triggering, repeated triggers, etc.

Note that Coin timer sensors should in no way be considered "hard real-time". That is, you can not expect a timer to always trigger at the exact moment it was set up for. Delays in triggering could be due to other activities in Coin, a task suspended, or heavy load from other applications on the system. These situations could all cause the processing of sensor queues (from SoQt / SoWin / SoXt / whatever) to be slightly delayed, thereby causing delays in timer sensor triggering.

On modern systems, a timer will usually trigger within a few milliseconds of it's designated time, though.

If a timer sensor can not trigger at the exact moment it has been scheduled, it will be triggered at the first opportunity after the scheduled time has passed.

Here's a simple usage example. It's a stand-alone example, which only demonstrates how to set up a repeating timer sensor with a callback:

#include <Inventor/Xt/SoXt.h>
#include <Inventor/sensors/SoTimerSensor.h>
#include <cstdio>
static void
timeSensorCallback(void * data, SoSensor * sensor)
SbString string = time.format("%S.%i");
(void)printf("%s\n", string.getString());
main(int argc, char ** argv)
SoTimerSensor * timeSensor = new SoTimerSensor;
return 0;

Constructor & Destructor Documentation

◆ SoTimerQueueSensor() [1/2]

SoTimerQueueSensor::SoTimerQueueSensor ( void  )

Default constructor.

◆ SoTimerQueueSensor() [2/2]

SoTimerQueueSensor::SoTimerQueueSensor ( SoSensorCB func,
void *  data 

Constructor taking as arguments the sensor callback function and the userdata which will be passed the callback.

See also
setFunction(), setData()

◆ ~SoTimerQueueSensor()

SoTimerQueueSensor::~SoTimerQueueSensor ( void  )


Member Function Documentation

◆ getTriggerTime()

const SbTime & SoTimerQueueSensor::getTriggerTime ( void  ) const

Returns the time at which the sensor will trigger.

See also

◆ schedule()

void SoTimerQueueSensor::schedule ( void  )

Put the sensor in the global timer queue.

See also
unschedule(), isScheduled()

Implements SoSensor.

Reimplemented in SoTimerSensor, and SoAlarmSensor.

◆ unschedule()

void SoTimerQueueSensor::unschedule ( void  )

Remove sensor from the timer queue, without triggering it first.

See also
schedule(), isScheduled()

Implements SoSensor.

Reimplemented in SoTimerSensor.

◆ isScheduled()

SbBool SoTimerQueueSensor::isScheduled ( void  ) const

Check if this sensor is scheduled for triggering.

See also
schedule(), unschedule()

Implements SoSensor.

◆ trigger()

void SoTimerQueueSensor::trigger ( void  )

Trigger the sensor's callback function.

Reimplemented from SoSensor.

◆ setTriggerTime()

void SoTimerQueueSensor::setTriggerTime ( const SbTime time)

Set absolute time at which to trigger sensor.

See also

Member Data Documentation

◆ scheduled

SbBool SoTimerQueueSensor::scheduled

TRUE if the sensor is currently scheduled.

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