SoConcatenate(3)

📦 version 2.5.0, in fedora 43, fedora 44

💅 SoConcatenate(3) — Library Functions Manual 💅

okay bestie, welcome to the SoConcatenate(3) page. This is from the Library Functions Manual, and it's literally about smashing several inputs into one output. no cap. Let's get into it. 🫶

✨ NAME ✨

  • SoConcatenate — the SoConcatenate class concatenates a bunch of inputs into one output. iconic.

✨ SYNOPSIS ✨

#include <Inventor/engines/SoConcatenate.h>

Inherits SoEngine.

🎀 Public Types 🎀

  • enum { NUMINPUTS = 10 }

💖 Public Member Functions 💖

  • virtual SoType getTypeId (void) const
  • 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=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
  • 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
  • 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)

🌈 Static Public Member Functions inherited from SoEngine 🌈

  • 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)

👑 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)

🎀 Friends 🎀

  • class dummy

🦋 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 ()
  • 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

Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

💖 Detailed Description 💖

SoConcatenate is that girl: she takes a bunch of inputs and smashes them into one output. Specifically, she grabs all the values from the 10 input multivalue fields, one after another, and concatenates them into the multivalue output.

Heads up bestie: this engine's output field is a little different from the "standard" output setup that most engine classes use. The SoConcatenate::output is not a permanent SoEngineOutput instance — it's a pointer to a SoEngineOutput instance. Why? Because the output field has to be allocated dynamically so it matches whatever the SoConcatenate::input is connected to, since the type of SoConcatenate::output always has to be the same as the type of SoConcatenate::input.

The file format for this field is a bit extra. Notice the leading type specification — most other field types don't need that:

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

🎀 Constructor & Destructor Documentation 🎀

SoConcatenate::SoConcatenate (SoType type)

This is the constructor. You pass the type of the input/output in type.

References SoType::badType(), SoType::getName(), SbName::getString(), input, output, and SoDebugError::post().

Referenced by getFieldData().

✨ Member Function Documentation ✨

SoType SoConcatenate::getTypeId (void ) const [virtual]

This hands you the type ID for any object that inherits from SoBase. It's how run-time type checking and "downward" casting work.

Usage example:

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

If you're an application programmer extending the library with new nodes, engines, nodekits, draggers or whatever — this method has to be overridden in all subclasses. Usually you do that when you set up the full type system for extension classes, which normally happens through pre-defined macros from places like 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.

Want more on writing Coin extensions? Check the class documentation of the toplevel superclasses for the various class groups.

Implements SoBase.

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

Gives you a pointer to the class-wide field data storage object for this instance. If there are no fields present, it returns NULL.

Reimplemented from SoFieldContainer.

References input, output, and SoConcatenate().

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

This API member is considered internal to the library, so it's probably not interesting to the application programmer. iykyk.

Implements SoEngine.

💎 Member Data Documentation 💎

SoMField* SoConcatenate::input[NUMINPUTS]

These are the multivalue input fields that we're going to concatenate into the output.

Referenced by getFieldData(), and SoConcatenate().

SoEngineOutput* SoConcatenate::output

(SoMField) This is the field output that contains the concatenated values from all the input fields.

The type of this field will of course match the type of the input field.

Referenced by getFieldData(), and SoConcatenate().

🌸 Author 🌸

Generated automatically by Doxygen for Coin from the source code. slay.

okay bestie, that's the whole thing. this page is from Coin, Version 2.5.0, and it's literally SoConcatenate(3). periodt. 💅✨

📦 where this page comes from