Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoProfilerElement Class Reference

The SoProfilerElement element class is for registering statistics during scene graph traversals. More...

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

Inheritance diagram for SoProfilerElement:
SoElement

Public Member Functions

virtual SbBool matches (const SoElement *element) const
 
virtual SoElementcopyMatchInfo (void) const
 
SbProfilingDatagetProfilingData (void)
 
const SbProfilingDatagetProfilingData (void) const
 
- 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 SoProfilerElementget (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)
 
SoElementgetNextInStack (void) const
 
SoElementgetNextFree (void) const
 
- Static Protected Member Functions inherited from SoElement
static SoElementgetElement (SoState *const state, const int stackIndex)
 
static const SoElementgetConstElement (SoState *const state, const int stackIndex)
 
static int createStackIndex (const SoType id)
 
- Static Protected Attributes inherited from SoElement
static int classStackIndex
 
static SoTypeListstackToType
 

Detailed Description

The SoProfilerElement element class is for registering statistics during scene graph traversals.

Member Function Documentation

◆ createInstance()

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.

◆ get()

SoProfilerElement * SoProfilerElement::get ( SoState state)
static

This is the required method of fetching the SoProfilerElement instance.

◆ matches()

SbBool SoProfilerElement::matches ( const SoElement element) const
virtual

This function returns TRUE is 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.

Implements SoElement.

◆ copyMatchInfo()

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 scene graph traversal caching operations.

Implements SoElement.


The documentation for this class was generated from the following files: