SoAccumulatedElement Class Reference

The SoAccumulatedElement class is an abstract class for storing accumulated state. More...

#include <Inventor/elements/SoAccumulatedElement.h>

Inheritance diagram for SoAccumulatedElement:

Public Member Functions
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	pop (SoState *state, const SoElement *prevTopElement)
virtual void	print (FILE *file=stdout) const
void	setDepth (const int depth)

Static Public Member Functions
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static void	initClass (void)
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 Member Functions
virtual	~SoAccumulatedElement ()
void	addNodeId (const SoNode *const node)
virtual void	captureThis (SoState *state) const
void	clearNodeIds (void)
virtual SoElement *	copyMatchInfo (void) const
void	copyNodeIds (const SoAccumulatedElement *copyfrom)
virtual void	init (SoState *state)
virtual void	push (SoState *state)
void	setNodeId (const SoNode *const node)
Protected Member Functions inherited from SoElement
	SoElement (void)
void	capture (SoState *const state) const
SoElement *	getNextFree (void) const
SoElement *	getNextInStack (void) const
void	setStackIndex (const int index)
void	setTypeId (const SoType typeId)

Protected Attributes
SbList< SbUniqueId >	nodeIds
Protected Attributes inherited from SoElement
int	depth
int	stackIndex
SoType	typeId

Additional Inherited Members
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 SoAccumulatedElement class is an abstract class for storing accumulated state.

This is the superclass of elements where new element data accumulates with older data.

The element stores node id values for all nodes accumulated during traversal for the current state. These id values are used to determine when to invalidate caches.

See also

SoReplacedElement, SoFloatElement, SoInt32Element

Constructor & Destructor Documentation

~SoAccumulatedElement()

SoAccumulatedElement::~SoAccumulatedElement ( void )

protectedvirtual

Destructor.

Member Function Documentation

addNodeId()

void SoAccumulatedElement::addNodeId ( const SoNode *const node )

protected

Add the node id of node to the list of node ids.

captureThis()

void SoAccumulatedElement::captureThis ( SoState * state ) const

protectedvirtual

Adds the element to the cache.

Reimplemented from SoElement.

clearNodeIds()

void SoAccumulatedElement::clearNodeIds ( void )

protected

Empty the list of node ids.

copyMatchInfo()

SoElement * SoAccumulatedElement::copyMatchInfo ( void ) const

protectedvirtual

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.

copyNodeIds()

void SoAccumulatedElement::copyNodeIds ( const SoAccumulatedElement * copyfrom )

protected

Convenience method which copies the node ids from copyfrom to this element.

This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

getClassStackIndex()

int SoAccumulatedElement::getClassStackIndex ( void )

static

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

getClassTypeId()

SoType SoAccumulatedElement::getClassTypeId ( void )

static

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

init()

void SoAccumulatedElement::init ( SoState * state )

protectedvirtual

This function initializes the element type in the given SoState. It is called for the first element of each enabled element type in SoState objects.

Reimplemented from SoElement.

Reimplemented in SoBBoxModelMatrixElement, SoBumpMapMatrixElement, SoClipPlaneElement, SoGLClipPlaneElement, SoGLModelMatrixElement, SoGLMultiTextureMatrixElement, SoGLVertexAttributeElement, SoLightElement, SoModelMatrixElement, SoMultiTextureMatrixElement, SoProfileElement, and SoVertexAttributeElement.

initClass()

void SoAccumulatedElement::initClass ( void )

static

Initialize relevant common data for all instances, like the type system.

matches()

SbBool SoAccumulatedElement::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.

Reimplemented in SoModelMatrixElement.

push()

void SoAccumulatedElement::push ( SoState * state )

protectedvirtual

This method is called every time a new element is required in one of the stacks. This happens when a writable element is requested, using SoState::getElement() or indirectly SoElement::getElement(), and the depth of the current element is less than the state depth.

Override this method if your element needs to copy data from the previous top of stack. The push() method is called on the new element, and the previous element can be found using SoElement::getNextInStack().

Reimplemented from SoElement.

Reimplemented in SoBBoxModelMatrixElement, SoBumpMapMatrixElement, SoClipPlaneElement, SoGLModelMatrixElement, SoGLMultiTextureMatrixElement, SoLightElement, SoModelMatrixElement, SoMultiTextureMatrixElement, SoProfileElement, and SoVertexAttributeElement.

setNodeId()

void SoAccumulatedElement::setNodeId ( const SoNode *const node )

protected

Empty the list of node ids, and add the id of node.

Member Data Documentation

nodeIds

SoAccumulatedElement::nodeIds

protected

Stores the internal list of node id values for nodes accumulated on the stack for the element.

---

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

• SoAccumulatedElement.h
• SoAccumulatedElement.cpp