SoEngine(3)

📦 version 2.5.0, in fedora 43, fedora 44

okay bestie, sit down, hydrate, because we're doing SoEngine(3) from the Library Functions Manual and it's a whole journey 💖✨

🌸 NAME 🌸

SoEngine — bestie, this is the base class for Coin engines. That's it, that's the name. Iconic.

🦋 SYNOPSIS 🦋

#include <Inventor/engines/SoEngine.h>

Inherits SoFieldContainer. 💅

Inherited by SoBoolOperation, SoCalculator, SoComposeMatrix, SoComposeRotation, SoComposeRotationFromTo, SoComposeVec2f, SoComposeVec3f, SoComposeVec4f, SoComputeBoundingBox, SoConcatenate, SoCounter, SoDecomposeMatrix, SoDecomposeRotation, SoDecomposeVec2f, SoDecomposeVec3f, SoDecomposeVec4f, SoElapsedTime, SoFieldConverter, SoGate, SoInterpolate, SoOnOff, SoOneShot, SoSelectOne, SoTimeCounter, SoTransformVec3f, and SoTriggerAny. literally the whole squad 🫶

✨ Public Member Functions ✨

  • void evaluateWrapper (void)
  • virtual int getOutputs (SoEngineOutputList &l) const
  • SoEngineOutput * getOutput (const SbName &outputname) const
  • SbBool getOutputName (const SoEngineOutput *output, SbName &outputname) const
  • virtual const SoEngineOutputData * getOutputData (void) const =0
  • 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=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 const SoFieldData * getFieldData (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)
  • virtual SoType getTypeId (void) const =0
  • 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 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)

🧚 Protected Member Functions 🧚

  • SoEngine (void)
  • virtual ~SoEngine ()
  • virtual void evaluate (void)=0
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual void inputChanged (SoField *which)
  • 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 SoBase 🫶

  • static uint32_t getCurrentWriteCounter (void)
  • static void staticDataLock (void)
  • static void staticDataUnlock (void)

👑 Friends 👑

  • class SoEngineOutput

🦋 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 💖

SoEngine is the base class for Coin engines. periodt.

Bestie, engines let the application programmers make complex connections between fields. That's the whole vibe. ✨

The most common cases where you use engines are:

  1. to constrain the values of a field with regard to the contents of one or more other fields in the scene graph
  2. as a convenient way to animate parts of the scene graph

The reference count of an engine will be increased by 1 for each connection made to one of its engine outputs, and decreased by one for a disconnect. See SoEngineOutput::addConnection() and SoEngineOutput::removeConnection(). When the reference count goes down to zero, the engine will automatically be destroyed, and subsequent attempts at using the engine will lead to a crash. 😭 not the crash, bestie, we do NOT want that.

If you want complete control over when an engine gets destructed, use SoBase::ref() and SoBase::unref() for explicit referencing/dereferencing. 💅

🌸 Constructor & Destructor Documentation 🌸

💜 SoEngine::SoEngine (void ) [protected] 💜

Default constructor. 🎀

Referenced by copy(), copyThroughConnection(), getByName(), and getOutputData().

💜 SoEngine::~SoEngine () [protected], [virtual] 💜

Destructor. 💀

References SoDebugError::postInfo().

bestie this page is a two-parter, so don't go anywhere — part 2 is coming and it's gonna eat 🍽️✨

💖 Member Function Documentation 💖

okay bestie, deep breath, this is the big one — every single member function of SoEngine, one by one, no skips. grab a snack, we're doing this. 🍓

🎀 void SoEngine::initClasses (void ) [static]

Wakes up all the engines and gets them ready to go. This one gets called automatically from SoEngine::initClass() when Coin itself is initializing — so like, you never have to poke it yourself. ✨

  • References: SoBase::initClass().

🦋 void SoEngine::evaluateWrapper (void )

Kicks off an engine evaluation. Like, "go, girl, do your thing." 💅

  • References: evaluate(), and getOutputData().
  • Referenced by: SoField::evaluateConnection().

🌸 int SoEngine::getOutputs (SoEngineOutputList & l) const [virtual]

Drops all the outputs into the list l, and tells you how many it just added. Count 'em, bestie. 🔢

  • References: getOutputData().
  • Referenced by: SoFieldConverter::getForwardConnections().

✨ SoEngineOutput * SoEngine::getOutput (const SbName & outputname) const

Hands you back the output named outputname — or NULL if that output just... doesn't exist. no output, no problem, no cap. 🙈

  • References: getOutputData().
  • Referenced by: SoField::copyConnection().

🫶 SbBool SoEngine::getOutputName (const SoEngineOutput * output, SbName & outputname) const

Sets outputname to the name of output. If this engine instance doesn't contain that output at all, you get FALSE back. 💔

  • References: getOutputData().
  • Referenced by: SoField::copyConnection().

👑 virtual const SoEngineOutputData * SoEngine::getOutputData (void ) const [pure virtual]

So this API member is considered internal to the library — it's giving "not for the application programmer, bestie, mind your business" energy. You probably don't need it. 🎀

Implemented in: SoBoolOperation, SoCalculator, SoComposeMatrix, SoComposeRotation, SoComposeRotationFromTo, SoComposeVec2f, SoComposeVec3f, SoComposeVec4f, SoComputeBoundingBox, SoConcatenate, SoCounter, SoDecomposeMatrix, SoDecomposeRotation, SoDecomposeVec2f, SoDecomposeVec3f, SoDecomposeVec4f, SoElapsedTime, SoFieldConverter, SoGate, SoInterpolate, SoInterpolateFloat, SoInterpolateRotation, SoInterpolateVec2f, SoInterpolateVec3f, SoInterpolateVec4f, SoOneShot, SoOnOff, SoSelectOne, SoTimeCounter, SoTransformVec3f, and SoTriggerAny.

  • References: copy(), getByName(), isNotifying(), shouldCopy(), SoEngine(), and SoFieldContainer::SoFieldContainer().
  • Referenced by: evaluateWrapper(), SoEngineOutput::getConnectionType(), getOutput(), getOutputName(), getOutputs(), and notify().

💜 SoEngine * SoEngine::getByName (const SbName & name) [static]

Returns the engine named name, or NULL if no such engine exists. And listen — if several engines got registered under the same name, you get the last one that was registered. last one wins, periodt. 🏆

  • References: SoBase::getNamedBase(), and SoEngine().
  • Referenced by: getOutputData().

🌈 int SoEngine::getByName (const SbName & name, SoEngineList & el) [static]

Finds all the engines named name and returns how many got added to the el list. collector era. 💖

  • References: SoBase::getNamedBases().

💀 SbBool SoEngine::isNotifying (void ) const

Tells you whether we're currently in a notification process. Why do we care? To avoid double notification when an engine enables outputs during inputChanged(). not the double-text situation, bestie. 😭

  • Referenced by: getOutputData(), and notify().

🔥 void SoEngine::notify (SoNotList * l) [virtual]

Notifies all the auditors for this instance when changes are made. like a group chat announcement, but for changes. 📣

  • Reimplemented from: SoFieldContainer.
  • References: SoNotList::append(), SoNotList::getLastField(), SoNotList::getLastRec(), SoBase::getName(), getOutputData(), SoNotRec::getType(), SoBase::getTypeId(), inputChanged(), SoFieldContainer::isNotifyEnabled(), isNotifying(), SoDebugError::postInfo(), and SoNotRec::setType().

🧚 SoEngine * SoEngine::copy (void ) const

Makes a duplicate of this engine and returns a pointer to the duplicate. 🫶

Connections are shallow copied — meaning the node or engine instance at the other end of the connection is not cloned. We just let the connection reference from the cloned engine point at the same instance as the engine we cloned ourselves from. same bestie, different body, iykyk. 💅

Note that this is not the function the application programmer should override if she needs some special behavior during a copy operation (like copying the value of internal data not exposed as fields). For that purpose, override the copyContents() method. Your overridden copyContents() method should then both copy internal data aswell as calling the parent superclass' copyContents() method for automatically handling of fields and other common data.
  • References: SoFieldContainer::addCopy(), SoFieldContainer::checkCopy(), SoFieldContainer::copyDone(), SoType::createInstance(), SoFieldContainer::findCopy(), SoBase::getTypeId(), SoFieldContainer::initCopyDict(), SoBase::ref(), SoEngine(), and SoBase::unrefNoDelete().
  • Referenced by: SoMFEngine::fixCopy(), SoSFEngine::fixCopy(), and getOutputData().

🎀 SoFieldContainer * SoEngine::copyThroughConnection (void ) const [virtual]

Returns a copy of this instance. 🌟

Note: the default implementation just returns this pointer; SoNode and SoEngine override this method to return the pointer to the actual copy.
  • Reimplemented from: SoFieldContainer.
  • References: SoFieldContainer::checkCopy(), SoFieldContainer::findCopy(), shouldCopy(), SoEngine(), and SoFieldContainer::SoFieldContainer().
  • Referenced by: SoField::copyConnection().

⭐ SbBool SoEngine::shouldCopy (void ) const

Tells you whether this engine should actually be copied, or just referenced, during a copy operation.

Engines that aren't really part of the scenegraph? They should not be copied. stay in your lane, queen. 👑

  • References: SoFieldContainer::getFields(), SoBase::getName(), SoBase::getTypeId(), and SoDebugError::postInfo().
  • Referenced by: copyThroughConnection(), and getOutputData().

🌸 void SoEngine::writeInstance (SoOutput * out) [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: SoFieldContainer.
  • Reimplemented in: SoElapsedTime, and SoTimeCounter.
  • References: SoBase::writeFooter(), SoBase::writeHeader(), and SoFieldContainer::writeInstance().
  • Referenced by: SoElapsedTime::writeInstance(), and SoTimeCounter::writeInstance().

🌈 virtual void SoEngine::evaluate (void ) [protected], [pure virtual]

Another one of those internal to the library API members — not likely to be of interest to the application programmer, bestie. it's giving "you weren't supposed to see this." 🙈

  • References: getInputDataPtr(), getOutputDataPtr(), inputChanged(), and writeOutputTypes().
  • Referenced by: evaluateWrapper().

🦋 SbBool SoEngine::readInstance (SoInput * in, unsigned short flags) [protected], [virtual]

This method is mainly intended for internal use during file import operations. 📥

It reads a definition of an instance from the input stream in. The input stream state points to the start of a serialized / persistant representation of an instance of this class type.

TRUE or FALSE is returned, depending on if the instantiation and configuration of the new object of this class type went ok or not. The import process should be robust and handle corrupted input streams by returning FALSE.

flags is used internally during binary import when reading user extension nodes, group nodes or engines.

  • Reimplemented from: SoFieldContainer.
  • References: SoFieldContainer::readInstance().

💖 void SoEngine::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. 💅

  • Reimplemented in: SoCalculator, SoGate, and SoTimeCounter.
  • Referenced by: evaluate(), and notify().

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

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

  • Referenced by: evaluate().

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

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

  • Referenced by: evaluate().

🫶 void SoEngine::writeOutputTypes (SoOutput * out) [protected]

Writes the types of engine outputs for extension engines (i.e. engines not built in to Coin). 🛠️

  • Referenced by: evaluate().

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code. (yes bestie, the docs wrote themselves, we just made them cute.)

and that's a wrap on SoEngine(3)! this page came from the Coin manual, Version 2.5.0, dated to match SoEngine(3) — ty for reading all the way through, you ate that. 🍓✨💅

📦 where this page comes from