.TH "SoProfilerElement" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "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
\fC#include <Inventor/annex/Profiler/SoProfilerElement\&.h>\fP
.PP
Inherits \fBSoElement\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBvirtual\fP SbBool \fBmatches\fP (\fBconst\fP \fBSoElement\fP *element) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBSoElement\fP * \fBcopyMatchInfo\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSbProfilingData\fP & \fBgetProfilingData\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBconst\fP \fBSbProfilingData\fP & \fBgetProfilingData\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

Public Member Functions inherited from \fBSoElement\fP
.in +1c
.ti -1c
.RI "\fBconst\fP \fBSoType\fP \fBgetTypeId\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "int \fBgetStackIndex\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBinit\fP (\fBSoState\fP *state)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetDepth\fP (\fBconst\fP int \fBdepth\fP)"
.br
.ti -1c
.RI "int \fBgetDepth\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBprint\fP (\fBFILE\fP *\fBfile\fP=\fBstdout\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fB~SoElement\fP ()"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetClassStackIndex\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP * \fBcreateInstance\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.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 "\fBstatic\fP \fBSoProfilerElement\fP * \fBget\fP (\fBSoState\fP *state)"
.br
.in -1c

Static Public Member Functions inherited from \fBSoElement\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitClass\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetClassTypeId\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetClassStackIndex\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBvoid\fP \fBinitElements\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP int \fBgetNumStackIndices\fP (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBstatic\fP \fBSoType\fP \fBgetIdFromStackIndex\fP (\fBconst\fP 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 (\fBvoid\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBcapture\fP (\fBSoState\fP *\fBconst\fP state) \fBconst\fP"
.br
.ti -1c
.RI "\fBvirtual\fP \fBvoid\fP \fBcaptureThis\fP (\fBSoState\fP *state) \fBconst\fP"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetTypeId\fP (\fBconst\fP \fBSoType\fP \fBtypeId\fP)"
.br
.ti -1c
.RI "\fBvoid\fP \fBsetStackIndex\fP (\fBconst\fP int index)"
.br
.ti -1c
.RI "\fBSoElement\fP * \fBgetNextInStack\fP (\fBvoid\fP) \fBconst\fP"
.br
.ti -1c
.RI "\fBSoElement\fP * \fBgetNextFree\fP (\fBvoid\fP) \fBconst\fP"
.br
.in -1c

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

Static Protected Attributes inherited from \fBSoElement\fP
.in +1c
.ti -1c
.RI "\fBstatic\fP int \fBclassStackIndex\fP"
.br
.ti -1c
.RI "\fBstatic\fP \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 (\fBvoid\fP)\fC [static]\fP"
This static method returns the \fBSoType\fP object associated with objects of this class\&. 
.br
 
.SS "int SoProfilerElement::getClassStackIndex (\fBvoid\fP)\fC [static]\fP"
This static method returns the state stack index for the class\&. 
.br
 
.SS "\fBvoid\fP * SoProfilerElement::createInstance (\fBvoid\fP)\fC [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\&. 
.br
 
.SS "\fBSoProfilerElement\fP * SoProfilerElement::get (\fBSoState\fP * state)\fC [static]\fP"
This is the required method of fetching the \fBSoProfilerElement\fP instance\&. 
.SS "SbBool SoProfilerElement::matches (\fBconst\fP \fBSoElement\fP * element) const\fC [virtual]\fP"
This function returns \fCTRUE\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 (\fBvoid\fP) const\fC [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\&.