com.openinventor.inventor.sensors

Class SoTimerSensor

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.sensors.SoSensor

com.openinventor.inventor.sensors.SoTimerQueueSensor

com.openinventor.inventor.sensors.SoTimerSensor

Direct Known Subclasses:

SoFileSensor

public class SoTimerSensor
extends SoTimerQueueSensor

Sensor that triggers repeatedly at regular intervals. Timer sensors trigger their function at regular intervals. A base time may be specified, which causes the sensor to be triggered at multiples of the interval starting from the base time. The base time is an absolute time, as returned by SbTime.getTimeOfDay(). For example, a timer might be set up to call its function every second on the second by setting the base time to SbTime (0.0) and the interval to SbTime (1.0) . Timers are guaranteed to be triggered only once when the timer queue is processed, so if the application only processes the timer queue once every 5 seconds (because it is busy doing something else) the once-a-second sensor's function will only be called once every 5 seconds.

If no base time is set, then the function will be rescheduled from the present time using the interval value.

When a base time has been specified, SoTimers always schedule themselves to be triggered the next multiple of the interval time after the base time. For example, if the once-a-second sensor is triggered at time 2.9 (because the application way busy doing something at time 2.0 and didn't get around to processing the sensor queue for a while) it will reschedule itself to go off at time 3.0, not at time 3.9. On the other hand, if the base time had never been set, then the sensor would be scheduled for time 3.9.

See also:

SoOneShotSensor, SoAlarmSensor, SoTimerQueueSensor, SbTime

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
SoTimerSensor() Default constructor.
SoTimerSensor(java.lang.Runnable task) Build a new timer sensor with the task to be executed when the sensor is triggered.

Method Summary

Modifier and Type	Method and Description
SbTime	getBaseTime() Gets the base time.
SbTime	getInterval() Gets the interval.
long	getMsecInterval() Deprecated. As of Open Inventor 9.5, use getInterval() instead.
SbTime	getTriggerTime() Returns the time at which this sensor is scheduled to be triggered.
boolean	isScheduled() Returns true if this sensor has been scheduled and is waiting in a sensor queue to be triggered.
void	schedule()
void	setBaseTime(SbTime base) Sets the base time.
void	setDelay(long millisec) Deprecated. As of Open Inventor 9.5, use setBaseTime(com.openinventor.inventor.SbTime) instead.
void	setInterval(SbTime intvl) Sets the interval.
void	setMsecInterval(long millisec) Deprecated. As of Open Inventor 9.5, use setInterval(com.openinventor.inventor.SbTime) instead.
void	unschedule()

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

setTask

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

SoTimerSensor

public SoTimerSensor()

Default constructor.

SoTimerSensor

public SoTimerSensor(java.lang.Runnable task)

Build a new timer sensor with the task to be executed when the sensor is triggered.

Method Detail

setDelay

@Deprecated
public void setDelay(long millisec)

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

Overrides:

setDelay in class SoTimerQueueSensor

setMsecInterval

@Deprecated
public void setMsecInterval(long millisec)

Deprecated. As of Open Inventor 9.5, use setInterval(com.openinventor.inventor.SbTime) instead.

getMsecInterval

@Deprecated
public long getMsecInterval()

Deprecated. As of Open Inventor 9.5, use getInterval() instead.

schedule

public void schedule()

Overrides:

schedule in class SoSensor

unschedule

public void unschedule()

Overrides:

unschedule in class SoSensor

isScheduled

public boolean isScheduled()

Description copied from class: SoSensor

Returns true if this sensor has been scheduled and is waiting in a sensor queue to be triggered. Sensors are removed from the queue before their callback function is triggered.

Overrides:

isScheduled in class SoSensor

getTriggerTime

public SbTime getTriggerTime()

Description copied from class: SoTimerQueueSensor

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

Overrides:

getTriggerTime in class SoTimerQueueSensor

getBaseTime

public SbTime getBaseTime()

Gets the base time.

setInterval

public void setInterval(SbTime intvl)

Sets the interval. The default interval is 1/30th of a second.

setBaseTime

public void setBaseTime(SbTime base)

Sets the base time. The default base time is the time when the sensor is scheduled or rescheduled.

getInterval

public SbTime getInterval()

Gets the interval.