SoAlarmSensor.3coin4 - Man Page

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

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

Default constructor.

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

See also

setFunction(), setData()

Destructor.

Set the time at which the sensor will trigger.

Note that you must manually schedule() the sensor after calling this method.

See also

setTimeFromNow(), getTime()

Set the alarm to be triggered at a specified offset from the current time.

Note that you must manually schedule() the sensor after calling this method.

See also

setTime(), getTime()

Returns the trigger time for the alarm as an absolute value from 1970-01-01 00:00:00.

See also

setTime(), setTimeFromNow()

Put the sensor in the global timer queue.

See also

unschedule(), isScheduled()

Reimplemented from SoTimerQueueSensor.