.TH "SoAccumulatedElement" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoAccumulatedElement \- The \fBSoAccumulatedElement\fP class is an abstract class for storing accumulated state\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSoElement\fP\&. .PP Inherited by \fBSoBumpMapMatrixElement\fP, \fBSoClipPlaneElement\fP, \fBSoLightElement\fP, \fBSoModelMatrixElement\fP, \fBSoMultiTextureMatrixElement\fP, \fBSoProfileElement\fP, and \fBSoVertexAttributeElement\fP\&. .SS "Public Member Functions" .in +1c .ti -1c .RI "\fBvirtual\fP SbBool \fBmatches\fP (\fBconst\fP \fBSoElement\fP *element) \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 \fBpop\fP (\fBSoState\fP *state, \fBconst\fP \fBSoElement\fP *\fBprevTopElement\fP)" .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 \fBinitClass\fP (\fBvoid\fP)" .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 Member Functions" .in +1c .ti -1c .RI "\fBvirtual\fP \fB~SoAccumulatedElement\fP ()" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBinit\fP (\fBSoState\fP *state)" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBpush\fP (\fBSoState\fP *state)" .br .ti -1c .RI "\fBvoid\fP \fBclearNodeIds\fP (\fBvoid\fP)" .br .ti -1c .RI "\fBvoid\fP \fBaddNodeId\fP (\fBconst\fP \fBSoNode\fP *\fBconst\fP node)" .br .ti -1c .RI "\fBvoid\fP \fBsetNodeId\fP (\fBconst\fP \fBSoNode\fP *\fBconst\fP node)" .br .ti -1c .RI "\fBvoid\fP \fBcopyNodeIds\fP (\fBconst\fP \fBSoAccumulatedElement\fP *\fBcopyfrom\fP)" .br .ti -1c .RI "\fBvirtual\fP \fBSoElement\fP * \fBcopyMatchInfo\fP (\fBvoid\fP) \fBconst\fP" .br .ti -1c .RI "\fBvirtual\fP \fBvoid\fP \fBcaptureThis\fP (\fBSoState\fP *state) \fBconst\fP" .br .in -1c 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 "\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 .SS "Protected Attributes" .in +1c .ti -1c .RI "\fBSbList\fP< SbUniqueId > \fBnodeIds\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" 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 \fBSoAccumulatedElement\fP class is an abstract class for storing accumulated state\&. This is the superclass of elements where new element data \fIaccumulates\fP with older data\&. .PP 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\&. .PP \fBSee also\fP .RS 4 \fBSoReplacedElement\fP, \fBSoFloatElement\fP, \fBSoInt32Element\fP .RE .PP .SH "Constructor & Destructor Documentation" .PP .SS "SoAccumulatedElement::~SoAccumulatedElement (\fBvoid\fP)\fC [protected]\fP, \fC [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoAccumulatedElement::getClassTypeId (\fBvoid\fP)\fC [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .br .SS "int SoAccumulatedElement::getClassStackIndex (\fBvoid\fP)\fC [static]\fP" This static method returns the state stack index for the class\&. .br .SS "\fBvoid\fP SoAccumulatedElement::initClass (\fBvoid\fP)\fC [static]\fP" Initialize relevant common data for all instances, like the type system\&. .SS "SbBool SoAccumulatedElement::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\&. .PP Reimplemented in \fBSoModelMatrixElement\fP\&. .SS "\fBvoid\fP SoAccumulatedElement::init (\fBSoState\fP * state)\fC [protected]\fP, \fC [virtual]\fP" This function initializes the element type in the given \fBSoState\fP\&. It is called for the first element of each enabled element type in \fBSoState\fP objects\&. .PP Reimplemented from \fBSoElement\fP\&. .PP Reimplemented in \fBSoBBoxModelMatrixElement\fP, \fBSoBumpMapMatrixElement\fP, \fBSoClipPlaneElement\fP, \fBSoGLClipPlaneElement\fP, \fBSoGLModelMatrixElement\fP, \fBSoGLMultiTextureMatrixElement\fP, \fBSoGLVertexAttributeElement\fP, \fBSoLightElement\fP, \fBSoModelMatrixElement\fP, \fBSoMultiTextureMatrixElement\fP, \fBSoProfileElement\fP, and \fBSoVertexAttributeElement\fP\&. .SS "\fBvoid\fP SoAccumulatedElement::push (\fBSoState\fP * state)\fC [protected]\fP, \fC [virtual]\fP" 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 \fBSoState::getElement()\fP or indirectly \fBSoElement::getElement()\fP, and the depth of the current element is less than the state depth\&. .PP Override this method if your element needs to copy data from the previous top of stack\&. The \fBpush()\fP method is called on the new element, and the previous element can be found using \fBSoElement::getNextInStack()\fP\&. .PP Reimplemented from \fBSoElement\fP\&. .PP Reimplemented in \fBSoBBoxModelMatrixElement\fP, \fBSoBumpMapMatrixElement\fP, \fBSoClipPlaneElement\fP, \fBSoGLModelMatrixElement\fP, \fBSoGLMultiTextureMatrixElement\fP, \fBSoLightElement\fP, \fBSoModelMatrixElement\fP, \fBSoMultiTextureMatrixElement\fP, \fBSoProfileElement\fP, and \fBSoVertexAttributeElement\fP\&. .SS "\fBvoid\fP SoAccumulatedElement::clearNodeIds (\fBvoid\fP)\fC [protected]\fP" Empty the list of node ids\&. .SS "\fBvoid\fP SoAccumulatedElement::addNodeId (\fBconst\fP \fBSoNode\fP *\fBconst\fP node)\fC [protected]\fP" Add the node id of \fInode\fP to the list of node ids\&. .SS "\fBvoid\fP SoAccumulatedElement::setNodeId (\fBconst\fP \fBSoNode\fP *\fBconst\fP node)\fC [protected]\fP" Empty the list of node ids, and add the id of \fInode\fP\&. .SS "\fBvoid\fP SoAccumulatedElement::copyNodeIds (\fBconst\fP \fBSoAccumulatedElement\fP * copyfrom)\fC [protected]\fP" Convenience method which copies the node ids from \fIcopyfrom\fP to this element\&. .PP This function is an extension for Coin, and it is not available in the original SGI Open Inventor \fBv2\&.1\fP API\&. .br .SS "\fBSoElement\fP * SoAccumulatedElement::copyMatchInfo (\fBvoid\fP) const\fC [protected]\fP, \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\&. .SS "\fBvoid\fP SoAccumulatedElement::captureThis (\fBSoState\fP * state) const\fC [protected]\fP, \fC [virtual]\fP" Adds the element to the cache\&. .PP Reimplemented from \fBSoElement\fP\&. .SH "Member Data Documentation" .PP .SS "SoAccumulatedElement::nodeIds\fC [protected]\fP" Stores the internal list of node id values for nodes accumulated on the stack for the element\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.