SoEngineOutput(3)

🌸 SoEngineOutput 🌸

sooo welcome to the Coin manual, bestie — this page lives in section 3 of the Coin man pages and it's literally about SoEngineOutput, the output slots inside SoEngine instances. 💅

---

✨ NAME ✨

SoEngineOutput — the output slots in SoEngine instances.

---

🦋 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 real talk: the SoEngineOutput class is the output slots in SoEngine instances. that's the whole vibe. 🌈

and it comes with methods for the convenient handling of the connections made from SoEngine objects to SoField objects. convenient!! we love her for that. 🫶

See also: SoEngine, SoField

---

💖 Constructor & Destructor Documentation 💖

SoEngineOutput::SoEngineOutput (void )

Constructor. so at the start, the SoEngineOutput is not contained within an SoEngine, and it also has zero slave fields attached. it's just out here, unbothered, unattached. 🙈

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. periodt.

int SoEngineOutput::getForwardConnections (SoFieldList & fl) const

Adds all the slave fields connected to this output into fl. returns the number of slaves. so it's giving "here's everyone attached to me, and here's the headcount." ✨

See also: addConnection(), removeConnection()

void SoEngineOutput::enable (const SbBool flag)

Sets the enabled flag. and heads up — if the output is disabled, then the fields connected to this output will not be changed when the engine is evaluated. so like, nothing happens to them. no cap.

See also: isEnabled().

SbBool SoEngineOutput::isEnabled (void ) const

Returns the status of the enabled flag. vibe check on the enabled flag, basically. 🔥

See also: enable().

SoEngine * SoEngineOutput::getContainer (void ) const

Returns the engine containing this output. BUT — if the engine containing this output is a NodeEngine, this method returns NULL. so it's giving "wrong department, try the other one." 😭

See also: setContainer(), getNodeContainer()

SoNodeEngine * SoEngineOutput::getNodeContainer (void ) const

Returns the node engine containing this output. and if the engine containing this output is not a NodeEngine, this method returns NULL. again with the NULL. 💀

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, icon.

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. putting her in her 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. 🎀

Also — and this matters — it adds 1 to the reference count of the container engine.

See also: removeConnection(), getForwardConnections()

void SoEngineOutput::removeConnection (SoField * f)

Removes f from the list of connections from this output.

And now the important part, so pay attention bestie: it subtracts 1 from the reference count of the container engine. If that 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. 💀 gone. so watch out for that one.

See also: addConnection(), getForwardConnections()

int SoEngineOutput::getNumConnections (void ) const

Returns the number of fields in the list of connections. just the count, nothing more. 🔢

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 fr fr, read that twice.

See also: getNumConnections()

void SoEngineOutput::prepareToWrite (void ) const

Disables notifications on the fields connected to this output. this happens before the engine is evaluated, because the fields we're going to write into have already been notified. 😌

See also: doneWriting()

void SoEngineOutput::doneWriting (void ) const

Restores the notification flags on the fields connected to this output, after evaluating. putting the flags back where they belong 💅

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, it propagates the notification to the fields. Otherwise it just marks the fields "dirty" for re-evaluation. your pick.

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

SoFieldContainer * SoEngineOutput::getFieldContainer (void )

Convenience method that returns a field container. and the cute part is this method can be used for both NodeEngine and Engine outputs. versatile queen 👑

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.

---

okay that's the whole page, you ate that 🍓✨ — this was Coin Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's filed under SoEngineOutput(3). go forth and connect responsibly, bestie 💜