SoElapsedTime(3)

📦 version 2.5.0, in fedora 43, fedora 44

✨ NAME ✨

ok so welcome to SoElapsedTime(3), bestie — this is the Library Functions Manual page for the SoElapsedTime class, and it is literally a controllable time source engine. 🕰️💖

🌸 SYNOPSIS 🌸

#include <Inventor/engines/SoElapsedTime.h>

Inherits SoEngine.

🫶 Public Member Functions

virtual SoType getTypeId (void) const
virtual const SoFieldData * getFieldData (void) const
virtual const SoEngineOutputData * getOutputData (void) const
SoElapsedTime (void)

💫 Public Member Functions inherited from `SoEngine`

void evaluateWrapper (void)
virtual int getOutputs (SoEngineOutputList &l) const
SoEngineOutput * getOutput (const SbName &outputname) const
SbBool getOutputName (const SoEngineOutput *output, SbName &outputname)
    const
SbBool isNotifying (void) const
virtual void notify (SoNotList *nl)
SoEngine * copy (void) const
virtual SoFieldContainer * copyThroughConnection (void) const
SbBool shouldCopy (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 SoField * getField (const SbName &name) const
virtual SoField * getEventIn (const SbName &name) const
virtual SoField * getEventOut (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
virtual void copyContents (const SoFieldContainer *from, SbBool
    copyconnections)
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)
virtual void startNotify (void)
void addAuditor (void *const auditor, const SoNotRec::Type type)
void removeAuditor (void *const auditor, const SoNotRec::Type type)
const SoAuditorList & getAuditors (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)

💫 Static Public Member Functions inherited from `SoEngine`

static void initClass (void)
static void initClasses (void)
static SoType getClassTypeId (void)
static SoEngine * getByName (const SbName &name)
static int getByName (const SbName &name, SoEngineList &el)

💫 Static Public Member Functions inherited from `SoFieldContainer`

static void initClass (void)
static SoType getClassTypeId (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 Public Member Functions inherited from `SoBase`

static void initClass (void)
static SoType getClassTypeId (void)
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 *in, SoBase *&base, SoType expectedtype)
static void setInstancePrefix (const SbString &c)
static void setTraceRefs (SbBool trace)
static SbBool getTraceRefs (void)
static SbBool connectRoute (SoInput *in, const SbName &fromnodename,
    const SbName &fromfieldname, const SbName &tonodename, const SbName
    &tofieldname)
static SbBool readRoute (SoInput *in)

👑 Public Attributes

SoSFTime timeIn
SoSFFloat speed
SoSFBool on
SoSFBool pause
SoSFTrigger reset
SoEngineOutput timeOut

🔒 Protected Member Functions

~SoElapsedTime ()
virtual void writeInstance (SoOutput *out)

💫 Protected Member Functions inherited from `SoEngine`

SoEngine (void)
virtual ~SoEngine ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)
void writeOutputTypes (SoOutput *out)

💫 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 ** getInputDataPtr (void)
static const SoEngineOutputData ** getOutputDataPtr (void)

💫 Static Protected Member Functions inherited from `SoEngine`

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

💫 Static Protected Member Functions inherited from `SoBase`

static uint32_t getCurrentWriteCounter (void)
static void staticDataLock (void)
static void staticDataUnlock (void)

🦋 Additional Inherited Members

💫 Protected Types inherited from `SoBase`

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

💫 Protected Attributes inherited from `SoFieldContainer`

SbBool isBuiltIn

💜 Detailed Description 💜

The SoElapsedTime class is a controllable time source engine. (say it with me: controllable. time. source. engine. iconic.)

ok so here's the tea — the extra functionality you get from this engine versus just connecting straight to the realTime global field is: the ability to control the speed of the time source, plus logic to reset, stop and restart it. that's the whole point, no cap. ✨

Simple usage example, combined with SoComposeRotation:

#Inventor V2.1 ascii

Separator {
   Transform {
      rotation =
      ComposeRotation { axis 0 1 0  angle =
         ElapsedTime { }.timeOut
      }.rotation
   }
   Cube { }
}

🎀 See also

SoTimeCounter

🛠️ Constructor & Destructor Documentation 🛠️

`SoElapsedTime::SoElapsedTime (void )`

Default constructor. 🐣

References SoDB::getGlobalField(), on, pause, reset, SoElapsedTime(), speed, timeIn, timeOut, and SbTime::zero().

Referenced by getFieldData(), and SoElapsedTime().

`SoElapsedTime::~SoElapsedTime ()` [protected]

Destructor. 🫡

📚 Member Function Documentation 📚

`SoType SoElapsedTime::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, bestie. no skipping. 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 * SoElapsedTime::getFieldData (void ) const` [virtual]

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

Reimplemented from SoFieldContainer.

References SoElapsedTime().

`const SoEngineOutputData * SoElapsedTime::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. (so like… it's giving internal. don't worry about it. 🙈)

Implements SoEngine.

`void SoElapsedTime::writeInstance (SoOutput * out)` [protected], [virtual]

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.

References SoDB::getGlobalField(), timeIn, and SoEngine::writeInstance().

💎 Member Data Documentation 💎

`SoSFTime SoElapsedTime::timeIn`

Input time value. Default connected to the global realTime field. ⏱️

Referenced by SoElapsedTime(), and writeInstance().

`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. (yes, literally time travel, we love a plot twist 🌀)