SoProfilerStats(3)

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

🌸 SoProfilerStats(3) 🌸

okay bestie, welcome to the Coin manual page for SoProfilerStats, the profiler-stats node, chapter three of the manual (that's the (3) — library call vibes 💅). Buckle up, this one is LONG, and we're doing it in two parts, so no signing off, we're just getting started. 🫶

🎀 NAME 🎀

SoProfilerStats — so basically, the SoProfilerStats class is a node for exposing profiling results gathered by SoProfilerElement. that's it, that's the name section, she's serving exactly what she says on the tin. ✨

🌟 SYNOPSIS 🌟

#include <Inventor/annex/Profiler/nodes/SoProfilerStats.h>

Inherits SoNode. yes bestie, she's a node, she's in the family tree, it's giving inheritance. 👑

💖 Public Member Functions 💖

  • virtual SoType getTypeId (void) const
  • SoProfilerStats (void)
  • virtual void GLRender (SoGLRenderAction *action)
  • virtual void handleEvent (SoHandleEventAction *action)
  • virtual void rayPick (SoRayPickAction *action)
  • virtual void getBoundingBox (SoGetBoundingBoxAction *action)
  • virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action)
  • virtual void audioRender (SoAudioRenderAction *action)
  • virtual void callback (SoCallbackAction *action)
  • virtual void getMatrix (SoGetMatrixAction *action)
  • virtual void pick (SoPickAction *action)
  • virtual void search (SoSearchAction *action)
  • virtual void write (SoWriteAction *action)
  • const SbProfilingData & getProfilingData (SoType actiontype) const

🦋 Public Member Functions inherited from SoNode 🦋

like, she got all of these from her parent, 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 GLRenderBelowPath (SoGLRenderAction *action)
  • virtual void GLRenderInPath (SoGLRenderAction *action)
  • virtual void GLRenderOffPath (SoGLRenderAction *action)
  • virtual void grabEventsSetup (void)
  • virtual void grabEventsCleanup (void)
  • virtual void startNotify (void)
  • 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 🌈

  • 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. slay, type-checking queen 👑
  • 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 void initClass (void) — sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system. it's the getting-ready-for-the-group-chat ritual 💅

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

  • SoMFName renderedNodeType
  • SoMFTime renderingTimePerNodeType
  • SoMFTime renderingTimeMaxPerNodeType
  • SoMFUInt32 renderedNodeTypeCount
  • SoMFName profiledAction
  • SoMFTime profiledActionTime
  • SoMFNode separatorsCullRoots
  • SoSFTrigger profilingUpdate

🔥 Protected Member Functions 🔥

  • virtual const SoFieldData * getFieldData (void) const
  • virtual ~SoProfilerStats ()
  • virtual void notify (SoNotList *l)

🌙 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

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 💅

The SoProfilerStats class is a node for exposing profiling results gathered by SoProfilerElement.

TODO: Describe functionality and provide usage example. — yeah bestie, the docs are literally telling on themselves here, the description is still a work in progress. no cap, that's verbatim from the source. 🙈

See also

  • SoProfilerElement

🫶 Constructor & Destructor Documentation 🫶

SoProfilerStats::SoProfilerStats (void )

Constructor. she's born. main character entrance. ✨

SoProfilerStats::~SoProfilerStats () [protected], [virtual]

Destructor. and she's protected and virtual, so mind your inheritance, bestie. 💅

✨ Member Function Documentation ✨

okay bestie, buckle up, because this is the part where we go through every single method one at a time. no skipping. we're doing the whole roster 💅

SoType SoProfilerStats::getClassTypeId (void ) [static]

this static method returns the SoType object associated with objects of this class. that's it. that's the whole job. she's a lookup girlie and she slays at it 🎀

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

returns the type identification of an object derived from a class inheriting SoBase. this is the ✨ runtime type checking ✨ and "downward" casting machinery — like, when you need to figure out what something actually is at runtime, this is the queen you ask 👑

Implements SoBase.

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

bestie, this one is considered internal to the library — it's not likely to be of interest to the application programmer, no cap. it returns the SoFieldData class which holds information about fields in this node. so like, if you're just writing an app, you can lowkey ignore her 🙈

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

returns a pointer to the class-wide field data storage object for this instance. and if there are no fields present? it returns NULL. that's the vibe. that's the whole story fr fr

Reimplemented from SoFieldContainer.

void SoProfilerStats::GLRender (SoGLRenderAction * action) [virtual]

action method for the SoGLRenderAction. this gets called during rendering traversals 🎨

nodes that influence the rendering state in any way — or that want to throw geometry primitives at OpenGL — override this method. main character energy only.

Reimplemented from SoNode.

void SoProfilerStats::handleEvent (SoHandleEventAction * action) [virtual]

action method for SoHandleEventAction. she inspects the event data from action and processes it if it's something this node should react to 🌸

nodes influencing relevant state variables for how event handling is done also override this method. iykyk.

Reimplemented from SoNode.

void SoProfilerStats::rayPick (SoRayPickAction * action) [virtual]

action method for SoRayPickAction. checks the ray specification of the action and tests for intersection with the data of the node 🔥

nodes influencing relevant state variables for how picking is done also override this method.

Reimplemented from SoNode.

void SoProfilerStats::getBoundingBox (SoGetBoundingBoxAction * action) [virtual]

action method for the SoGetBoundingBoxAction. calculates bounding box and center coordinates for the node, and modifies the values of the action so it encompasses the bounding box for this node — and shifts the center point for the scene more towards the one for this node 🦋

nodes influencing how geometry nodes calculate their bounding box also override this method to change the relevant state variables.

Reimplemented from SoNode.

void SoProfilerStats::getPrimitiveCount (SoGetPrimitiveCountAction * action) [virtual]

action method for the SoGetPrimitiveCountAction. calculates the number of triangle, line segment and point primitives for the node, and adds these to the counters of the action 🔢

nodes influencing how geometry nodes calculate their primitive count also override this method to change the relevant state variables.

Reimplemented from SoNode.

void SoProfilerStats::audioRender (SoAudioRenderAction * action) [virtual]

action method for SoAudioRenderAction. does common processing for SoAudioRenderAction action instances 🎧

Reimplemented from SoNode.

void SoProfilerStats::callback (SoCallbackAction * action) [virtual]

action method for SoCallbackAction. she simply updates the state according to how the node behaves for the render action, so the application programmer can use the SoCallbackAction for extracting information about the scene graph 🧚

Reimplemented from SoNode.

void SoProfilerStats::getMatrix (SoGetMatrixAction * action) [virtual]

action method for SoGetMatrixAction. updates action by accumulating with the transformation matrix of this node (if any) 📐

Reimplemented from SoNode.

void SoProfilerStats::pick (SoPickAction * action) [virtual]

action method for SoPickAction. does common processing for SoPickAction action instances ✨

Reimplemented from SoNode.

void SoProfilerStats::search (SoSearchAction * action) [virtual]

action method for SoSearchAction. compares the search criteria from the action to see if this node is a match 🔍

searching is done by matching up all criteria set up in the SoSearchAction — if any of the requested criteria is a miss, the search is not deemed successful for the node. harsh but fair 💀

See also: SoSearchAction

Reimplemented from SoNode.

void SoProfilerStats::write (SoWriteAction * action) [virtual]

action method for SoWriteAction. writes out a node object, and any connected nodes, engines etc, if necessary ✍️

Reimplemented from SoNode.

void SoProfilerStats::notify (SoNotList * l) [protected], [virtual]

notifies all auditors for this instance when changes are made 📢

Reimplemented from SoNode.

🌈 Member Data Documentation 🌈

SoMFName SoProfilerStats::renderedNodeType

name of types traversed during the current render traversal 👑

this field is tightly connected to the renderingTimePerNodeType field — like, they're literally besties — because it will contain the same number of elements, and each value in renderingTimePerNodeType matches the node type with the same index in this field.

See also: SoProfilerStats::renderingTimePerNodeType

SoMFTime SoProfilerStats::renderingTimePerNodeType

time spent, during the current render traversal, per node type ⏱️

this field is tightly connected to the renderedNodeType field, because it will contain the same number of elements, and each value in this field matches the node type with the same index in renderedNodeType.

See also: SoProfilerStats::renderedNodeType

🫶 Author 🫶

generated automatically by Doxygen for Coin from the source code. not a human hand in sight, she's fully auto-generated and still ate 💅

okay bestie that's the whole page!! this one's from Coin version 4.0.10, dated Thu Jun 25 2026 00:00:00, and it's the SoProfilerStats(3) manual page 💖 go forth and profile responsibly, mwah 🎀✨

📦 where this page comes from