SoTimeCounter(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoTimeCounter(3) — the library-functions-manual girly pop 💖

okay so bestie, welcome to SoTimeCounter(3), straight out of the Library Functions Manual. buckle up, this engine is lowkey iconic ✨

🌸 NAME 🌸

SoTimeCounter — the SoTimeCounter class is an integer counter engine. no cap, that's literally the whole job description 💅

✨ SYNOPSIS ✨

#include <Inventor/engines/SoTimeCounter.h>

Inherits SoEngine.

💖 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=FALSE)
  • 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 *input)
  • void get (SbString &fielddata, SoOutput *out)
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
  • SbBool getIsBuiltIn (void) const
  • virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
  • 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 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 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 *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
  • 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 (void)
  • virtual void inputChanged (SoField *which)
  • virtual void writeInstance (SoOutput *out)

🍓 Protected Member Functions inherited from SoEngine

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

💅 Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void)
  • virtual ~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 SoTimeCounter class is an integer counter engine. yes, that's its whole personality and honestly? slay 💅

The SoTimeCounter engine is by default connected to the realTime global field, and does stepwise updates on the SoTimeCounter::output field according to the field settings. it's giving "metronome but make it couture" ✨

🎀 Constructor & Destructor Documentation 🎀

SoTimeCounter::SoTimeCounter (void )

Default constructor. the origin story, the main character introduction, the whole vibe 🫶

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

Destructor. she's leaving the group chat 😭

💖 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, it's the "who even ARE you" check but for objects 🔥

Usage example:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)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. bestie you can't skip this one, it's not optional, no cap.

For more information on writing Coin extensions, see the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase.

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. so like, if there's nothing in there, it just says NULL. straightforward queen 💅

Reimplemented from SoFieldContainer.

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. not me telling you to just mind your business on this one 🙈

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 Right Thing when a specific field is changed. she's chill by default, but you can teach her to react 🌸

Reimplemented from SoEngine.

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.

🌈 Member Data Documentation 🌈

SoSFTime SoTimeCounter::timeIn

Running time. Connected to the realTime field by default. she's on the clock, always, 24/7 ✨

SoSFShort SoTimeCounter::min

Minimum counter value. Default value is 0. the floor, the baseline, the bare minimum (literally) 🫶

SoSFShort SoTimeCounter::max

Maximum counter value. Default value is 1. she goes up to here and no further, periodt.

SoSFShort SoTimeCounter::step

Counter step size. Default value is 1. one lil baby step at a time 💅

SoSFBool SoTimeCounter::on

Set to FALSE to pause the counter. Default value is TRUE. hit pause, take a self-care moment 🧘

SoSFFloat SoTimeCounter::frequency

Number of complete cycles from the min value to the max value per second. Default value is 1.0. how fast the whole glow-up loop runs, per second ⭐

SoMFFloat SoTimeCounter::duty

Used to weight step times. Supply one weight value per step. Default array is a single value of 1.0. give each step its own lil spotlight, one weight per step 🎀

SoSFShort SoTimeCounter::reset

Manually set the counter to some value. If SoTimeCounter::reset is set below the SoTimeCounter::min value or above the SoTimeCounter::max value it will be clamped to the closest boundary value. so if you try to send her out of bounds, she just snaps to the nearest edge. boundaries, bestie 💅

SoSFTrigger SoTimeCounter::syncIn

Restart counter at the minimum value. back to square one, no shame in a fresh start 🌸

SoEngineOutput SoTimeCounter::output

(SoSFShort) The counter value. the main character, the number itself 👑

SoEngineOutput SoTimeCounter::syncOut

(SoSFTrigger) Triggers every cycle start. she announces every new beginning, every single time 🔥

🫶 Author 🫶

Generated automatically by Doxygen for Coin from the source code. (so yes, a robot wrote this and it still ate 💅)

and that's the whole page, bestie!! this one's from Coin, Version 3.1.3, filed under SoTimeCounter(3) 🦋 go forth and count your little heart out 💖✨

📦 where this page comes from