![]() |
Coin3D is Free Software, published under the BSD 3-clause license. |
https://coin3d.github.io https://www.kongsberg.com/en/kogt/ |
The SoElapsedTime class is a controllable time source engine. More...
#include <Inventor/engines/SoElapsedTime.h>
Static Public Member Functions | |
static SoType | getClassTypeId (void) |
static void * | createInstance (void) |
static void | initClass (void) |
Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. | |
![]() | |
static void | initClass (void) |
Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. | |
static void | initClasses (void) |
static SoType | getClassTypeId (void) |
This static method returns the SoType object associated with objects of this class. | |
static SoEngine * | getByName (const SbName &name) |
static int | getByName (const SbName &name, SoEngineList &el) |
![]() | |
static void | initClass (void) |
Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. | |
static SoType | getClassTypeId (void) |
This static method returns the SoType object associated with objects of this class. | |
static void | cleanupClass (void) |
static void | initCopyDict (void) |
static void | addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) |
static SoFieldContainer * | checkCopy (const SoFieldContainer *orig) |
static SoFieldContainer * | findCopy (const SoFieldContainer *orig, const SbBool copyconnections) |
static void | copyDone (void) |
![]() | |
static void | initClass (void) |
Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. | |
static SoType | getClassTypeId (void) |
This static method returns the SoType object associated with objects of this class. | |
static void | addName (SoBase *const base, const char *const name) |
static void | removeName (SoBase *const base, const char *const name) |
static void | incrementCurrentWriteCounter (void) |
static void | decrementCurrentWriteCounter (void) |
static SoBase * | getNamedBase (const SbName &name, SoType type) |
static int | getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) |
static SbBool | read (SoInput *input, SoBase *&base, SoType expectedtype) |
static void | setInstancePrefix (const SbString &c) |
static void | setTraceRefs (SbBool trace) |
static SbBool | getTraceRefs (void) |
static SbBool | connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) |
static SbBool | readRoute (SoInput *input) |
Public Attributes | |
SoSFTime | timeIn |
SoSFFloat | speed |
SoSFBool | on |
SoSFBool | pause |
SoSFTrigger | reset |
SoEngineOutput | timeOut |
Protected Member Functions | |
virtual | ~SoElapsedTime (void) |
virtual void | writeInstance (SoOutput *out) |
![]() | |
SoEngine (void) | |
virtual | ~SoEngine (void) |
virtual SbBool | readInstance (SoInput *in, unsigned short flags) |
void | writeOutputTypes (SoOutput *out) |
![]() | |
SoFieldContainer (void) | |
virtual | ~SoFieldContainer () |
![]() | |
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 |
virtual SoNotRec | createNotRec (void) |
Static Protected Member Functions | |
static const SoFieldData ** | getInputDataPtr (void) |
static const SoEngineOutputData ** | getOutputDataPtr (void) |
![]() | |
static const SoFieldData ** | getInputDataPtr (void) |
static const SoEngineOutputData ** | getOutputDataPtr (void) |
![]() | |
static uint32_t | getCurrentWriteCounter (void) |
static void | staticDataLock (void) |
static void | staticDataUnlock (void) |
Additional Inherited Members | |
![]() | |
enum | BaseFlags { IS_ENGINE = 0x01 , IS_GROUP = 0x02 } |
![]() | |
SbBool | isBuiltIn |
The SoElapsedTime class is a controllable time source engine.
The additional functionality provided by this engine versus just connecting to the realTime global field is the ability to control the speed of the time source plus logic to reset, stop and restart it.
Simple usage example, combined with SoComposeRotation:
SoElapsedTime::SoElapsedTime | ( | void | ) |
Default constructor.
|
protectedvirtual |
Destructor.
This static method returns the SoType object associated with objects of this class.
|
staticprotected |
Returns the SoFieldData class which holds information about inputs in this engine.
|
staticprotected |
Returns the SoEngineOutputData class which holds information about the outputs in this engine.
|
virtual |
Returns the SoFieldData class which holds information about inputs in this engine.
Reimplemented from SoFieldContainer.
|
virtual |
Returns the SoEngineOutputData class which holds information about the outputs in this engine.
Implements SoEngine.
Creates a new instance of the class type corresponding to the SoType object.
Writes all the fields contained in this instance to the output stream within out.
This method is solely called from the write methods of fields.
Either from SoField if the write is done because of a field-to-field connection, or from one of the fields which may actually write SoFieldContainer instances, i.e. SoSFNode, SoMFNode, SoSFEngine, SoMFEngine, SoSFPath and SoMFPath.
This method, in addition to the ordinary write() method of SoNode, needs to be present since the fields don't have a write action instance in their writeValue() method, and writeInstance() will create a new SoWriteAction and call continueToApply() on it.
Reimplemented from SoEngine.
SoSFTime SoElapsedTime::timeIn |
Input time value. Default connected to the global realTime field.
SoSFFloat SoElapsedTime::speed |
Decides how fast the timer should run, measured versus "real time" from the timeIn field. Default value is 1.0.
A negative value makes the time go backward.
SoSFBool SoElapsedTime::on |
Shuts timer on and off. Will restart at the same position.
SoSFBool SoElapsedTime::pause |
Shuts timer on and off. Will restart at the position it would have been if not paused (i.e. doesn't "lose time").
SoSFTrigger SoElapsedTime::reset |
Restart timer at 0.
SoEngineOutput SoElapsedTime::timeOut |
(SoSFTime) Output time value. Starts at 0.