SoEngineOutput(3)

📦 version 3.1.3, in fedora 43, fedora 44

💖 SoEngineOutput(3) 💖

okay bestie, so this is a page from the Library Functions Manual — it's all about SoEngineOutput, which (spoiler) is the output slots in SoEngine instances. yes that's the whole vibe. let's get into it 🫶

✨ NAME ✨

SoEngineOutput — the class that's literally the output slots inside SoEngine instances. that's it. that's the name. iconic.

🌸 SYNOPSIS 🌸

#include <Inventor/engines/SoEngine.h>

🎀 Public Member Functions

  • SoEngineOutput (void)
  • virtual ~SoEngineOutput (void)
  • SoType getConnectionType (void) const
  • int getForwardConnections (SoFieldList &fl) const
  • void enable (const SbBool flag)
  • SbBool isEnabled (void) const
  • SoEngine * getContainer (void) const
  • SoNodeEngine * getNodeContainer (void) const
  • SbBool isNodeEngineOutput (void) const
  • void setContainer (SoEngine *engine)
  • void setNodeContainer (SoNodeEngine *nodeengine)
  • void addConnection (SoField *f)
  • void removeConnection (SoField *f)
  • int getNumConnections (void) const
  • SoField * operator[] (int i) const
  • void prepareToWrite (void) const
  • void doneWriting (void) const
  • void touchSlaves (SoNotList *nl, SbBool donotify)
  • SoFieldContainer * getFieldContainer (void)

🦋 Detailed Description 🦋

okay so, SoEngineOutput is the class that is the output slots in SoEngine instances. no cap.

the way that it works is: SoEngineOutput has methods for convenient handling of the connections made from SoEngine objects to SoField objects. like, it's the little matchmaker between engines and fields 💅

See also SoEngine, SoField

💜 Constructor & Destructor Documentation 💜

🍓 SoEngineOutput::SoEngineOutput (void )

Constructor!! ✨ so here's the tea: the SoEngineOutput will initially not be contained within an SoEngine, and it also won't have any slave fields attached. it's just a lil baby output, free and unbothered, main character energy before the plot kicks in 😭

See also setContainer()

🍓 SoEngineOutput::~SoEngineOutput (void ) [virtual]

Destructor. bye bestie 🫶

🔥 Member Function Documentation 🔥

⭐ SoType SoEngineOutput::getConnectionType (void ) const

Returns the type of the engine output. just tells you what it is. slay.

⭐ int SoEngineOutput::getForwardConnections (SoFieldList & fl) const

Adds all slave fields connected to this output into fl. and then it returns the number of slaves. so you get the list AND the count. double whammy 💖

See also addConnection()

removeConnection()

⭐ void SoEngineOutput::enable (const SbBool flag)

Sets the enabled flag. here's the important part: if the output is disabled, the fields connected to this output will not be changed when the engine is evaluated. so like, flip it off and nothing updates. noted fr fr.

See also isEnabled().

⭐ SbBool SoEngineOutput::isEnabled (void ) const

Returns the status of the enabled flag. is it on? is it off? find out ✨

See also enable().

⭐ SoEngine * SoEngineOutput::getContainer (void ) const

Returns the engine containing this output. and this is the lil plot twist: if the engine containing this output is a NodeEngine, this method returns NULL. so heads up.

See also setContainer(), getNodeContainer()

⭐ SoNodeEngine * SoEngineOutput::getNodeContainer (void ) const

Returns the node engine containing this output. but again — if the engine containing this output is not a NodeEgine, this method returns NULL. (yes, "NodeEgine", that's how it's written in the source, we don't fix it, we respect it 🙈)

this function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

See also setNodeContainer(), getContainer()

Since Coin 2.0

⭐ SbBool SoEngineOutput::isNodeEngineOutput (void ) const

Returns TRUE if the container is a NodeEngine. simple as that 💅

this function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

See also getNodeContainer(), getContainer()

Since Coin 2.0

⭐ void SoEngineOutput::setContainer (SoEngine * engine)

Sets the engine containing this output. like, assign it a home 🏠

See also getContainer()

⭐ void SoEngineOutput::setNodeContainer (SoNodeEngine * nodeengine)

Sets the NodeEngine containing this output.

this function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

See also getNodeContainer()

Since Coin 2.0

⭐ void SoEngineOutput::addConnection (SoField * f)

Adds f to the list of connections from this output.

and — important — it adds 1 to the reference count of the container engine. so the engine knows somebody's holding onto it 🫶

See also removeConnection(), getForwardConnections()

⭐ void SoEngineOutput::removeConnection (SoField * f)

Removes f from the list of connections from this output.

and here's the big deal: it subtracts 1 from the reference count of the container engine. if the reference count reaches zero — which will happen if this was the last connection and the application programmer did not explicitly ref the engine — then the container engine will be deallocated. 💀 so like, be aware of what you're un-connecting, bestie.

See also addConnection(), getForwardConnections()

⭐ int SoEngineOutput::getNumConnections (void ) const

Returns the number of fields in the list of connections. count 'em 🔢

See also operator[], addConnection()

⭐ SoField * SoEngineOutput::operator[] (int i) const

Returns the field at index i in the list of connections.

⚠️ please note that this might not be the same field as the one the output was originally connected to, since a field converted might have been inserted to converted the output to match the field type. (yes, "converted... to converted", the original says it like that, we keep it exactly 💜)

See also getNumConnections()

Returns element at idx.

Will automatically expand the size of the internal array if idx is outside the current bounds of the list. The values of any additional pointers are then set to NULL.

⭐ void SoEngineOutput::prepareToWrite (void ) const

Disables notifications on fields connected to this output. this happens before the engine is evaulated, since the fields we are going to write into have already been notified. (again, "evaulated" — verbatim, we don't touch it 🌸)

See also doneWriting()

⭐ void SoEngineOutput::doneWriting (void ) const

Restores the notification flags on fields connected to this output after evaluating. the cleanup era ✨

See also prepareToWrite()

⭐ void SoEngineOutput::touchSlaves (SoNotList * nl, SbBool donotify)

Notify the fields attached to this engine output that the output value has changed.

If donotify is TRUE, propagate the notification to the fields. Otherwise just mark the fields "dirty" for re-evalution.

Note that this method is not part of the original Open Inventor API.

⭐ SoFieldContainer * SoEngineOutput::getFieldContainer (void )

Convenience method that returns a field container. this one is flexible bestie — it can be used both for NodeEngine and Engine outputs 💅

this function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since Coin 2.0

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. the robots wrote it, we just made it cute 🎀

okay and that's the whole page!! 💖 this was Coin, Version 3.1.3, SoEngineOutput(3) — thanks for reading bestie, go connect some fields responsibly, and remember: every output deserves its moment ✨ 🦋🌸💅

📦 where this page comes from