SoAlarmSensor(3IV)

NAME
     SoAlarmSensor (SoAlarmSens) - triggers a callback once sometime in the
     future

INHERITS FROM
     SoSensor > SoTimerQueueSensor > SoAlarmSensor

SYNOPSIS
     #include <Inventor_c/sensors/SoAlarmSensor.h>

     typedef SoAlarmSensor  SoAlarmSens

          Functions from class SoAlarmSensor:

     SoAlarmSensor *     SoAlarmSensCreate()
     SoAlarmSensor *     SoAlarmSensCreateCB(SoSensorCB *func, void *data)
     void                SoAlarmSensDelete(SoAlarmSens *this)
     void                SoAlarmSensSetTime(SoAlarmSens *this, const SbTime
                              *absTime)
     void                SoAlarmSensSetTimeFromNow(SoAlarmSens *this, const
                              SbTime *relTime)
     const SbTime *      SoAlarmSensGetTime(const SoAlarmSens *this)

          Functions from class SoTimerQueueSensor:

     const SbTime *      SoAlarmSensGetTrigTime(SoAlarmSens *this)
     void                SoAlarmSensSched(SoAlarmSens *this)
     void                SoAlarmSensUnsched(SoAlarmSens *this)
     SbBool              SoAlarmSensIsSched(SoAlarmSens *this)

          Functions from class SoSensor:

     void                SoAlarmSensSetFunc(SoAlarmSens *this, SoSensorCB
                              *callbackFunction)
     SoSensorCB *        SoAlarmSensGetFunc(const SoAlarmSens *this)
     void                SoAlarmSensSetData(SoAlarmSens *this, void
                              *callbackData)
     void *              SoAlarmSensGetData(const SoAlarmSens *this)


DESCRIPTION
     This type of sensor can be used to schedule a one-time callback for some
     time in the future. The sensor is not guaranteed to be called at exactly
     that time, but will be called sometime after the specified time.

FUNCTIONS
     SoAlarmSensor *     SoAlarmSensCreate()
     SoAlarmSensor *     SoAlarmSensCreateCB(SoSensorCB *func, void *data)
          Creation methods. The second method takes the callback function and
          data to be called when the sensor is triggered.
     void                SoAlarmSensDelete(SoAlarmSens *this)
          Destroys the sensor, freeing up any memory associated with it after
          unscheduling it.

     void                SoAlarmSensSetTime(SoAlarmSens *this, const SbTime
                              *absTime)
          Sets the sensor to go off at the specified time. You must also call
          SoAlarmSensSched() for the sensor to be triggered. If the sensor is
          already scheduled, it must be unscheduled and then rescheduled for
          the change in the trigger time to take effect.

     void                SoAlarmSensSetTimeFromNow(SoAlarmSens *this, const
                              SbTime *relTime)
          Sets the sensor to go off the given amount of time from now. You
          must also call SoAlarmSensSched() for the sensor to be triggered. If
          the sensor is already scheduled, it must be unscheduled and then
          rescheduled for the change in the trigger time to take effect.

     const SbTime *      SoAlarmSensGetTime(const SoAlarmSens *this)
          Returns the time at which the sensor is set to be triggered. This is
          similar to the SoAlarmSensGetTrigTime method, but returns the time
          even if the sensor has not yet been scheduled.


SEE ALSO
     SoOneShotSensor, SoTimerSensor, SoTimerQueueSensor, SbTime