SoProfilerElement(3)

πŸ“¦ version 3.1.3, in fedora 43, fedora 44

✨ NAME ✨

okay so bestie, welcome to the SoProfilerElement(3) page πŸ’– β€” this one lives in the Library Functions Manual and it's all about SoProfilerElement: the element class that's for registering statistics during scene graph traversals. no cap, that's literally her whole job πŸŽ€


🌸 SYNOPSIS 🌸

#include <Inventor/annex/Profiler/SoProfilerElement.h>

Inherits SoElement. she got it from her mom, iconic πŸ‘‘

πŸ’… Public Member Functions πŸ’…

  • virtual SbBool matches (const SoElement *element) const β€” the cache-validity match check 🫢
  • virtual SoElement * copyMatchInfo (void) const β€” makes the copy that lets matches() do its thing ✨
  • SbProfilingData & getProfilingData (void) β€” hands you the SbProfilingData πŸ“
  • const SbProfilingData & getProfilingData (void) const β€” same but const, we love a const queen πŸ’œ

Public Member Functions inherited from SoElement

  • const SoType getTypeId (void) const
  • int getStackIndex (void) const
  • virtual void init (SoState *state)
  • void setDepth (const int depth)
  • int getDepth (void) const
  • virtual void print (FILE *file=stdout) const
  • virtual ~SoElement ()

⭐ Static Public Member Functions ⭐

  • static SoType getClassTypeId (void)
  • static int getClassStackIndex (void)
  • static void * createInstance (void)
  • static void initClass (void)
  • static SoProfilerElement * get (SoState *state)

Static Public Member Functions inherited from SoElement

  • static void initClass (void)
  • static SoType getClassTypeId (void)
  • static int getClassStackIndex (void)
  • static void initElements (void)
  • static int getNumStackIndices (void)
  • static SoType getIdFromStackIndex (const int stackIndex)

πŸ¦‹ Protected Attributes πŸ¦‹

  • SbProfilingData data

Protected Attributes inherited from SoElement

  • SoType typeId
  • int stackIndex
  • int depth

🌈 Additional Inherited Members 🌈

Protected Member Functions inherited from SoElement

  • SoElement (void)
  • void capture (SoState *const state) const
  • virtual void captureThis (SoState *state) const
  • void setTypeId (const SoType typeId)
  • void setStackIndex (const int index)
  • SoElement * getNextInStack (void) const
  • SoElement * getNextFree (void) const

Static Protected Member Functions inherited from SoElement

  • static SoElement * getElement (SoState *const state, const int stackIndex)
  • static const SoElement * getConstElement (SoState *const state, const int stackIndex)
  • static int createStackIndex (const SoType id)

Static Protected Attributes inherited from SoElement

  • static int classStackIndex
  • static SoTypeList * stackToType

πŸ“– Detailed Description πŸ“–

The SoProfilerElement element class is for registering statistics during scene graph traversals. that's the vibe, that's the whole assignment πŸ’…


πŸ’– Member Function Documentation πŸ’–

void * SoProfilerElement::createInstance (void ) [static]

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer. so like… respectfully, don't touch, she's doing backend stuff πŸ™ˆ

SoProfilerElement * SoProfilerElement::get (SoState * state) [static]

This is the required method of fetching the SoProfilerElement instance. this is the one you actually reach for, bestie 🫢

SbBool SoProfilerElement::matches (const SoElement * element) const [virtual]

This function returns TRUE if the element matches another element (of the same class), with respect to cache validity.

If the application programmer's extension element has a matches() function, it should also have a copyMatchInfo() function. they're a package deal, fr fr πŸŽ€

Implements SoElement.

SoElement * SoProfilerElement::copyMatchInfo (void ) const [virtual]

This function creates a copy of the element that contains enough information to enable the matches() function to work.

Used to help with scenegraph traversal caching operations.

Implements SoElement.


✍️ Author ✍️

Generated automatically by Doxygen for Coin from the source code. she was born in a doc generator and she's still slaying 😭✨


and that's the whole page, bestie β€” sending you off with the official sign-off: this is Coin, Version 3.1.3, page SoProfilerElement(3). periodt πŸ’œπŸ‘‘

πŸ“¦ where this page comes from