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:

Public Member Functions
virtual SoElement *	copyMatchInfo (void) const
SbProfilingData &	getProfilingData (void)
const SbProfilingData &	getProfilingData (void) const
virtual SbBool	matches (const SoElement *element) const
Public Member Functions inherited from SoElement
virtual	~SoElement ()
int	getDepth (void) const
int	getStackIndex (void) const
const SoType	getTypeId (void) const
virtual void	init (SoState *state)
virtual void	print (FILE *file=stdout) const
void	setDepth (const int depth)

Static Public Member Functions
static void *	createInstance (void)
static SoProfilerElement *	get (SoState *state)
static int	getClassStackIndex (void)
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.
Static Public Member Functions inherited from SoElement
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static SoType	getIdFromStackIndex (const int stackIndex)
static int	getNumStackIndices (void)
static void	initClass (void)
static void	initElements (void)

Protected Attributes
SbProfilingData	data
Protected Attributes inherited from SoElement
int	depth
int	stackIndex
SoType	typeId

Additional Inherited Members
Protected Member Functions inherited from SoElement
	SoElement (void)
void	capture (SoState *const state) const
virtual void	captureThis (SoState *state) const
SoElement *	getNextFree (void) const
SoElement *	getNextInStack (void) const
void	setStackIndex (const int index)
void	setTypeId (const SoType typeId)
Static Protected Member Functions inherited from SoElement
static int	createStackIndex (const SoType id)
static const SoElement *	getConstElement (SoState *const state, const int stackIndex)
static SoElement *	getElement (SoState *const state, const int stackIndex)
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.

Member Function Documentation

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.

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.

Creates a new instance of the class type corresponding to the SoType object.

get()

SoProfilerElement * SoProfilerElement::get ( SoState * state )

static

This is the required method of fetching the SoProfilerElement instance.

getClassStackIndex()

int SoProfilerElement::getClassStackIndex ( void )

static

This static method returns the state stack index for the class.

getClassTypeId()

SoType SoProfilerElement::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

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.

---

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

• SoProfilerElement.h
• SoProfilerElement.cpp