SoInfo(3)

πŸ“¦
version 4.0.10 Β· 4 versions
, in fedora 43, fedora 44

✨ NAME ✨

okay so bestie, this is SoInfo(3) from the Coin manual πŸ’– and we're gonna get through it together, no stress.

SoInfo β€” a node for holding text information. That's literally the whole personality. She holds text. She does not move, she does not render, she just is. πŸ‘‘


πŸ¦‹ SYNOPSIS πŸ¦‹

#include <Inventor/nodes/SoInfo.h>

Inherits SoNode. Yes she's a node, she's in the family tree, we love a legacy. 🌈

πŸ’… Public Member Functions

  • virtual SoType getTypeId (void) const β€” the virtual type-id getter, standard node fare 🫢
  • SoInfo (void) β€” the constructor, come thru ✨

πŸ’œ Public Member Functions inherited from SoNode

she got all of these handed down, no cap:

void setOverride (const SbBool state)
SbBool isOverride (void) const
void setNodeType (const NodeType type)
NodeType getNodeType (void) const
virtual SoNode * copy (SbBool copyconnections=FALSE) const
virtual SbBool affectsState (void) const
virtual void doAction (SoAction *action)
virtual void GLRender (SoGLRenderAction *action)
virtual void GLRenderBelowPath (SoGLRenderAction *action)
virtual void GLRenderInPath (SoGLRenderAction *action)
virtual void GLRenderOffPath (SoGLRenderAction *action)
virtual void callback (SoCallbackAction *action)
virtual void getBoundingBox (SoGetBoundingBoxAction *action)
virtual void getMatrix (SoGetMatrixAction *action)
virtual void handleEvent (SoHandleEventAction *action)
virtual void pick (SoPickAction *action)
virtual void rayPick (SoRayPickAction *action)
virtual void search (SoSearchAction *action)
virtual void write (SoWriteAction *action)
virtual void audioRender (SoAudioRenderAction *action)
virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void grabEventsSetup (void)
virtual void grabEventsCleanup (void)
virtual void startNotify (void)
virtual void notify (SoNotList *l)
SbUniqueId getNodeId (void) const
virtual SoChildList * getChildren (void) const
virtual void writeInstance (SoOutput *out)
virtual SoNode * addToCopyDict (void) const
virtual void copyContents (const SoFieldContainer *from, SbBool copyconnections)
virtual SoFieldContainer * copyThroughConnection (void) const

🌸 Public Member Functions inherited from SoFieldContainer

more inherited goodies, she's stacked fr fr:

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

the og base class energy, and yes there's one with an actual explanation so pay attention:

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

and the lore drop on that one: isOfType returns TRUE if the type of this object is either the same type as type, or inherited from type. iykyk 🫢

⭐ Static Public Member Functions

  • static SoType getClassTypeId (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.

πŸ’– Static Public Member Functions inherited from SoNode

static uint32_t getCompatibilityTypes (const SoType &nodetype)
static SoType getClassTypeId (void)
static SoNode * getByName (const SbName &name)
static int getByName (const SbName &name, SoNodeList &l)
static void initClass (void)
static void initClasses (void)
static SbUniqueId getNextNodeId (void)
static int getActionMethodIndex (const SoType type)
static void getBoundingBoxS (SoAction *action, SoNode *node)
static void GLRenderS (SoAction *action, SoNode *node)
static void callbackS (SoAction *action, SoNode *node)
static void getMatrixS (SoAction *action, SoNode *node)
static void handleEventS (SoAction *action, SoNode *node)
static void pickS (SoAction *action, SoNode *node)
static void rayPickS (SoAction *action, SoNode *node)
static void searchS (SoAction *action, SoNode *node)
static void writeS (SoAction *action, SoNode *node)
static void audioRenderS (SoAction *action, SoNode *node)
static void getPrimitiveCountS (SoAction *action, SoNode *node)

quick receipts on a couple of them:

  • 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. she does this everywhere, it's her thing ✨

πŸŽ€ Static Public Member Functions inherited from SoFieldContainer

static void initClass (void)
static SoType getClassTypeId (void)
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)

the receipts:

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

and again for the record:

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

πŸ‘‘ Public Attributes

  • SoSFString string β€” THE field. the whole point. the moment. πŸ’…

πŸ”₯ Protected Member Functions

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoInfo ()

πŸ“ Protected Member Functions inherited from SoNode

SoNode (void)
virtual ~SoNode ()
virtual SbBool readInstance (SoInput *in, unsigned short flags)

πŸ’€ Protected Member Functions inherited from SoFieldContainer

SoFieldContainer (void)
virtual ~SoFieldContainer ()

πŸ™ˆ Protected Member Functions inherited from SoBase

SoBase (void)
virtual ~SoBase ()
virtual void destroy (void)
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)

🌟 Static Protected Member Functions

  • static const SoFieldData ** getFieldDataPtr (void)

🧸 Static Protected Member Functions inherited from SoNode

static const SoFieldData ** getFieldDataPtr (void)
static void setNextActionMethodIndex (int index)
static int getNextActionMethodIndex (void)
static void incNextActionMethodIndex (void)
static void setCompatibilityTypes (const SoType &nodetype, const uint32_t bitmask)

πŸ¦„ Static Protected Member Functions inherited from SoBase

static uint32_t getCurrentWriteCounter (void)
static void staticDataLock (void)
static void staticDataUnlock (void)

🫧 Additional Inherited Members

πŸ’œ Public Types inherited from SoNode

the whole enum, every bit, no skips:

enum NodeType {
  INVENTOR = 0x0000,
  VRML1 = 0x0001,
  VRML2 = 0x0002,
  INVENTOR_1 = 0x0004,
  INVENTOR_2_0 = 0x0008,
  INVENTOR_2_1 = 0x0010,
  INVENTOR_2_5 = 0x0020,
  INVENTOR_2_6 = 0x0040,
  COIN_1_0 = 0x0080,
  COIN_2_0 = 0x0100,
  EXTENSION = 0x0200,
  COIN_2_2 = 0x0400,
  COIN_2_3 = 0x0800,
  COIN_2_4 = 0x1000,
  INVENTOR_5_0 = 0x2000,
  COIN_2_5 = 0x4000,
  COIN_3_0 = 0x8000,
  INVENTOR_6_0 = 0x10000,
  COIN_4_0 = 0x20000
}

πŸŽ€ Protected Types inherited from SoBase

enum BaseFlags { IS_ENGINE = 0x01, IS_GROUP = 0x02 }

⭐ Protected Attributes inherited from SoNode

  • SbUniqueId uniqueId

πŸ’– Protected Attributes inherited from SoFieldContainer

  • SbBool isBuiltIn

🌸 Static Protected Attributes inherited from SoNode

  • static SbUniqueId nextUniqueId = 1
  • static int nextActionMethodIndex = 0

πŸŽ€ DETAILED DESCRIPTION πŸŽ€

SoInfo is a node for holding text information. periodt.

Basically she's a placeholder β€” a lil spot for textual information about a scene. The classic use case is putting author and copyright info inside Inventor format files, but honestly she can be used for other purposes too, of course. versatile queen πŸ’…

real talk: SoInfo nodes do not influence traversal in any way for any of the built-in actions. she minds her business, she doesn't touch the pipeline, she simply exists. iconic behaviour honestly ✨

🌈 FILE FORMAT/DEFAULTS

Info {
    string "<Undefined info>"
}

πŸ’– CONSTRUCTOR & DESTRUCTOR DOCUMENTATION πŸ’–

πŸ¦‹ SoInfo::SoInfo (void )

Constructor. she's born 🫢

🧚 SoInfo::~SoInfo () [protected], [virtual]

Destructor. she's gone 😭 (it's protected and virtual, so mind your manners)

✨ MEMBER FUNCTION DOCUMENTATION ✨

okay bestie, this is the part where we meet the actual functions, and honestly? they're giving "quiet overachiever" energy. let's go one by one πŸ’…


πŸ¦‹ SoType SoInfo::getClassTypeId(void) β€” [static]

this one's a static method, meaning you don't need an actual instance of anything to call it β€” it just sits there, ready, like a bestie who always picks up the phone.

it returns the SoType object that's associated with objects of this class. that's it, that's the whole vibe. 🫢


πŸ¦‹ SoType SoInfo::getTypeId(void) const β€” [virtual]

this cutie returns the type identification of an object derived from a class that inherits SoBase.

what's it for? two things, and they're both lowkey iconic:

  • runtime type checking β€” figuring out what something actually is while the program's running
  • "downward" casting β€” which, yes, is literally in quotes in the original, so we're keeping the quotes. dramatic. we love a quoted "downward".

this one implements SoBase, so it's carrying that legacy, no cap.


πŸ¦‹ const SoFieldData ** SoInfo::getFieldDataPtr(void) β€” [static], [protected]

πŸ™ˆ heads up bestie: this API member is considered internal to the library, because it is not likely to be of interest to the application programmer. so if you're just out here building apps, this one's not your girl. it's giving backstage pass, iykyk.

it returns the SoFieldData class, which holds all the info about the fields in this node. very much the "files the paperwork" of the family. πŸ’€


πŸ¦‹ const SoFieldData * SoInfo::getFieldData(void) const β€” [protected], [virtual]

this one hands you a pointer to the class-wide field data storage object for this particular instance.

and here's the one technical caveat you cannot skip: if there are no fields present, it returns NULL. so check before you dereference, bestie, please, for me. 😭

also β€” it's reimplemented from SoFieldContainer. passing the torch, iconic behavior. ✨


🌸 MEMBER DATA DOCUMENTATION 🌸

πŸ“ SoSFString SoInfo::string

that's the data member, right there, in all its glory.

its job? text information. short description, huge responsibility. a legend. πŸ‘‘


πŸ‘‘ AUTHOR πŸ‘‘

generated automatically by Doxygen for Coin, straight from the source code.

(not me getting emotional over an auto-generated author line. it's fine. i'm fine. πŸ’œ)


and that's a wrap on SoInfo(3), bestie!! this whole page came to you from version 4.0.10, dated Thu Jun 25 2026 00:00:00 β€” go forth, call these functions responsibly, and remember: NULL checks are self care. πŸŽ€πŸ’–βœ¨

πŸ“¦ where this page comes from