.TH "SoProfilerElement" 3 "Tue Jun 23 2026 23:48:38" "Version 4.0.10" "Coin" \" -*- nroff -*-
.ad l
.nh
.SH NAME
SoProfilerElement \- The \fBSoProfilerElement\fP element class is for registering statistics during scene graph traversals\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fR#include <Inventor/annex/Profiler/SoProfilerElement\&.h>\fP
.PP
Inherits \fBSoElement\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual SbBool \fBmatches\fP (const \fBSoElement\fP *element) const"
.br
.ti -1c
.RI "virtual \fBSoElement\fP * \fBcopyMatchInfo\fP (void) const"
.br
.ti -1c
.RI "\fBSbProfilingData\fP & \fBgetProfilingData\fP (void)"
.br
.ti -1c
.RI "const \fBSbProfilingData\fP & \fBgetProfilingData\fP (void) const"
.br
.in -1c

Public Member Functions inherited from \fBSoElement\fP
.in +1c
.ti -1c
.RI "const \fBSoType\fP \fBgetTypeId\fP (void) const"
.br
.ti -1c
.RI "int \fBgetStackIndex\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBinit\fP (\fBSoState\fP *state)"
.br
.ti -1c
.RI "void \fBsetDepth\fP (const int \fBdepth\fP)"
.br
.ti -1c
.RI "int \fBgetDepth\fP (void) const"
.br
.ti -1c
.RI "virtual void \fBprint\fP (FILE *file=stdout) const"
.br
.ti -1c
.RI "virtual \fB~SoElement\fP ()"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static int \fBgetClassStackIndex\fP (void)"
.br
.ti -1c
.RI "static void * \fBcreateInstance\fP (void)"
.br
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.RI "Sets up initialization for data common to all instances of this class, like submitting necessary information to the Coin type system\&.    "
.ti -1c
.RI "static \fBSoProfilerElement\fP * \fBget\fP (\fBSoState\fP *state)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoElement\fP
.in +1c
.ti -1c
.RI "static void \fBinitClass\fP (void)"
.br
.ti -1c
.RI "static \fBSoType\fP \fBgetClassTypeId\fP (void)"
.br
.ti -1c
.RI "static int \fBgetClassStackIndex\fP (void)"
.br
.ti -1c
.RI "static void \fBinitElements\fP (void)"
.br
.ti -1c
.RI "static int \fBgetNumStackIndices\fP (void)"
.br
.ti -1c
.RI "static \fBSoType\fP \fBgetIdFromStackIndex\fP (const int \fBstackIndex\fP)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "\fBSbProfilingData\fP \fBdata\fP"
.br
.in -1c

Protected Attributes inherited from \fBSoElement\fP
.in +1c
.ti -1c
.RI "\fBSoType\fP \fBtypeId\fP"
.br
.ti -1c
.RI "int \fBstackIndex\fP"
.br
.ti -1c
.RI "int \fBdepth\fP"
.br
.in -1c
.SS "Additional Inherited Members"


Protected Member Functions inherited from \fBSoElement\fP
.in +1c
.ti -1c
.RI "\fBSoElement\fP (void)"
.br
.ti -1c
.RI "void \fBcapture\fP (\fBSoState\fP *const state) const"
.br
.ti -1c
.RI "virtual void \fBcaptureThis\fP (\fBSoState\fP *state) const"
.br
.ti -1c
.RI "void \fBsetTypeId\fP (const \fBSoType\fP \fBtypeId\fP)"
.br
.ti -1c
.RI "void \fBsetStackIndex\fP (const int index)"
.br
.ti -1c
.RI "\fBSoElement\fP * \fBgetNextInStack\fP (void) const"
.br
.ti -1c
.RI "\fBSoElement\fP * \fBgetNextFree\fP (void) const"
.br
.in -1c

Static Protected Member Functions inherited from \fBSoElement\fP
.in +1c
.ti -1c
.RI "static \fBSoElement\fP * \fBgetElement\fP (\fBSoState\fP *const state, const int \fBstackIndex\fP)"
.br
.ti -1c
.RI "static const \fBSoElement\fP * \fBgetConstElement\fP (\fBSoState\fP *const state, const int \fBstackIndex\fP)"
.br
.ti -1c
.RI "static int \fBcreateStackIndex\fP (const \fBSoType\fP id)"
.br
.in -1c

Static Protected Attributes inherited from \fBSoElement\fP
.in +1c
.ti -1c
.RI "static int \fBclassStackIndex\fP"
.br
.ti -1c
.RI "static \fBSoTypeList\fP * \fBstackToType\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBSoProfilerElement\fP element class is for registering statistics during scene graph traversals\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBSoType\fP SoProfilerElement::getClassTypeId (void )\fR [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.SS "int SoProfilerElement::getClassStackIndex (void )\fR [static]\fP"
This static method returns the state stack index for the class\&. 
.SS "void * SoProfilerElement::createInstance (void )\fR [static]\fP"
\fIThis API member is considered internal to the library, as it is not likely to be of interest to the application programmer\&.\fP
.br

.br
 Creates a new instance of the class type corresponding to the \fBSoType\fP object\&. 
.SS "\fBSoProfilerElement\fP * SoProfilerElement::get (\fBSoState\fP * state)\fR [static]\fP"
This is the required method of fetching the \fBSoProfilerElement\fP instance\&. 
.SS "SbBool SoProfilerElement::matches (const \fBSoElement\fP * element) const\fR [virtual]\fP"
This function returns \fRTRUE\fP is the element matches another element (of the same class), with respect to cache validity\&.

.PP
If the application programmer's extension element has a \fBmatches()\fP function, it should also have a \fBcopyMatchInfo()\fP function\&. 
.PP
Implements \fBSoElement\fP\&.
.SS "\fBSoElement\fP * SoProfilerElement::copyMatchInfo (void ) const\fR [virtual]\fP"
This function creates a copy of the element that contains enough information to enable the \fBmatches()\fP function to work\&.

.PP
Used to help with scene graph traversal caching operations\&. 
.PP
Implements \fBSoElement\fP\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for Coin from the source code\&.