SoElapsedTime(3IV)NAMESoElapsedTime (SoElapsedTime) - basic controllable time source
INHERITS FROM
SoBase > SoFieldContainer > SoEngine > SoElapsedTimeSYNOPSIS
#include <Inventor_c/engines/SoElapsedTime.h>
Inputs from class SoElapsedTime:
SoSFTime timeIn
SoSFFloat speed
SoSFBool on
SoSFBool pause
SoSFTrigger reset
Outputs from class SoElapsedTime:
(SoSFTime) timeOut
Functions from class SoElapsedTime:
SoElapsedTime * SoElapsedTimeCreate()
Functions from class SoEngine:
SoType SoElapsedTimeGetTypeId()
int SoElapsedTimeGetOuts(const SoElapsedTime *this,
SoEngineOutputList *list)
SoEngineOutput * SoElapsedTimeGetOut(const SoElapsedTime *this, const
char *outputName)
SbBool SoElapsedTimeGetOutName(const SoElapsedTime *this,
const SoEngineOutput *output, SbName
*outputName)
SoEngine * SoElapsedTimeCopy(const SoElapsedTime *this)
SoEngine * SoElapsedTimeGetByName(const char *name)
int SoElapsedTimeGetByNameList(const char *name,
SoEngineList *list)
Functions from class SoFieldContainer:
SoType SoElapsedTimeGetClassTypeId()
void SoElapsedTimeSetToDflts(SoElapsedTime *this)
SbBool SoElapsedTimeHasDfltVals(const SoElapsedTime *this)
SbBool SoElapsedTimeFldsAreEq(const SoElapsedTime *this,
const SoFieldContainer *fc)
void SoElapsedTimeCopyFieldVals(SoElapsedTime *this, const
SoFieldContainer *fc, SbBool copyConnections =
FALSE)
SbBool SoElapsedTimeSet(SoElapsedTime *this, const char
*fieldDataString)
Page 1SoElapsedTime(3IV)
void SoElapsedTimeGet(SoElapsedTime *this, SbString
*fieldDataString)
int SoElapsedTimeGetFields(const SoElapsedTime *this,
SoFieldList *resultList)
SoField * SoElapsedTimeGetField(const SoElapsedTime *this,
const char *fieldName)
SbBool SoElapsedTimeGetFieldName(const SoElapsedTime *this,
const SoField *field, SbName *fieldName)
SbBool SoElapsedTimeIsNotifyEnabled(const SoElapsedTime
*this)
SbBool SoElapsedTimeEnableNotify(SoElapsedTime *this, SbBool
flag)
Functions from class SoBase:
void SoElapsedTimeRef(SoElapsedTime *this)
void SoElapsedTimeUnref(const SoElapsedTime *this)
void SoElapsedTimeUnrefNoDelete(const SoElapsedTime *this)
void SoElapsedTimeTouch(SoElapsedTime *this)
SbBool SoElapsedTimeIsOfType(const SoElapsedTime *this,
SoType type)
void SoElapsedTimeSetName(SoElapsedTime *this, const char
*name)
SbName SoElapsedTimeGetName(const SoElapsedTime *this)
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.
INPUTS
SoSFTime timeIn
Running time.
SoSFFloat speed
Scale factor for time.
Page 2SoElapsedTime(3IV)
SoSFBool on
TRUE to start running, FALSE to stop.
SoSFBool pause
TRUE to freeze, FALSE to continue running.
SoSFTrigger reset
Reset the base time.
OUTPUTS
(SoSFTime) timeOut
Time elapsed, modified by the speed factor.
FUNCTIONSSoElapsedTime * SoElapsedTimeCreate()
Constructor.
FILE FORMAT/DEFAULTS
ElapsedTime {
timeIn <current time>
speed 1
on TRUE
pause FALSE
reset
}
SEE ALSO
SoTimeCounter, SoOneShot, SoEngineOutput
Page 3
