com.openinventor.inventor.sensors

Class SoTimerQueueSensor

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.sensors.SoSensor

com.openinventor.inventor.sensors.SoTimerQueueSensor

Direct Known Subclasses:

SoAlarmSensor, SoTimerSensor

public class SoTimerQueueSensor
extends SoSensor

Abstract base class for sensors dependent on time. Timer queue sensors are sensors that trigger themselves at specific times. The timer queue is normally processed as part of a program's main loop when the program is not busy doing something else. Note that processing the timer queue is not asynchronous - the program must re-enter its main loop for timers to be triggered. When the timer queue is processed, all timers scheduled to go off at or before the current time are triggered once, in order from earliest to latest.

See also:

SoTimerSensor, SoAlarmSensor, SoIdleSensor, SoOneShotSensor, SoDataSensor

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoTimerQueueSensor() Constructor.

Method Summary

Modifier and Type	Method and Description
SbTime	getTriggerTime() Returns the time at which this sensor is scheduled to be triggered.
void	setDelay(long millisec) Deprecated. As of Open Inventor 9.5, use SoTimerSensor.setBaseTime(com.openinventor.inventor.SbTime) or SoAlarmSensor.setTimeFromNow(com.openinventor.inventor.SbTime) instead.

Methods inherited from class com.openinventor.inventor.sensors.SoSensor

isScheduled, schedule, setTask, unschedule

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SoTimerQueueSensor

public SoTimerQueueSensor()

Constructor.

Method Detail

setDelay

@Deprecated
public void setDelay(long millisec)

Deprecated. As of Open Inventor 9.5, use SoTimerSensor.setBaseTime(com.openinventor.inventor.SbTime) or SoAlarmSensor.setTimeFromNow(com.openinventor.inventor.SbTime) instead.

getTriggerTime

public SbTime getTriggerTime()

Returns the time at which this sensor is scheduled to be triggered. If the sensor is not scheduled the results are undefined.