|
http://www.sim.no/ http://www.coin3d.org/ |
The SoAlarmSensor class is a sensor which will trigger once at a specified time.SoAlarmSensor provides a convenient way of setting up triggers for jobs which should be executed only once when they are scheduled. More...
#include <Inventor/sensors/SoAlarmSensor.h>
Public Member Functions | |
| SoAlarmSensor (void) | |
| SoAlarmSensor (SoSensorCB *func, void *data) | |
| virtual | ~SoAlarmSensor (void) |
| void | setTime (const SbTime &abstime) |
| void | setTimeFromNow (const SbTime &reltime) |
| const SbTime & | getTime (void) const |
| virtual void | schedule (void) |
Public Member Functions inherited from SoTimerQueueSensor | |
| SoTimerQueueSensor (void) | |
| SoTimerQueueSensor (SoSensorCB *func, void *data) | |
| virtual | ~SoTimerQueueSensor (void) |
| const SbTime & | getTriggerTime (void) const |
| 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) |
| SoSensor * | getNextInQueue (void) const |
Additional Inherited Members | |
Static Public Member Functions inherited from SoSensor | |
| static void | initClass (void) |
Protected Member Functions inherited from SoTimerQueueSensor | |
| void | setTriggerTime (const SbTime &time) |
Protected Attributes inherited from SoTimerQueueSensor | |
| SbBool | scheduled |
Protected Attributes inherited from SoSensor | |
| SoSensorCB * | func |
| void * | funcData |
The SoAlarmSensor class is a sensor which will trigger once at a specified time.
SoAlarmSensor provides a convenient way of setting up triggers for jobs which should be executed only once when they are scheduled.
| SoAlarmSensor::SoAlarmSensor | ( | void | ) |
Default constructor.
| SoAlarmSensor::SoAlarmSensor | ( | SoSensorCB * | func, |
| void * | data | ||
| ) |
Constructor taking as parameters the sensor callback function and the userdata which will be passed the callback.
|
virtual |
Destructor.
| void SoAlarmSensor::setTime | ( | const SbTime & | abstime | ) |
Set the time at which the sensor will trigger.
Note that you must manually schedule() the sensor after calling this method.
| void SoAlarmSensor::setTimeFromNow | ( | const SbTime & | reltime | ) |
Set the alarm to be at a specified offset from the current time.
Note that you must manually schedule() the sensor after calling this method.
| const SbTime & SoAlarmSensor::getTime | ( | void | ) | const |
Returns the trigger time for the alarm as an absolute value from 1970-01-01 00:00:00.
|
virtual |
Put the sensor in the global timer queue.
Reimplemented from SoTimerQueueSensor.
Copyright © 1998-2010 by Kongsberg Oil & Gas Technologies. All rights reserved.
Generated on Sat Dec 12 2015 22:20:05 for Coin by Doxygen 1.8.10.