Coin Logo http://www.sim.no
http://www.coin3d.org

SoAccumulatedElement Class Reference
[Elements (mostly for internal use)]

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. More...

#include <Inventor/elements/SoAccumulatedElement.h>

Inheritance diagram for SoAccumulatedElement:

SoElement

List of all members.

Public Member Functions

virtual SbBool matches (const SoElement *element) const

Static Public Member Functions

static SoType getClassTypeId (void)
static int getClassStackIndex (void)
static void initClass (void)

Protected Member Functions

void init (SoState *state)
void push (SoState *state)
void clearNodeIds (void)
void addNodeId (const SoNode *const node)
void setNodeId (const SoNode *const node)
void copyNodeIds (const SoAccumulatedElement *copyfrom)
virtual SoElementcopyMatchInfo (void) const
virtual void captureThis (SoState *state) const

Protected Attributes

SbList< uint32_t > nodeIds


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

Member Function Documentation

SoType SoAccumulatedElement::getClassTypeId ( void   )  [static]

This static method returns the class type.

Reimplemented from SoElement.

int SoAccumulatedElement::getClassStackIndex ( void   )  [static]

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

Reimplemented from SoElement.

void SoAccumulatedElement::initClass ( void   )  [static]

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

Reimplemented from SoElement.

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.

References nodeIds.

void SoAccumulatedElement::init ( SoState state  )  [protected, virtual]

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.

References SoElement::init().

void SoAccumulatedElement::push ( SoState state  )  [protected, virtual]

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.

References SoElement::push().

void SoAccumulatedElement::clearNodeIds ( void   )  [protected]

Empty the list of node ids.

References nodeIds, and SbList< Type >::truncate().

Referenced by setNodeId().

void SoAccumulatedElement::addNodeId ( const SoNode *const   node  )  [protected]

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

References SbList< Type >::append(), SoNode::getNodeId(), and nodeIds.

Referenced by setNodeId().

void SoAccumulatedElement::setNodeId ( const SoNode *const   node  )  [protected]

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

References addNodeId(), and clearNodeIds().

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.

References nodeIds.

Referenced by copyMatchInfo().

SoElement * SoAccumulatedElement::copyMatchInfo ( void   )  const [protected, virtual]

This function creates a copy of the element that contains enough information to enable the matches() function to work.

Used to help with scenegraph traversal caching operations.

Implements SoElement.

References copyNodeIds(), SoType::createInstance(), and SoElement::getTypeId().

void SoAccumulatedElement::captureThis ( SoState state  )  const [protected, virtual]

Adds the element to the cache.

Reimplemented from SoElement.

References captureThis(), SoElement::captureThis(), and SoElement::getNextInStack().

Referenced by captureThis().


Member Data Documentation

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

Referenced by addNodeId(), clearNodeIds(), copyNodeIds(), and matches().


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

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Mon Feb 23 16:33:42 2009 for Coin by Doxygen. 1.5.8