SoOnOff(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 SoOnOff 💖

okay bestie, welcome to SoOnOff(3) — this one lives in the Coin manual, and it's genuinely the cutest little engine in the whole toolkit. it's a switch. an on/off switch. that's the whole vibe. periodt. 🎀

✨ NAME ✨

SoOnOff — the SoOnOff engine is, and I quote, a simple on/off switch. that's it. that's the girl. 👑

✨ SYNOPSIS ✨

#include <Inventor/engines/SoOnOff.h>

She inherits SoEngine. 💅

🌸 Public Member Functions

  • virtual SoType getTypeId (void) const
  • virtual const SoFieldData * getFieldData (void) const
  • virtual const SoEngineOutputData * getOutputData (void) const
  • SoOnOff (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
  • virtual void writeInstance (SoOutput *out)

🌸 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 — returns TRUE if the type of this object is either of the same type or inherited from type. no cap, that's the whole check.
  • 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. basically it tells the Coin type system "hey, she exists". ✨

🌸 Static Public Member Functions inherited from SoEngine

  • static void initClass (void) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static void initClasses (void)
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class.
  • 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class.
  • 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system.
  • static SoType getClassTypeId (void) — this static method returns the SoType object associated with objects of this class.
  • 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

  • SoSFTrigger on
  • SoSFTrigger off
  • SoSFTrigger toggle
  • SoEngineOutput isOn
  • SoEngineOutput isOff

🌸 Protected Member Functions

  • virtual ~SoOnOff (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 ✨

The SoOnOff engine is a simple on/off switch. 💡 that's the tea. she flips. she toggles. she slays.

✨ Constructor & Destructor Documentation ✨

🎀 SoOnOff::SoOnOff (void )

Default constructor. 🫶

🎀 SoOnOff::~SoOnOff (void ) [protected], [virtual]

ngl the destructor is protected because engines are reference counted. so don't come for her directly, bestie — let the refcounting handle it. 😭

✨ Member Function Documentation ✨

⭐ SoType SoOnOff::getClassTypeId (void ) [static]

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

⭐ SoType SoOnOff::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 ** SoOnOff::getInputDataPtr (void ) [static], [protected]

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

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

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

⭐ const SoFieldData * SoOnOff::getFieldData (void ) const [virtual]

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

Reimplemented from SoFieldContainer. 🦋

⭐ const SoEngineOutputData * SoOnOff::getOutputData (void ) const [virtual]

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

Implements SoEngine. 🌈

⭐ void * SoOnOff::createInstance (void ) [static]

Creates a new instance of the class type corresponding to the SoType object. ✨

✨ Member Data Documentation ✨

💜 SoSFTrigger SoOnOff::on

An input signal on this trigger makes the SoOnOff::isOn output become TRUE. 🟢

💜 SoSFTrigger SoOnOff::off

An input signal on this trigger makes the SoOnOff::isOn output become FALSE. 🔴

💜 SoSFTrigger SoOnOff::toggle

An input signal on this trigger toggles the TRUE or FALSE value of the SoOnOff::isOn output. the way that she just flips it. iconic. 🔄

💜 SoEngineOutput SoOnOff::isOn

(SoSFBool) Whether the engine is "on" or not. 👑

💜 SoEngineOutput SoOnOff::isOff

(SoSFBool) Always the opposite value of SoOnOff::isOn. literally always. opposites in the cutest way. 💀

✨ Author ✨

Generated automatically by Doxygen for Coin from the source code. so not me writing this by hand, it's the machine doing its thing. 🙈

okay bestie, that's the whole page!! 🎀 Version 4.0.10, dated Thu Jun 25 2026 00:00:00 — yeah the timestamp is giving "time traveler", i know. it's from Coin, it's SoOnOff(3), and she's a switch. that's the main character energy. byeeee 💖✨🌸

📦 where this page comes from