man SoElapsedTime () - basic controllable time source
NAME
SoElapsedTime - basic controllable time source
INHERITS FROM
SoBase > SoFieldContainer > SoEngine > SoElapsedTime
SYNOPSIS
#include <Inventor/engines/SoElapsedTime.h>
Inputs from class SoElapsedTime:
c
}
c
}
timeIn
c
}
c
}
speed
c
}
c
}
on
c
}
c
}
pause
c
}
c
}
reset
Outputs from class SoElapsedTime:
c
}
c
}
timeOut
Methods from class SoElapsedTime:
c
}
c
}
SoElapsedTime()
Methods from class SoEngine:
c
}
c
}
getClassTypeId()
c
}
c
}
getOutputs(SoEngineOutputList &list) const
c
}
c
}
getOutput(const SbName &outputName) const
c
}
c
}
getOutputName(const SoEngineOutput *output, SbName &outputName) const
c
}
c
}
copy() const
c
}
c
}
getByName(const SbName &name)
c
}
c
}
getByName(const SbName &name, SoEngineList &list)
Methods from class SoFieldContainer:
c
}
c
}
setToDefaults()
c
}
c
}
hasDefaultValues() const
c
}
c
}
fieldsAreEqual(const SoFieldContainer *fc) const
c
}
c
}
copyFieldValues(const SoFieldContainer *fc, SbBool copyConnections = FALSE)
c
}
c
}
set(const char *fieldDataString)
c
}
c
}
get(SbString &fieldDataString)
c
}
c
}
getFields(SoFieldList &resultList) const
c
}
c
}
getField(const SbName &fieldName) const
c
}
c
}
getFieldName(const SoField *field, SbName &fieldName) const
c
}
c
}
isNotifyEnabled() const
c
}
c
}
enableNotify(SbBool flag)
Methods from class SoBase:
c
}
c
}
ref()
c
}
c
}
unref() const
c
}
c
}
unrefNoDelete() const
c
}
c
}
touch()
c
}
c
}
getTypeId() const
c
}
c
}
isOfType(SoType type) const
c
}
c
}
setName(const SbName &name)
c
}
c
}
getName() const
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
c
}
c
}
timeIn
Running time.
c
}
c
}
speed
Scale factor for time.
c
}
c
}
on
TRUE to start running, FALSE to stop.
c
}
c
}
pause
TRUE to freeze, FALSE to continue running.
c
}
c
}
reset
Reset the base time.
OUTPUTS
c
}
c
}
timeOut
Time elapsed, modified by the speed factor.
METHODS
c
}
c
}
SoElapsedTime()
Constructor.
FILE FORMAT/DEFAULTS
ElapsedTime { timeIn <current time> speed 1 on TRUE pause FALSE reset }
SEE ALSO
SoTimeCounter, SoOneShot, SoEngineOutput