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

Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Static Protected Member Functions
SoVRMLTimeSensor Class Reference

The SoVRMLTimeSensor class is a multi-purpose time event generator.The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium: More...

#include <Inventor/VRMLnodes/SoVRMLTimeSensor.h>

Inheritance diagram for SoVRMLTimeSensor:
SoNodeEngine SoNode SoFieldContainer SoBase

List of all members.

Public Member Functions

virtual SoType getTypeId (void) const
virtual const SoEngineOutputData * getOutputData (void) const
 SoVRMLTimeSensor (void)
virtual void notify (SoNotList *list)
virtual void handleEvent (SoHandleEventAction *action)
virtual void write (SoWriteAction *action)
- Public Member Functions inherited from SoNodeEngine
void evaluateWrapper (void)
virtual int getOutputs (SoEngineOutputList &l) const
SoEngineOutputgetOutput (const SbName &outputname) const
SbBool getOutputName (const SoEngineOutput *output, SbName &outputname) const
SbBool isNotifying (void) const
virtual void writeInstance (SoOutput *out)
- Public Member Functions inherited from SoNode
void setOverride (const SbBool state)
SbBool isOverride (void) const
void setNodeType (const NodeType type)
NodeType getNodeType (void) const
virtual SoNodecopy (SbBool copyconnections=0) const
virtual SbBool affectsState (void) const
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void pick (SoPickAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void search (SoSearchAction *action)
virtual void audioRender (SoAudioRenderAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
uint32_t getNodeId (void) const
virtual SoChildListgetChildren (void) const
virtual SoNodeaddToCopyDict (void) const
virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
virtual SoFieldContainercopyThroughConnection (void) const
- Public Member Functions inherited from SoFieldContainer
void setToDefaults (void)
SbBool hasDefaultValues (void) const
SbBool fieldsAreEqual (const SoFieldContainer *container) const
void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=0)
SbBool set (const char *const fielddata)
void get (SbString &fielddata)
virtual int getFields (SoFieldList &l) const
virtual int getAllFields (SoFieldList &l) const
virtual SoFieldgetField (const SbName &name) const
virtual SoFieldgetEventIn (const SbName &name) const
virtual SoFieldgetEventOut (const SbName &name) const
SbBool getFieldName (const SoField *const field, SbName &name) const
SbBool enableNotify (const SbBool flag)
SbBool isNotifyEnabled (void) const
SbBool set (const char *fielddata, SoInput *in)
void get (SbString &fielddata, SoOutput *out)
virtual SbBool validateNewFieldValue (SoField *field, void *newval)
virtual void addWriteReference (SoOutput *out, SbBool isfromfield=0)
SbBool getIsBuiltIn (void) const
void setUserData (void *userdata) const
void * getUserData (void) const
- Public Member Functions inherited from SoBase
void ref (void) const
void unref (void) const
void unrefNoDelete (void) const
int32_t getRefCount (void) const
void touch (void)
SbBool isOfType (SoType type) const
virtual SbName getName (void) const
virtual void setName (const SbName &newname)
void addAuditor (void *const auditor, const SoNotRec::Type type)
void removeAuditor (void *const auditor, const SoNotRec::Type type)
const SoAuditorListgetAuditors (void) const
SbBool shouldWrite (void)
void assertAlive (void) const

Static Public Member Functions

static SoType getClassTypeId (void)
static void * createInstance (void)
static void initClass (void)

Public Attributes

SoSFTime cycleInterval
SoSFBool enabled
SoSFBool loop
SoSFTime startTime
SoSFTime stopTime
SoEngineOutput cycleTime
SoEngineOutput fraction_changed
SoEngineOutput isActive
SoEngineOutput time

Protected Member Functions

virtual const SoFieldDatagetFieldData (void) const
virtual ~SoVRMLTimeSensor ()
virtual void inputChanged (SoField *whichInput)
- Protected Member Functions inherited from SoNodeEngine
 SoNodeEngine (void)
virtual ~SoNodeEngine ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)
void writeOutputTypes (SoOutput *out)
- Protected Member Functions inherited from SoNode
 SoNode (void)
virtual ~SoNode ()
- Protected Member Functions inherited from SoFieldContainer
 SoFieldContainer (void)
 ~SoFieldContainer ()
- Protected Member Functions inherited from SoBase
 SoBase (void)
virtual ~SoBase ()
SbBool hasMultipleWriteRefs (void) const
SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const
void writeFooter (SoOutput *out) const
virtual const char * getFileFormatName (void) const

Static Protected Member Functions

static const SoFieldData ** getFieldDataPtr (void)
static const SoEngineOutputData ** getOutputDataPtr (void)

Detailed Description

The SoVRMLTimeSensor class is a multi-purpose time event generator.

The detailed class documentation is taken verbatim from the VRML97 standard (ISO/IEC 14772-1:1997). It is copyright The Web3D Consortium, and is used by permission of the Consortium:

  TimeSensor {
    exposedField SFTime   cycleInterval 1       # (0,inf)
    exposedField SFBool   enabled       TRUE
    exposedField SFBool   loop          FALSE
    exposedField SFTime   startTime     0       # (-inf,inf)
    exposedField SFTime   stopTime      0       # (-inf,inf)
    eventOut     SFTime   cycleTime
    eventOut     SFFloat  fraction_changed      # [0, 1]
    eventOut     SFBool   isActive
    eventOut     SFTime   time
  }

TimeSensor nodes generate events as time passes. TimeSensor nodes can be used for many purposes including:

The TimeSensor node contains two discrete eventOuts: isActive and cycleTime. The isActive eventOut sends TRUE when the TimeSensor node begins running, and FALSE when it stops running. The cycleTime eventOut sends a time event at startTime and at the beginning of each new cycle (useful for synchronization with other time-based objects). The remaining eventOuts generate continuous events. The fraction_changed eventOut, an SFFloat in the closed interval [0,1], sends the completed fraction of the current cycle. The time eventOut sends the absolute time for a given simulation tick.

If the enabled exposedField is TRUE, the TimeSensor node is enabled and may be running. If a set_enabled FALSE event is received while the TimeSensor node is running, the sensor performs the following actions:

Events on the exposedFields of the TimeSensor node (e.g., set_startTime) are processed and their corresponding eventOuts (e.g., startTime_changed) are sent regardless of the state of the enabled field. The remaining discussion assumes enabled is TRUE.

The e\ loop, startTime, and stopTime exposedFields and the isActive eventOut and their effects on the TimeSensor node are discussed in detail in 4.6.9, Time-dependent nodes (http://www.web3d.org/x3d/specifications/vrml/ISO-IEC-14772-VRML97/part1/concepts.html#4.6.9). The "cycle" of a TimeSensor node lasts for cycleInterval seconds. The value of cycleInterval shall be greater than zero.

A cycleTime eventOut can be used for synchronization purposes such as sound with animation. The value of a cycleTime eventOut will be equal to the time at the beginning of the current cycle. A cycleTime eventOut is generated at the beginning of every cycle, including the cycle starting at startTime. The first cycleTime eventOut for a TimeSensor node can be used as an alarm (single pulse at a specified time).

When a TimeSensor node becomes active, it generates an isActive = TRUE event and begins generating time, fraction_changed, and cycleTime events which may be routed to other nodes to drive animation or simulated behaviours. The behaviour at read time is described below. The time event sends the absolute time for a given tick of the TimeSensor node (time fields and events represent the number of seconds since midnight GMT January 1, 1970).

fraction_changed events output a floating point value in the closed interval [0, 1]. At startTime the value of fraction_changed is 0. After startTime, the value of fraction_changed in any cycle will progress through the range (0.0, 1.0]. At startTime + N cycleInterval, for N = 1, 2, ..., that is, at the end of every cycle, the value of fraction_changed is 1.

Let now represent the time at the current simulation tick. Then the time and fraction_changed eventOuts can then be computed as:

  time = now 
  temp = (now - startTime) / cycleInterval 
  f = fractionalPart(temp) 
  if (f == 0.0 && now > startTime) fraction_changed = 1.0 
  else fraction_changed = f 

where fractionalPart(x) is a function that returns the fractional part, (that is, the digits to the right of the decimal point), of a nonnegative floating point number.

A TimeSensor node can be set up to be active at read time by specifying loop TRUE (not the default) and stopTime less than or equal to startTime (satisfied by the default values). The time events output absolute times for each tick of the TimeSensor node simulation. The time events shall start at the first simulation tick greater than or equal to startTime. time events end at stopTime, or at startTime + N cycleInterval for some positive integer value of N, or loop forever depending on the values of the other fields. An active TimeSensor node shall stop at the first simulation tick when now >= stopTime > startTime.

No guarantees are made with respect to how often a TimeSensor node generates time events, but a TimeSensor node shall generate events at least at every simulation tick. TimeSensor nodes are guaranteed to generate final time and fraction_changed events. If loop is FALSE at the end of the Nth cycleInterval and was TRUE at startTime + M cycleInterval for all 0 < M < N, the final time event will be generated with a value of (startTime + N cycleInterval) or stopTime (if stopTime > startTime), whichever value is less. If loop is TRUE at the completion of every cycle, the final event is generated as evaluated at stopTime (if stopTime > startTime) or never.

An active TimeSensor node ignores set_cycleInterval and set_startTime events. An active TimeSensor node also ignores set_stopTime events for set_stopTime less than or equal to startTime. For example, if a set_startTime event is received while a TimeSensor node is active, that set_startTime event is ignored (the startTime field is not changed, and a startTime_changed eventOut is not generated). If an active TimeSensor node receives a set_stopTime event that is less than the current time, and greater than startTime, it behaves as if the stopTime requested is the current time and sends the final events based on the current time (note that stopTime is set as specified in the eventIn).

A TimeSensor read from a VRML file shall generate isActive TRUE, time and fraction_changed events if the sensor is enabled and all conditions for a TimeSensor to be active are met.


Constructor & Destructor Documentation

SoVRMLTimeSensor::SoVRMLTimeSensor ( void  )
SoVRMLTimeSensor::~SoVRMLTimeSensor ( )
protectedvirtual

Destructor.


Member Function Documentation

SoType SoVRMLTimeSensor::getClassTypeId ( void  )
static

This static method returns the SoType object associated with objects of this class.

Reimplemented from SoNodeEngine.

SoType SoVRMLTimeSensor::getTypeId ( void  ) const
virtual

Returns the type identification of an object derived from a class inheriting SoBase. This is used for run-time type checking and "downward" casting.

Usage example:

void foo(SoNode * node)
{
if (node->getTypeId() == SoFile::getClassTypeId()) {
SoFile * filenode = (SoFile *)node; // safe downward cast, knows the type
}
else if (node->getTypeId().isOfType(SoGroup::getClassTypeId())) {
SoGroup * group = (SoGroup *)node; // safe downward cast, knows the type
}
}

For application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. This is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the pre-defined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase.

const SoFieldData ** SoVRMLTimeSensor::getFieldDataPtr ( void  )
staticprotected

Returns the SoFieldData class which holds information about inputs in this engine.

Reimplemented from SoNodeEngine.

const SoFieldData * SoVRMLTimeSensor::getFieldData ( void  ) const
protectedvirtual

Returns a pointer to the class-wide field data storage object for this instance. If no fields are present, returns NULL.

Reimplemented from SoFieldContainer.

const SoEngineOutputData ** SoVRMLTimeSensor::getOutputDataPtr ( void  )
staticprotected

Returns the SoEngineOutputData class which holds information about the outputs in this engine.

Reimplemented from SoNodeEngine.

const SoEngineOutputData * SoVRMLTimeSensor::getOutputData ( void  ) const
virtual

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Implements SoNodeEngine.

void SoVRMLTimeSensor::initClass ( void  )
static

Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.

Reimplemented from SoNodeEngine.

void SoVRMLTimeSensor::notify ( SoNotList l)
virtual

Notifies all auditors for this instance when changes are made.

Reimplemented from SoNodeEngine.

References SoNodeEngine::notify().

void SoVRMLTimeSensor::handleEvent ( SoHandleEventAction action)
virtual

Action method for SoHandleEventAction.

Inspects the event data from action, and processes it if it is something which this node should react to.

Nodes influencing relevant state variables for how event handling is done also overrides this method.

Reimplemented from SoNode.

References SoNode::handleEvent().

void SoVRMLTimeSensor::write ( SoWriteAction action)
virtual

Action method for SoWriteAction.

Writes out a node object, and any connected nodes, engines etc, if necessary.

Reimplemented from SoNode.

References SoField::connectFrom(), SoField::disconnect(), SoField::getConnectedField(), SoDB::getGlobalField(), SoField::isDefault(), SoField::setDefault(), and SoNode::write().

void SoVRMLTimeSensor::inputChanged ( SoField which)
protectedvirtual

Called when an input is changed. The default method does nothing, but subclasses may override this method to do the The Right Thing when a specific field is changed.

Reimplemented from SoNodeEngine.

References cycleInterval, cycleTime, SoEngineOutput::enable(), enabled, SoField::enableNotify(), fraction_changed, SbTime::getValue(), isActive, SoField::isNotifyEnabled(), loop, startTime, stopTime, and time.


Member Data Documentation

SoSFTime SoVRMLTimeSensor::cycleInterval

The cycle interval. Default value is 1. Must be > 0.

Referenced by inputChanged(), and SoVRMLTimeSensor().

SoSFBool SoVRMLTimeSensor::enabled

Used to enable/disable timer. Default value is TRUE.

Referenced by inputChanged(), and SoVRMLTimeSensor().

SoSFBool SoVRMLTimeSensor::loop

TRUE if timer should loop. Default value is FALSE.

Referenced by inputChanged(), and SoVRMLTimeSensor().

SoSFTime SoVRMLTimeSensor::startTime

The timer start time. Default value is 0.0.

Referenced by inputChanged(), and SoVRMLTimeSensor().

SoSFTime SoVRMLTimeSensor::stopTime

The timer stop time. Default value is 0.0.

Referenced by inputChanged(), and SoVRMLTimeSensor().

SoEngineOutput SoVRMLTimeSensor::cycleTime

An eventOut that is sent when a new cycle is started.

Referenced by inputChanged(), and SoVRMLTimeSensor().

SoEngineOutput SoVRMLTimeSensor::fraction_changed

An eventOut that is sent for each tick, containing a number between 0 and 1.

Referenced by inputChanged(), and SoVRMLTimeSensor().

SoEngineOutput SoVRMLTimeSensor::isActive

An eventOut that is sent when the timer is enabled/disabled.

Referenced by inputChanged(), and SoVRMLTimeSensor().

SoEngineOutput SoVRMLTimeSensor::time

An eventOut that is sent for each tick, containing the current time.

Referenced by inputChanged(), and SoVRMLTimeSensor().


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

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

Generated on Wed Jul 18 2012 for Coin by Doxygen. 1.8.1.1