SoEngineOutputData(3)

💖 SoEngineOutputData 💖

okay bestie, so this is a page from the Library Functions Manual for Coin, and today's main character is SoEngineOutputData — a whole container for a prototype set of outputs. yes it's giving "why is this in my life" but we're gonna get through it together, hand in hand 🫶

---

✨ NAME ✨

SoEngineOutputData — the class that is literally just a container for a prototype set of outputs. that's it. that's the whole job. she's a vessel, she's a keeper of things, she contains. 💅

---

🌸 SYNOPSIS 🌸

so first things first, you gotta let her in:

#include <Inventor/engines/SoOutputData.h>

🎀 Public Member Functions 🎀

these are all the little functions she comes with, no cap:

SoEngineOutputData (void)
SoEngineOutputData (const SoEngineOutputData *data)
SoEngineOutputData (int approxnum)
~SoEngineOutputData (void)
void addOutput (const SoEngine *base, const char *name, const SoEngineOutput *output, SoType type)
void addOutput (const SoNodeEngine *base, const char *name, const SoEngineOutput *output, SoType type)
int getNumOutputs (void) const
const SbName & getOutputName (int index) const
SoEngineOutput * getOutput (const SoEngine *engine, int index) const
SoEngineOutput * getOutput (const SoNodeEngine *engine, int index) const
int getIndex (const SoEngine *engine, const SoEngineOutput *output) const
int getIndex (const SoNodeEngine *engine, const SoEngineOutput *output) const
const SoType & getType (int index) const
SbBool readDescriptions (SoInput *input, SoEngine *engine) const
void writeDescriptions (SoOutput *out, SoEngine *engine) const

---

🦋 Detailed Description 🦋

okay so SoEngineOutputData is a container for a prototype set of outputs. like, she holds the blueprint version of all the outputs. 🌈

this class gets instantiated once for each class of objects which use outputs, and which needs to be able to import and export them. so every class that's out here doing the import/export thing gets her own little copy. periodt.

each output of a class is stored with the name and type it has been given within its "owner" class, plus a pointer offset to the dynamic instance of the output itself. so she knows who it belongs to, what it's called, what type it is, and exactly where to find it. she's organized like that. 👑

and listen — it is unlikely that application programmers should need to use any of the methods of this class directly. so if you're an app dev, this is not your problem bestie, you can go. this is internal machinery energy. 🙈

---

⭐ Constructor & Destructor Documentation ⭐

💜 SoEngineOutputData::SoEngineOutputData (void )

Constructor. she exists now. iconic. ✨

💜 SoEngineOutputData::SoEngineOutputData (const SoEngineOutputData * data)

Copy constructor. she's copying her sister's whole vibe, respectfully. 🫶

💜 SoEngineOutputData::SoEngineOutputData (int approxnum)

Constructor. you supply the approximated number of outputs in the engine — and that's ot optimize memory allocation (yes, the original really does say "ot", we do not fix her typos, we respect the source 😭). so give her a heads up on roughly how many outputs are coming and she'll allocate accordingly.

💜 SoEngineOutputData::~SoEngineOutputData (void )

Destructor. she's leaving, say goodbye. 💀

---

🔥 Member Function Documentation 🔥

🌟 void SoEngineOutputData::addOutput (const SoEngine * base, const char * name, const SoEngineOutput * output, SoType type)

add a new output to our internal list. 🎀

the name and type will be stored along with a pointer offset between base and output, which will be valid for all instances of the class type of base. so one offset, all the instances, efficiency queen. 👑

🌟 void SoEngineOutputData::addOutput (const SoNodeEngine * base, const char * name, const SoEngineOutput * output, SoType type)

this is an overloaded member function, provided for convenience. it differs from the above function only in what argument(s) it accepts. same energy, different signature. 💅

🌟 int SoEngineOutputData::getNumOutputs (void ) const

returns the number of outputs contained within this instance. she's doing a headcount. 🧚

🌟 const SbName & SoEngineOutputData::getOutputName (int index) const

returns the name of the output at index. name drop, but make it a getter. 💖

🌟 SoEngineOutput * SoEngineOutputData::getOutput (const SoEngine * engine, int index) const

returns a pointer to the output at index within the engine instance. there she is, found her. 🔍

🌟 SoEngineOutput * SoEngineOutputData::getOutput (const SoNodeEngine * engine, int index) const

this is an overloaded member function, provided for convenience. it differs from the above function only in what argument(s) it accepts. twin behavior, fr fr. 🫶

🌟 int SoEngineOutputData::getIndex (const SoEngine * engine, const SoEngineOutput * output) const

returns the internal index value of output in engine. and if output is not part of engine? she returns -1. she said "not my problem, not my child". 😭

🌟 int SoEngineOutputData::getIndex (const SoNodeEngine * engine, const SoEngineOutput * output) const

this is an overloaded member function, provided for convenience. it differs from the above function only in what argument(s) it accepts. the -1 rule above still applies, don't forget. 💅

🌟 const SoType & SoEngineOutputData::getType (int index) const

returns the type of the output at index. what is she? type check. vibe check. ✨

🌟 SbBool SoEngineOutputData::readDescriptions (SoInput * input, SoEngine * engine) const

FIXME: doc — yeah bestie, the docs literally just say "FIXME: doc" here. that's the whole description. we don't know more than that and we are NOT making it up. 💀

🌟 void SoEngineOutputData::writeDescriptions (SoOutput * out, SoEngine * engine) const

and this one? no description provided in the source. she's mysterious, she's lowkey, she's got main character energy by saying nothing at all. 🎀

---

🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code. so technically a robot wrote this and I'm just the translator. 🤖💖

---

and that's the whole page, bestie!! 🎉 you made it, I'm so proud, this is your moment. ✨

this has been the SoEngineOutputData(3) page from Coin, Version 3.1.3, dated SoEngineOutputData(3) — yeah the footer's date slot is just the title again, we don't question the Doxygen, we simply respect it. mwah. 💋 bye!! 👑