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

SoTimerSensor Class Reference
[Sensor classes]

The SoTimerSensor class is a sensor which will trigger at given intervals.

Use sensors of this class when you want a job repeated at a certain interval, without explicitly needing to reschedule the sensor (i.e. SoTimerSensor automatically re-schedules itself after it has been triggered). More...

#include <Inventor/sensors/SoTimerSensor.h>

Inheritance diagram for SoTimerSensor:

SoTimerQueueSensor SoSensor

List of all members.

Public Member Functions

 SoTimerSensor (void)
 SoTimerSensor (SoSensorCB *func, void *data)
virtual ~SoTimerSensor (void)
void setBaseTime (const SbTime &base)
const SbTimegetBaseTime (void) const
void setInterval (const SbTime &interval)
const SbTimegetInterval (void) const
virtual void schedule (void)
virtual void unschedule (void)
void reschedule (const SbTime &schedtime)


Detailed Description

The SoTimerSensor class is a sensor which will trigger at given intervals.

Use sensors of this class when you want a job repeated at a certain interval, without explicitly needing to reschedule the sensor (i.e. SoTimerSensor automatically re-schedules itself after it has been triggered).

SoTimerSensor instances is commonly used to trigger animation updates at a constant framerate.


Constructor & Destructor Documentation

SoTimerSensor::SoTimerSensor ( void   ) 

Default constructor. Sets up an interval of 1/30th of a second.

References SbTime::setValue().

SoTimerSensor::SoTimerSensor ( 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()

References SbTime::setValue().

SoTimerSensor::~SoTimerSensor ( void   )  [virtual]

Destructor.

References SoTimerQueueSensor::isScheduled(), and unschedule().


Member Function Documentation

void SoTimerSensor::setBaseTime ( const SbTime baseref  ) 

Set the base trigger time.

If you use this method, the trigger times will be on intervals from the given value.

Without an explicitly set base time, the next trigger invocation after a trigger has happened will be on the current time plus the interval time. Note that this will of course cause the timer to drift.

See also:
getBaseTime()

const SbTime & SoTimerSensor::getBaseTime ( void   )  const

Returns the base trigger time.

See also:
setBaseTime()

void SoTimerSensor::setInterval ( const SbTime intervalref  ) 

Sets the time interval between each time the sensor triggers.

See also:
getInterval()

Referenced by SoDB::init(), and SoDB::setRealTimeInterval().

const SbTime & SoTimerSensor::getInterval ( void   )  const

Returns the timer trigger interval.

See also:
setInterval()

Referenced by SoDB::getRealTimeInterval().

void SoTimerSensor::schedule ( void   )  [virtual]

Overrides the virtual schedule() method to be able to set up the base time, if this was not done by the user.

If no base time was set, base time will then equal the current time.

See also:
unschedule(), isScheduled()

Reimplemented from SoTimerQueueSensor.

References SoDB::getSensorManager(), SbTime::getTimeOfDay(), SoTimerQueueSensor::isScheduled(), SoDebugError::postInfo(), SoDebugError::postWarning(), reschedule(), SoSensorManager::rescheduleTimer(), and SoTimerQueueSensor::scheduled.

Referenced by SoDB::enableRealTimeSensor(), SoDB::init(), and SoDB::setRealTimeInterval().

void SoTimerSensor::unschedule ( void   )  [virtual]

void SoTimerSensor::reschedule ( const SbTime schedtime  ) 

Set new trigger time based on the given schedule time, and schedules the sensor for triggering.

References SoTimerQueueSensor::getTriggerTime(), SbTime::getValue(), SoDebugError::postInfo(), SoTimerQueueSensor::schedule(), SoTimerQueueSensor::scheduled, and SoTimerQueueSensor::setTriggerTime().

Referenced by schedule().


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 23 16:34:03 2009 for Coin by Doxygen. 1.5.8