SoOneShot(3)

💖 NAME 💖

SoOneShot — bestie, this is the SoOneShot class, and it's a timer that runs for a configurable time and then stops. periodt. ⏱️✨

(it lives in the Coin manual, section 3, and it's giving "set it and forget it" but make it 3D scene graph, iykyk 🦋)

---

✨ SYNOPSIS ✨

#include <Inventor/engines/SoOneShot.h>

Inherits SoEngine.

---

🎀 Public Types 🎀

enum Flags { RETRIGGERABLE =1, HOLD_FINAL =2 }

---

🎀 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=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

isOfType returns TRUE if the type of this object is either of the same type or inherited from type. 💅

---

🎀 Static Public Member Functions 🎀

static SoType getClassTypeId (void)
static void * createInstance (void)
static void initClass (void)

initClass sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. 🌈

💜 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)

• initClass — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
• getClassTypeId — this static method returns the SoType object associated with objects of this class.

💜 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)

• initClass — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
• getClassTypeId — this static method returns the SoType object associated with objects of this class.

💜 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)

• initClass — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
• getClassTypeId — this static method returns the SoType object associated with objects of this class.

---

🎀 Public Attributes 🎀

SoSFTime timeIn
SoSFTime duration
SoSFTrigger trigger
SoSFBitMask flags
SoSFBool disable
SoEngineOutput timeOut
SoEngineOutput isActive
SoEngineOutput ramp

---

🎀 Protected Member Functions 🎀

virtual ~SoOneShot (void)

💜 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
virtual SoNotRec createNotRec (void)

---

🎀 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 bestie, listen. 🫶 The SoOneShot class is a timer that runs for a configurable time and then stops. That's the whole vibe. It's an engine, it counts, it stops. iconic behavior honestly. 💅

---

🌈 Member Enumeration Documentation 🌈

enum SoOneShot::Flags

There are two flags available, and no you cannot have more, this is the whole menu: 🎀

• RETRIGGERABLE — will cause the engine to restart at 0 if the SoOneShot::trigger field is activated during a run (otherwise 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. ✨ no thoughts, head empty, just vibes.

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

Destructor is protected to avoid explicit destruction. 🚫 so like, you literally cannot just delete this thing yourself, that's the point, don't try it bestie.

---

⭐ Member Function Documentation ⭐

SoType SoOneShot::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class.

SoType SoOneShot::getTypeId (void ) const [virtual]

Returns the type identification of an object derived from a class inheriting SoBase. This is used for runtime type checking and "downward" casting.

Implements SoBase.

const SoFieldData ** SoOneShot::getInputDataPtr (void ) [static], [protected]

Returns the SoFieldData class which holds information about inputs in this engine.

const SoEngineOutputData ** SoOneShot::getOutputDataPtr (void ) [static], [protected]

Returns the SoEngineOutputData class which holds information about the outputs in this engine.

const SoFieldData * SoOneShot::getFieldData (void ) const [virtual]

Returns the SoFieldData class which holds information about inputs in this engine.

Reimplemented from SoFieldContainer.

const SoEngineOutputData * SoOneShot::getOutputData (void ) const [virtual]

Returns the SoEngineOutputData class which holds information about the outputs in this engine.

Implements SoEngine.

void * SoOneShot::createInstance (void ) [static]

Creates a new instance of the class type corresponding to the SoType object. 🐣 brand new baby engine, slay.

---

👑 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. ⏰ swap it out whenever, no cap.

SoSFTime SoOneShot::duration

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

SoSFTrigger SoOneShot::trigger

A pulse on this input field starts the engine. 💥

SoSFBitMask SoOneShot::flags

Control flags. See SoOneShot::Flags. 🚩

SoSFBool SoOneShot::disable

Set to TRUE to disable the engine completely. 🙈

SoEngineOutput SoOneShot::timeOut

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

SoEngineOutput SoOneShot::isActive

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

SoEngineOutput SoOneShot::ramp

(SoSFFloat) Will run from 0 to 1 during the active period. 📈 the little glow-up arc.

---

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code. 🤖 (not me writing a whole essay, the robots did it, and honestly? ate.)

---

Version 4.0.10 · Thu Jun 25 2026 00:00:00 · SoOneShot(3)

and that's the whole page bestie, tysm for reading, go set a timer and go take a nap, you deserve it 💖🎀🦋✨🌸🫶💅