Coin Logo http://www.sim.no
http://www.coin3d.org

Public Member Functions

SoAlarmSensor Class Reference

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>

Inheritance diagram for SoAlarmSensor:
SoTimerQueueSensor SoSensor

List of all members.

Public Member Functions

 SoAlarmSensor (void)
 SoAlarmSensor (SoSensorCB *func, void *data)
virtual ~SoAlarmSensor (void)
void setTime (const SbTime &abstime)
void setTimeFromNow (const SbTime &reltime)
const SbTimegetTime (void) const
virtual void schedule (void)

Detailed Description

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.


Constructor & Destructor Documentation

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.

See also:
setFunction(), setData()
SoAlarmSensor::~SoAlarmSensor ( void  ) [virtual]

Destructor.


Member Function Documentation

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.

See also:
setTimeFromNow(), getTime()
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.

See also:
setTime(), getTime()

References SbTime::setToTimeOfDay().

const SbTime & SoAlarmSensor::getTime ( void  ) const

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

See also:
setTime(), setTimeFromNow()
void SoAlarmSensor::schedule ( void  ) [virtual]

Put the sensor in the global timer queue.

See also:
unschedule(), isScheduled()

Reimplemented from SoTimerQueueSensor.

References SoSensor::schedule(), and SoTimerQueueSensor::setTriggerTime().


The documentation for this class was generated from the following files:

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 28 2011 10:12:02 for Coin by Doxygen. 1.7.3