SoTimeCounter(3)

📦 version 2.5.0, in fedora 43, fedora 44

✨ SoTimeCounter(3) ✨

the integer counter engine that's literally the moment

okay so this is SoTimeCounter(3), from the Library Functions Manual, and bestie we are folding that manual name right in here. periodt. 💅

🌸 NAME 🌸

SoTimeCounter — the SoTimeCounter class is an integer counter engine. that's the whole vibe. no cap. 🎀

🦋 SYNOPSIS 🦋

first up, the include, it's giving header file realness:

#include <Inventor/engines/SoTimeCounter.h>

inherits SoEngine. lowkey iconic lineage. ✨

💅 Public Member Functions 💅

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

🫶 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 ()

💎 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
SoSFShort min
SoSFShort max
SoSFShort step
SoSFBool on
SoSFFloat frequency
SoMFFloat duty
SoSFShort reset
SoSFTrigger syncIn
SoEngineOutput output
SoEngineOutput syncOut

🛡️ Protected Member Functions 🛡️

virtual ~SoTimeCounter ()
virtual void inputChanged (SoField *which)
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 💖

okay so the SoTimeCounter class is literally an integer counter engine. that's the whole point, bestie. 🎀

the SoTimeCounter engine is by default connected to the realTime global field, and it does stepwise updates on the SoTimeCounter::output field according to the field settings. it's giving scheduled glow-up energy. ✨

🎀 Constructor & Destructor Documentation 🎀

🌸 SoTimeCounter::SoTimeCounter (void ) 🌸

default constructor. it's the birth of the vibe. 👑

references duty, frequency, SoDB::getGlobalField(), max, min, on, output, reset, SoTimeCounter(), step, syncIn, syncOut, timeIn, and SbTime::zero().

referenced by getFieldData(), and SoTimeCounter().

💅 SoTimeCounter::~SoTimeCounter () [protected], [virtual] 💅

destructor. it's the cleanup era, protected and virtual. slay responsibly. 🫶

👑 Member Function Documentation 👑

🌈 SoType SoTimeCounter::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. iykyk. 💅

usage example, keep it exact bestie:

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. 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. periodt.

✨ const SoFieldData * SoTimeCounter::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. no fields? NULL. simple as.

reimplemented from SoFieldContainer.

references SoTimeCounter().

💎 const SoEngineOutputData * SoTimeCounter::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. it's giving backstage pass only. 🎟️

implements SoEngine.

🍓 void SoTimeCounter::inputChanged (SoField * which) [protected], [virtual] 🍓

called when an input is changed. the default method does nothing, but subclasses may override this method to do the The Right Thing when a specific field is changed. that's the assignment bestie. 💅

reimplemented from SoEngine.

references duty, frequency, max, min, on, output, reset, step, syncIn, syncOut, and timeIn.

🌸 void SoTimeCounter::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 🌸

okay bestie this is the main character section — all the fields that live inside SoTimeCounter and make it do its lil counting thing. every single one, no skips, let's go 🫶

`SoSFTime SoTimeCounter::timeIn`

the running time, bestie. ⏰ by default it's wired up to the realTime field, so it just... vibes along with actual time. iconic behaviour honestly.

referenced by inputChanged(), SoTimeCounter(), and writeInstance(). so yeah, three whole places care about it 💅