SoProfilerTopKit(3)

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

💖 SoProfilerTopKit 💖

okay bestie, welcome to SoProfilerTopKit(3) — yes, section 3 of the Coin manual, we're doing C++ nodekit lore today. this is part 1 of 2, so hydrate, stretch, and let's go 🌸

✨ NAME ✨

SoProfilerTopKit — the SoProfilerTopKit element class. and that's... it, actually. it is yet to be documented 😭 no cap. the whole description is a placeholder. we're all just vibing here.

🦋 SYNOPSIS 🦋

#include <Inventor/annex/Profiler/nodekits/SoProfilerTopKit.h>

and the family tree situation: it inherits SoProfilerOverlayKit. that's the whole lineage reveal for this part. iconic.

👑 Public Member Functions

the two methods it actually brings to the table itself:

  • virtual SoType getTypeId (void) const — the classic type-id vibe check ✨
  • virtual const SoNodekitCatalog * getNodekitCatalog (void) const — hands you the nodekit catalog pointer, no notes

🌈 Public Member Functions inherited from SoProfilerOverlayKit

stuff it got from its parent, no effort required:

  • SoProfilerOverlayKit (void) — the constructor, doing constructor things
  • void addOverlayGeometry (SoNode *node) — drop some overlay geometry in there, slay

💅 Public Member Functions inherited from SoBaseKit

this is the big one, the whole nodekit starter pack, fr fr:

  • SoBaseKit (void) — constructor
  • virtual SoNode * getPart (const SbName &partname, SbBool makeifneeded) — grab a part by name
  • SbString getPartString (const SoBase *part) — string version of a part
  • virtual SoNodeKitPath * createPathToPart (const SbName &partname, SbBool makeifneeded, const SoPath *pathtoextend=NULL) — build a path to a part
  • virtual SbBool setPart (const SbName &partname, SoNode *from) — set a part by name
  • SbBool set (const char *namevaluepairliststring) — set from a name/value pair list string
  • SbBool set (const char *partnamestring, const char *parameterstring) — set from part name string + parameter string
  • virtual void doAction (SoAction *action) — do the action
  • virtual void callback (SoCallbackAction *action) — callback action handling
  • virtual void GLRender (SoGLRenderAction *action) — render it 💖
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action) — bounding box time
  • virtual void getMatrix (SoGetMatrixAction *action) — matrix time
  • virtual void handleEvent (SoHandleEventAction *action) — event handling
  • virtual void rayPick (SoRayPickAction *action) — ray pick
  • virtual void search (SoSearchAction *action) — search
  • virtual void write (SoWriteAction *action) — write it out
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action) — count them primitives
  • virtual SoChildList * getChildren (void) const — the children list
  • void printDiagram (void) — print the whole diagram, cute
  • void printSubDiagram (const SbName &rootname, int level) — diagram but scoped to a root, at a level
  • void printTable (void) — print the table
  • virtual void addWriteReference (SoOutput *out, SbBool isfromfield=FALSE) — add a write reference
  • SbBool forceChildDrivenWriteRefs (SoOutput *out) — force child-driven write refs

🦋 Public Member Functions inherited from SoNode

  • void setOverride (const SbBool state) — set the override state
  • SbBool isOverride (void) const — are we overriding?
  • void setNodeType (const NodeType type) — set the node type
  • NodeType getNodeType (void) const — get the node type
  • virtual SoNode * copy (SbBool copyconnections=FALSE) const — copy the node
  • virtual SbBool affectsState (void) const — does it affect state?
  • virtual void GLRenderBelowPath (SoGLRenderAction *action) — GL render below path
  • virtual void GLRenderInPath (SoGLRenderAction *action) — GL render in path
  • virtual void GLRenderOffPath (SoGLRenderAction *action) — GL render off path
  • virtual void pick (SoPickAction *action) — pick
  • virtual void audioRender (SoAudioRenderAction *action) — audio render 🔊
  • virtual void grabEventsSetup (void) — set up event grabbing
  • virtual void grabEventsCleanup (void) — clean up event grabbing
  • virtual void startNotify (void) — start notifying
  • virtual void notify (SoNotList *l) — notify
  • SbUniqueId getNodeId (void) const — get the unique node id
  • virtual void writeInstance (SoOutput *out) — write this instance
  • virtual SoFieldContainer * copyThroughConnection (void) const — copy through connection

🎀 Public Member Functions inherited from SoFieldContainer

  • void setToDefaults (void) — reset everything to defaults
  • SbBool hasDefaultValues (void) const — are all the values default?
  • SbBool fieldsAreEqual (const SoFieldContainer *container) const — compare fields with another container
  • void copyFieldValues (const SoFieldContainer *container, SbBool copyconnections=FALSE) — copy the field values over
  • SbBool set (const char *const fielddata) — set from field data
  • void get (SbString &fielddata) — get the field data out
  • virtual int getFields (SoFieldList &l) const — get the fields
  • virtual int getAllFields (SoFieldList &l) const — get ALL the fields
  • virtual SoField * getField (const SbName &name) const — get one field by name
  • virtual SoField * getEventIn (const SbName &name) const — get an event in by name
  • virtual SoField * getEventOut (const SbName &name) const — get an event out by name
  • SbBool getFieldName (const SoField *const field, SbName &name) const — name of a given field
  • SbBool enableNotify (const SbBool flag) — toggle notification
  • SbBool isNotifyEnabled (void) const — is notification on?
  • SbBool set (const char *fielddata, SoInput *input) — set from field data using an SoInput
  • void get (SbString &fielddata, SoOutput *out) — get into a string using an SoOutput
  • virtual SbBool validateNewFieldValue (SoField *field, void *newval) — validate a new field value
  • SbBool getIsBuiltIn (void) const — is it built in?
  • virtual void getFieldsMemorySize (size_t &managed, size_t &unmanaged) const — memory sizes, managed and unmanaged
  • void setUserData (void *userdata) const — stash your user data
  • void * getUserData (void) const — get your user data back

🌟 Public Member Functions inherited from SoBase

  • void ref (void) const — ref it up
  • void unref (void) const — unref it
  • void unrefNoDelete (void) const — unref but don't delete
  • int32_t getRefCount (void) const — how many refs?
  • void touch (void) — touch it
  • 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 — get the name
  • virtual void setName (const SbName &newname) — set a new name
  • void addAuditor (void *const auditor, const SoNotRec::Type type) — add an auditor
  • void removeAuditor (void *const auditor, const SoNotRec::Type type) — remove an auditor
  • const SoAuditorList & getAuditors (void) const — the auditor list
  • SbBool shouldWrite (void) — should this be written?
  • void assertAlive (void) const — assert that it's alive (very dramatic of it)

🔥 Static Public Member Functions

the class-level squad, specific to this kit:

  • static SoType getClassTypeId (void) — the class type id
  • static const SoNodekitCatalog * getClassNodekitCatalog (void) — the class nodekit catalog
  • static void initClass (void) — initialize the class

💜 Static Public Member Functions inherited from SoProfilerOverlayKit

  • static SoType getClassTypeId (void) — class type id
  • static const SoNodekitCatalog * getClassNodekitCatalog (void) — class nodekit catalog
  • static void initClass (void) — init the class

⭐ Static Public Member Functions inherited from SoBaseKit

  • static SoType getClassTypeId (void) — class type id
  • static void initClass (void) — init the class
  • static const SoNodekitCatalog * getClassNodekitCatalog (void) — class nodekit catalog
  • static SbBool isSearchingChildren (void) — is it searching children?
  • static void setSearchingChildren (const SbBool newval) — set searching children to a new value

🌸 Static Public Member Functions inherited from SoNode

  • static uint32_t getCompatibilityTypes (const SoType &nodetype) — compatibility types for a node type
  • static SoType getClassTypeId (void) — class type id
  • static SoNode * getByName (const SbName &name) — look a node up by name
  • static int getByName (const SbName &name, SoNodeList &l) — look up by name into a node list
  • 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) — init all the classes
  • static SbUniqueId getNextNodeId (void) — the next unique node id
  • static int getActionMethodIndex (const SoType type) — action method index for a type
  • static void getBoundingBoxS (SoAction *action, SoNode *node) — static bounding box helper
  • static void GLRenderS (SoAction *action, SoNode *node) — static GL render helper
  • static void callbackS (SoAction *action, SoNode *node) — static callback helper
  • static void getMatrixS (SoAction *action, SoNode *node) — static matrix helper
  • static void handleEventS (SoAction *action, SoNode *node) — static event handling helper
  • static void pickS (SoAction *action, SoNode *node) — static pick helper
  • static void rayPickS (SoAction *action, SoNode *node) — static ray pick helper
  • static void searchS (SoAction *action, SoNode *node) — static search helper
  • static void writeS (SoAction *action, SoNode *node) — static write helper
  • static void audioRenderS (SoAction *action, SoNode *node) — static audio render helper
  • static void getPrimitiveCountS (SoAction *action, SoNode *node) — static primitive count helper

🧚 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) — clean up the class
  • static void initCopyDict (void) — init the copy dict
  • static void addCopy (const SoFieldContainer *orig, const SoFieldContainer *copy) — register a copy
  • static SoFieldContainer * checkCopy (const SoFieldContainer *orig) — check for a copy
  • static SoFieldContainer * findCopy (const SoFieldContainer *orig, const SbBool copyconnections) — find a copy
  • static void copyDone (void) — copying's done, wrap it up

🍓 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) — add a name to a base
  • static void removeName (SoBase *const base, const char *const name) — remove a name from a base
  • static void incrementCurrentWriteCounter (void) — bump the current write counter
  • static void decrementCurrentWriteCounter (void) — drop the current write counter
  • static SoBase * getNamedBase (const SbName &name, SoType type) — get a named base
  • static int getNamedBases (const SbName &name, SoBaseList &baselist, SoType type) — get named bases into a list
  • static SbBool read (SoInput *input, SoBase *&base, SoType expectedtype) — read a base in
  • static void setInstancePrefix (const SbString &c) — set the instance prefix
  • static void setTraceRefs (SbBool trace) — turn ref tracing on/off
  • static SbBool getTraceRefs (void) — is ref tracing on?
  • static SbBool connectRoute (SoInput *input, const SbName &fromnodename, const SbName &fromfieldname, const SbName &tonodename, const SbName &tofieldname) — connect a route between node/field pairs
  • static SbBool readRoute (SoInput *input) — read a route

🫶 Public Attributes

the actual data fields this kit carries around:

  • SoSFColor txtColor — a color, presumably for text, but you didn't hear any speculation from me
  • SoSFInt32 lines — an int32 count of lines
  • SoSFVec2f topKitSize — a 2-float vector size for the top kit
  • SoSFVec3f position — a 3-float vector position

🌈 Public Attributes inherited from SoProfilerOverlayKit

  • SoSFVec3f viewportSize — a 3-float vector viewport size

💀 Protected Member Functions

just the one for this class, bestie:

  • virtual const SoFieldData * getFieldData (void) const — get the field data

🙈 Protected Member Functions inherited from SoProfilerOverlayKit

  • virtual ~SoProfilerOverlayKit (void) — the destructor

💖 Protected Member Functions inherited from SoBaseKit

  • virtual ~SoBaseKit () — destructor
  • virtual SoNode * addToCopyDict (void) const — add to the copy dict
  • virtual void copyContents (const SoFieldContainer *fromfc, SbBool copyconnections) — copy the contents over
  • SoGroup * getContainerNode (const SbName &listname, SbBool makeifneeded=TRUE) — get the container node for a list
  • virtual SoNode * getAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE) — get any part, with leaf and public checks
  • virtual SoNodeKitPath * createPathToAnyPart (const SbName &partname, SbBool makeifneeded, SbBool leafcheck=FALSE, SbBool publiccheck=FALSE, const SoPath *pathtoextend=NULL) — path to any part
  • virtual SbBool setAnyPart (const SbName &partname, SoNode *from, SbBool anypart=TRUE) — set any part
  • void createNodekitPartsList (void) — create the nodekit parts list
  • void createFieldList (void) — create the field list
  • virtual void createDefaultParts (void) — create the default parts
  • const SoNodekitParts * getNodekitPartsList (void) const — get the nodekit parts list
  • const SbList< SoSFNode * > & getCatalogInstances (void) const — get the catalog instances
  • void catalogError (void) — catalog error handler
  • virtual SbBool setUpConnections (SbBool onoff, SbBool doitalways=FALSE) — set up connections
  • virtual SbBool readInstance (SoInput *in, unsigned short flags) — read an instance
  • virtual void setDefaultOnNonWritingFields (void) — set defaults on non-writing fields
  • void countMyFields (SoOutput *out) — count the fields
  • virtual SbBool setPart (const int partNum, SoNode *node) — set a part by index

🌈 Protected Member Functions inherited from SoNode

  • SoNode (void) — constructor
  • virtual ~SoNode () — destructor

🎀 Protected Member Functions inherited from SoFieldContainer

  • SoFieldContainer (void) — constructor
  • virtual ~SoFieldContainer () — destructor

✨ Protected Member Functions inherited from SoBase

  • SoBase (void) — constructor
  • virtual ~SoBase () — destructor
  • virtual void destroy (void) — destroy
  • SbBool hasMultipleWriteRefs (void) const — multiple write refs?
  • SbBool writeHeader (SoOutput *out, SbBool isgroup, SbBool isengine) const — write the header
  • void writeFooter (SoOutput *out) const — write the footer
  • virtual const char * getFileFormatName (void) const — the file format name
  • virtual SoNotRec createNotRec (void) — create a notification record

🌟 Static Protected Member Functions

  • static const SoFieldData ** getFieldDataPtr (void) — pointer to the field data pointer
  • static const SoNodekitCatalog ** getClassNodekitCatalogPtr (void) — pointer to the class nodekit catalog pointer
ok that's the whole synopsis dump for part 1, and yes it's a lot, but you ate it 💅 more of this page is coming in part 2, so don't go anywhere 🦋

💫 Static Protected Member Functions (inherited from SoProfilerOverlayKit)

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

💫 Static Protected Member Functions (inherited from SoBase)

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

🎀 Protected Attributes

bestie these are the lil' internal fields that SoProfilerTopKit keeps to itself, no cap:

  • SoSFNode textSep
  • SoSFNode color
  • SoSFNode translation
  • SoSFNode text
  • SoSFNode graph

🦋 Protected Attributes (inherited from SoProfilerOverlayKit)

  • SoSFNode topSeparator
  • SoSFNode profilingStats
  • SoSFNode viewportInfo
  • SoSFNode overlayCamera
  • SoSFNode depthTestOff
  • SoSFNode overlaySep
  • SoSFNode depthTestOn

🦋 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

💜 Public Types (inherited from SoNode)

okay so this enum is literally the timeline of every file format Coin has ever known and loved:

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 }

💜 Static Protected Attributes (inherited from SoNode)

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

🌸 Detailed Description

The SoProfilerTopKit element class is yet to be documented. (yes, truly. the docs are giving "coming soon" energy, we been knew 😭)

🌈 Member Function Documentation

⭐ SoType SoProfilerTopKit::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. it's the little name tag your class wears at the party 💅

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

⭐ const SoFieldData ** SoProfilerTopKit::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.

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

⭐ const SoFieldData * SoProfilerTopKit::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 SoProfilerOverlayKit.

⭐ const SoNodekitCatalog * SoProfilerTopKit::getClassNodekitCatalog (void ) [static]

Returns the nodekit catalog which defines the layout of this class' kit. it's the blueprint bestie, the floor plan, the whole vibe ✨

⭐ const SoNodekitCatalog * SoProfilerTopKit::getNodekitCatalog (void ) const [virtual]

Returns the nodekit catalog which defines the layout of this class' kit.

Reimplemented from SoProfilerOverlayKit.

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

Returns the pointer to the pointer of the nodekit catalog for this class. yes, a pointer to a pointer. double the pointer, double the power 🫶

👑 Author

Generated automatically by Doxygen for Coin from the source code. (Doxygen really said "I'll write your docs for you" and honestly? it ate.)

and that's a wrap on the whole page, bestie!! this was Version 4.0.10, dated Thu Jun 25 2026 00:00:00, filed under SoProfilerTopKit(3) — go forth and kit those topkits 💖✨🎀

📦 where this page comes from