SoOneShot(3)

📦 version 2.5.0, in fedora 43, fedora 44

💖 SoOneShot(3) — Library Functions Manual 💖

okay bestie, sit down, hydrate, because we're about to get into SoOneShot from the Coin library. This is a 3 page (library functions, not commands), and the whole vibe is: it's a timer engine that runs for a configurable time and then stops. Iconic behaviour. No notes.

✨ NAME ✨

SoOneShot — the SoOneShot class is a timer that runs for a configurable time and then stops.

✨ SYNOPSIS ✨

#include <Inventor/engines/SoOneShot.h>

Inherits SoEngine. She's an engine, your honor. 💅

🌸 Public Types 🌸

  • enum Flags { RETRIGGERABLE =1, HOLD_FINAL =2 } — the two flag constants, sitting right there in public for everyone to see.

🌸 Public Member Functions 🌸

  • virtual SoType getTypeId (void) const
  • virtual const SoFieldData * getFieldData (void) const
  • virtual const SoEngineOutputData * getOutputData (void) const
  • SoOneShot (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
  • SoSFTime duration
  • SoSFTrigger trigger
  • SoSFBitMask flags
  • SoSFBool disable
  • SoEngineOutput timeOut
  • SoEngineOutput isActive
  • SoEngineOutput ramp

🌸 Protected Member Functions 🌸

  • ~SoOneShot ()

🦋 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 SoOneShot class is a timer that runs for a configurable time and then stops. That's the whole assignment and she ate it, no crumbs. 🎀

✨ Member Enumeration Documentation ✨

🧚 enum SoOneShot::Flags

There are two flags available, and here's the tea on each:

  • RETRIGGERABLE will cause the engine to restart at 0 if the SoOneShot::trigger field is activated during a run. Otherwise — and this is the important part, bestie — the trigger is ignored during runs.
  • HOLD_FINAL will make the engine outputs keep their values after a run, instead of resetting them.

✨ Constructor & Destructor Documentation ✨

🧚 SoOneShot::SoOneShot (void )

Default constructor. She's born, she's ready, she's got her defaults.

References disable, duration, flags, SoDB::getGlobalField(), isActive, ramp, SoOneShot(), timeIn, timeOut, trigger, and SbTime::zero().

Referenced by getFieldData(), and SoOneShot().

🧚 SoOneShot::~SoOneShot () [protected]

Destructor is protected to avoid explicit destruction. so like, don't even try it. 🙈

✨ Member Function Documentation ✨

🧚 SoType SoOneShot::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. 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 * SoOneShot::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 SoOneShot().

🧚 const SoEngineOutputData * SoOneShot::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. (iykyk, it's giving internal. 💅)

Implements SoEngine.

✨ Member Data Documentation ✨

🧚 SoSFTime SoOneShot::timeIn

Input time source. Connected by default to the realTime global field, but the application programmer is free to change this to any other time source. lowkey customizable, highkey iconic. ⏰

Referenced by SoOneShot().

🧚 SoSFTime SoOneShot::duration

The time the engine should run for when it is triggered. Defaults to 1 second.

Referenced by SoOneShot().

🧚 SoSFTrigger SoOneShot::trigger

A pulse on this input field starts the engine. ✨ go go go ✨

Referenced by SoOneShot().

🧚 SoSFBitMask SoOneShot::flags

Control flags. See SoOneShot::Flags.

Referenced by SoOneShot().

🧚 SoSFBool SoOneShot::disable

Set to TRUE to disable the engine completely. Completely completely.

Referenced by SoOneShot().

🧚 SoEngineOutput SoOneShot::timeOut

(SoSFTime) Output time. Will run from 0 to the value of SoOneShot::duration.

Referenced by SoOneShot().

🧚 SoEngineOutput SoOneShot::isActive

(SoSFBool) TRUE while the engine is running, FALSE otherwise.

Referenced by SoOneShot().

🧚 SoEngineOutput SoOneShot::ramp

(SoSFFloat) Will run from 0 to 1 during the active period. 📈

Referenced by SoOneShot().

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code. (not a human author, just Doxygen doing its little thing, we love a generator that works 🫶)

okay that's the whole page, bestie, no cap, every flag and field accounted for 💖 this was Coin, Version 2.5.0, and the page is SoOneShot(3) — go forth and time your one shots responsibly, mwah 💅✨🎀

📦 where this page comes from