SoProfilerOverlayKit(3)

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

🎀 SoProfilerOverlayKit 🎀

hey bestie, welcome in 💖 this is the manpage for SoProfilerOverlayKit(3), straight outta Coin, and yes she is a whole lot of inherited member functions and we are going to get through every single one of them together. grab a snack. hydrate. we're doing this. 🫶

🌸 NAME 🌸

SoProfilerOverlayKit — the SoProfilerOverlayKit element class is yet to be documented. (not me being the class that shows up with no description 😭 the Coin devs said "she's mysterious" and moved on.)

✨ SYNOPSIS ✨

#include <Inventor/annex/Profiler/nodekits/SoProfilerOverlayKit.h>
  • Inherits SoBaseKit.
  • Inherited by SoProfilerTopKit.

so yeah, she's a nodekit that's a subclass of SoBaseKit, and SoProfilerTopKit is her literal child. family tree ate. 👑

💅 Public Member Functions 💅

  • virtual SoType getTypeId (void) const
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const
  • SoProfilerOverlayKit (void)
  • void addOverlayGeometry (SoNode *node)

four (4) whole functions of her own, and honestly the rest is all inheritance, which we are about to list in its full, unedited, no-skipping glory. 💀

🌈 Public Member Functions inherited from SoBaseKit 🌈

  • SoBaseKit (void)
  • virtual SoNode * getPart (const SbName &partname, SbBool makeifneeded)
  • SbString getPartString (const SoBase *part)
  • virtual SoNodeKitPath * createPathToPart (const SbName &partname, SbBool makeifneeded, const SoPath *pathtoextend=NULL)
  • virtual SbBool setPart (const SbName &partname, SoNode *from)
  • SbBool set (const char *namevaluepairliststring)
  • SbBool set (const char *partnamestring, const char *parameterstring)
  • virtual void doAction (SoAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void write (SoWriteAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • virtual SoChildList * getChildren (void) const
  • void printDiagram (void)
  • void printSubDiagram (const SbName &rootname, int level)
  • void printTable (void)
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE)
  • virtual void forceChildDrivenWriteRefs (SoOutput *out) — wait, no, hold on, let me check: it's SbBool forceChildDrivenWriteRefs (SoOutput *out), no virtual, my bad bestie, corrected below. 🙈

okay for real, without the typo chaos:

  • SbBool forceChildDrivenWriteRefs (SoOutput *out)

there. all twenty-two of them. no cap. 💅

🦋 Public Member Functions inherited from SoNode 🦋

  • 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 GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void pick (SoPickAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • virtual void notify (SoNotList *l)
  • SbUniqueId getNodeId (void) const
  • virtual void writeInstance (SoOutput *out)
  • virtual SoFieldContainer * copyThroughConnection (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)
  • SbBool getIsBuiltIn (void) const
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const
  • void setUserData (void *userdata) const
  • void * getUserData (void) const

look at all those overloaded set and get twins, it's giving matching outfits, iconic. 👯

💜 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. so basically: "are you one of us, or descended from us" — vibe check, but for types. 💅
  • 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

⭐ Static Public Member Functions ⭐

  • static SoType getClassTypeId (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (void)
  • static void initClass (void)

🌟 Static Public Member Functions inherited from SoBaseKit 🌟

  • static SoType getClassTypeId (void)
  • static void initClass (void)
  • static const SoNodekitCatalog * getClassNodekitCatalog (void)
  • static SbBool isSearchingChildren (void)
  • static void setSearchingChildren (const SbBool newval)

🔥 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) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. (the classic "hi Coin, it's me" handshake 🤝)
  • 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)

🧚 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. (same ritual, different class ✨)
  • 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 🎀

  • SoSFVec3f viewportSize

one single public attribute and it's a whole SoSFVec3f. she said "I'll give you exactly one field and it will be three floats." minimalist queen. 👑

💖 Protected Member Functions 💖

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

🩷 Protected Member Functions inherited from SoBaseKit 🩷

  • virtual ~SoBaseKit ()
  • virtual SoNode * addToCopyDict (void) const
  • virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections)
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE)
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE)
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL)
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE)
  • void createNodekitPartsList (void)
  • void createFieldList (void)
  • virtual void createDefaultParts (void)
  • const SoNodekitParts * getNodekitPartsList (void) const
  • const SbList< SoSFNode * > & getCatalogInstances (void) const
  • void catalogError (void)
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE)
  • virtual SbBool readInstance (SoInput *in, unsigned short flags)
  • virtual void setDefaultOnNonWritingFields (void)
  • void countMyFields (SoOutput *out)
  • virtual SbBool setPart (const int partNum, SoNode *node)

🐣 Protected Member Functions inherited from SoNode 🐣

  • SoNode (void)
  • virtual ~SoNode ()

💀 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 const SoNodekitCatalog ** getClassNodekitCatalogPtr (void)

🎁 Static Protected Member Functions inherited from SoBaseKit 🎁

  • static const SoFieldData ** getFieldDataPtr (void)
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (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)

and that, bestie, is the entire SYNOPSIS dump — every single member function, static or otherwise, public, protected, inherited and otherwise, all present and accounted for, not one skipped. ✨ but hold up, don't go anywhere, because this page is long and part 2 is right behind this one with the rest of the sections, so keep scrolling 💖🦋

✨ Static Protected Member Functions inherited from SoBase ✨

bestie, these three are the static protected helpers that come down to you from SoBase, and the docs are staying mysterious about them — no descriptions given, they're just here, living their truth:

  • static uint32_t getCurrentWriteCounter(void) — returns a uint32_t. that's literally all we know. iconic behaviour, no notes 💅
  • static void staticDataLock(void) — locks... something static. the manpage said nothing else so neither will I 🙈
  • static void staticDataUnlock(void) — the unlock counterpart to the one above. slay, symmetry 🎀

🫶 Protected Attributes 🫶

these are the fields your kit keeps all to itself (well, to itself and its subclasses). all seven are SoSFNode:

  • SoSFNode topSeparator — the top separator node field.
  • SoSFNode profilingStats — the profiling stats node field.
  • SoSFNode viewportInfo — the viewport info node field.
  • SoSFNode overlayCamera — the overlay camera node field.
  • SoSFNode depthTestOff — depth test off node field.
  • SoSFNode overlaySep — the overlay separator node field.
  • SoSFNode depthTestOn — depth test on node field.

🌸 Protected Attributes inherited from SoBaseKit 🌸

  • SoSFNode callbackList
  • SoChildList * children
  • SbBool connectionsSetUp

🌈 Protected Attributes inherited from SoNode 🌈

  • SbUniqueId uniqueId

💜 Protected Attributes inherited from SoFieldContainer 💜

  • SbBool isBuiltIn

👑 Additional Inherited Members 👑

bestie this is the family tree section, and it's giving legacy code realness:

🦋 Public Types inherited from SoNode 🦋

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 }

look at that hex ladder, every generation of the format got its own little bit flag. a whole timeline in one enum, we love to see it ✨

🧚 Protected Types inherited from SoBase 🧚

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

two flags, zero drama.

⭐ Static Protected Attributes inherited from SoNode ⭐

  • static SbUniqueId nextUniqueId = 1 — starts at 1, counting up forever.
  • static int nextActionMethodIndex = 0 — starts at 0, also counting up forever.

💖 Detailed Description 💖

The SoProfilerOverlayKit element class is yet to be documented.

not me reading that and being like... okay so we're all just figuring it out together 😭 the docs literally say "yet to be documented" and honestly? relatable. moving on, bestie 🫶

🎀 Constructor & Destructor Documentation 🎀

SoProfilerOverlayKit::SoProfilerOverlayKit(void )

Constructor. that's it, that's the whole thing — it makes one 💅

SoProfilerOverlayKit::~SoProfilerOverlayKit(void ) [protected], [virtual]

Destructor. it's protected and it's virtual, so no just deleting it from the outside, bestie, and subclasses get to have their own moment when it goes 🙈

🔥 Member Function Documentation 🔥

SoType SoProfilerOverlayKit::getClassTypeId(void ) [static]

This static method returns the SoType object associated with objects of this class. class-level vibes only, no instance needed ✨

SoType SoProfilerOverlayKit::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.

  • Reimplemented from SoBaseKit.
  • Reimplemented in SoProfilerTopKit.

so it's checking your vibe at runtime and then casting down the inheritance tree. main character energy fr fr 👑

const SoFieldData ** SoProfilerOverlayKit::getFieldDataPtr(void ) [static], [protected]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. (translation: bestie, this one's not for you, it's for the library's own business 💀)

Returns the SoFieldData class which holds information about fields in this node.

const SoFieldData * SoProfilerOverlayKit::getFieldData(void ) const [protected], [virtual]

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

  • Reimplemented from SoBaseKit.
  • Reimplemented in SoProfilerTopKit.

note the NULL — that's the actual documented behaviour, don't come for me 🌸

const SoNodekitCatalog * SoProfilerOverlayKit::getClassNodekitCatalog(void ) [static]

Returns the nodekit catalog which defines the layout of this class' kit. the whole blueprint, class-level 🎀

const SoNodekitCatalog * SoProfilerOverlayKit::getNodekitCatalog(void ) const [virtual]

Returns the nodekit catalog which defines the layout of this class' kit. same blueprint, but per-instance this time.

  • Reimplemented from SoBaseKit.
  • Reimplemented in SoProfilerTopKit.

const SoNodekitCatalog ** SoProfilerOverlayKit::getClassNodekitCatalogPtr(void ) [static], [protected]

Returns the pointer to the pointer of the nodekit catalog for this class. yes bestie, a pointer to a pointer — we're going that deep, it's giving C++ 💅

void SoProfilerOverlayKit::addOverlayGeometry(SoNode * node)

Display profiling scene graph on top of the regular viewport. THE main event, honestly. this is the one that actually does the thing 🫶

Parameters

  • node — Scene graph to display

🌟 Author 🌟

Generated automatically by Doxygen for Coin from the source code.

and that's a wrap on SoProfilerOverlayKit(3), bestie!! this page is Version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's filed under SoProfilerOverlayKit(3) — go forth and overlay that geometry, you absolute icon 💖✨🦋

📦 where this page comes from