SoElapsedTime — basic controllable time source

Description

       This  engine  functions as a stopwatch; it outputs the time that has elapsed since it started running. By
       default, the timeIn input is connected to the realTime global field. It can, however, be connected to any
       other time source.

       The ouput from the engine is the time that has elapsed since it started running, or since the reset input
       was last triggered. You can affect the speed of the output time by setting  the  speed  scale  factor.  A
       value greater than 1.0 will speed up the output, and a value less than 1.0 will slow it down.

       If  you  pause the engine, by setting the pause input to TRUE, it stops updating the timeOut output. When
       you turn off the pause, it jumps to its current position without losing time. Alternatively, if you  want
       to stop the engine for a while, and then restart it from where it left off, use the on input field.

File Format/Defaults

ElapsedTime{timeIn<currenttime>speed1onTRUEpauseFALSEreset}

Inherits From

       SoBase > SoFieldContainer > SoEngine > SoElapsedTime

Inputs

SoSFTimetimeIn
          Running time.

     SoSFFloatspeed
          Scale factor for time.

     SoSFBoolon
          TRUE to start running, FALSE to stop.

     SoSFBoolpause
          TRUE to freeze, FALSE to continue running.

     SoSFTriggerreset
          Reset the base time.

Methods

SoElapsedTime()
          Constructor.

Name

       SoElapsedTime — basic controllable time source

Outputs

(SoSFTime)timeOut
          Time elapsed, modified by the speed factor.

Synopsis

#include<Inventor/engines/SoElapsedTime.h>

          Inputs from class SoElapsedTime:

     SoSFTimetimeInSoSFFloatspeedSoSFBoolonSoSFBoolpauseSoSFTriggerreset

          Outputs from class SoElapsedTime:

     (SoSFTime)timeOut

          Methods from class SoElapsedTime:

                         SoElapsedTime()

          Methods from class SoEngine:

     staticSoTypegetClassTypeId()virtualintgetOutputs(SoEngineOutputList&list)constSoEngineOutput*getOutput(constSbName&outputName)constSbBoolgetOutputName(constSoEngineOutput*output,SbName&outputName)constSoEngine*copy()conststaticSoEngine*getByName(constSbName&name)staticintgetByName(constSbName&name,SoEngineList&list)

          Methods from class SoFieldContainer:

     voidsetToDefaults()SbBoolhasDefaultValues()constSbBoolfieldsAreEqual(constSoFieldContainer*fc)constvoidcopyFieldValues(constSoFieldContainer*fc,SbBoolcopyConnections=FALSE)SbBoolset(constchar*fieldDataString)voidget(SbString&fieldDataString)virtualintgetFields(SoFieldList&resultList)constvirtualSoField*getField(constSbName&fieldName)constSbBoolgetFieldName(constSoField*field,SbName&fieldName)constSbBoolisNotifyEnabled()constSbBoolenableNotify(SbBoolflag)

          Methods from class SoBase:

     voidref()voidunref()constvoidunrefNoDelete()constvoidtouch()virtualSoTypegetTypeId()constSbBoolisOfType(SoTypetype)constvirtualvoidsetName(constSbName&name)virtualSbNamegetName()const