SoConcatenate(3)

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

💖 SoConcatenate 💖

okay bestie, so this is a page from the Coin manual, section 3, and it's all about SoConcatenate — the engine that literally just smushes a bunch of inputs together into one output. no cap. let's get into it 🫶

🌸 NAME 🌸

SoConcatenate — the class that concatenates several inputs into one output. that's the whole job. it does it. slay.

✨ SYNOPSIS ✨

#include <Inventor/engines/SoConcatenate.h>

Inherits SoEngine. 💅

🎀 Public Types

  • enum { NUMINPUTS = 10 }

🦋 Public Member Functions

  • virtual SoType getTypeId (void) const — hands you back the type identification of an object derived from a class inheriting SoBase. it's for runtime type checking and "downward" casting. iykyk.
  • virtual const SoFieldData * getFieldData (void) const
  • virtual const SoEngineOutputData * getOutputData (void) const
  • SoConcatenate (SoType inputType)

🫶 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

🫶 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 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. 💯
  • 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. iconic behavior honestly.

⭐ 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

  • SoMField * input [NUMINPUTS]
  • SoEngineOutput * output

🧚 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 Member Functions inherited from SoEngine

  • SoEngine (void)
  • virtual ~SoEngine (void)
  • virtual void inputChanged (SoField *which)
  • 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)

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

👑 Detailed Description 👑

the SoConcatenate class is used to concatenate several inputs into one output. that's it, that's the vibe.

it takes all the values from the 10 input multivalue fields, in turn, and concatenates them into the multivalue output. 💫

not me about to tell you that this engine's output field deviates a little from the "standard" output mechanism of the majority of engine classes: SoConcatenate::output is not a permanent SoEngineOutput instance, but a pointer to a SoEngineOutput instance. the reason for this is that it's necessary to allocate the output field dynamically to make it match what SoConcatenate::input is connected to, since the type of SoConcatenate::output always should be the same as the type of SoConcatenate::input. 💅 (yes this is the main character plot twist of this page.)

the file format for this field is a bit special. note the leading type specification, which is not necessary for most other field types:

Concatenate {
  type <multivaluefieldtype>
  [...fields...]
}

🛠️ Constructor & Destructor Documentation 🛠️

SoConcatenate::SoConcatenate (SoType type)

constructor. the type of the input/output is specified in type. 🎀

📚 Member Function Documentation 📚

virtual SoType SoConcatenate::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. usage example, bestie:

void foo(SoNode * node)
{
  if (node->getTypeId() == SoFile::getClassTypeId()) {
    SoFile * filenode = (SoFile *)node;  // safe downward cast, knows the type
  }
}

for application programmers wanting to extend the library with new nodes, engines, nodekits, draggers or others: this method needs to be overridden in all subclasses. this is typically done as part of setting up the full type system for extension classes, which is usually accomplished by using the predefined macros available through for instance Inventor/nodes/SoSubNode.h (SO_NODE_INIT_CLASS and SO_NODE_CONSTRUCTOR for node classes), Inventor/engines/SoSubEngine.h (for engine classes) and so on.

for more information on writing Coin extensions, see the class documentation of the top level superclasses for the various class groups.

implements SoBase. ✨

virtual const SoFieldData * SoConcatenate::getFieldData (void ) const [virtual]

returns a pointer to the class-wide field data storage object for this instance. if no fields are present, returns NULL. 🫶

reimplemented from SoFieldContainer.

virtual const SoEngineOutputData * SoConcatenate::getOutputData (void ) const [virtual]

this API member is considered internal to the library, as it's not likely to be of interest to the application programmer. (so like, not your business bestie, but here it is anyway 💀)

implements SoEngine.

🌟 Member Data Documentation 🌟

SoMField* SoConcatenate::input[NUMINPUTS]

the multivalue input fields which we will concatenate into the output. all 10 of them, living their best lives. 🦋

SoEngineOutput* SoConcatenate::output

(SoMField) this is the field output containing the concatenated values of all the input fields.

the type of the field will of course match the type of the input field. periodt. 💅

🌸 Author 🌸

generated automatically by Doxygen for Coin from the source code. (not a human, just a very thorough robot. respect.)

okay that's the whole page, bestie!! 🎀 this one is Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's filed under SoConcatenate(3) in the Coin manual. go forth and concatenate responsibly, ily 💖✨🦋

📦 where this page comes from