.TH "SoCacheElement" 3 "Tue Dec 26 2023 17:59:22" "Version 4.0.2" "Coin" \" -*- nroff -*- .ad l .nh .SH NAME SoCacheElement \- The \fBSoCacheElement\fP class stores and manages the open caches\&. .SH SYNOPSIS .br .PP .PP \fC#include \fP .PP Inherits \fBSoElement\fP\&. .SS "Public Member Functions" .in +1c .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 "\fBvirtual\fP \fBvoid\fP \fBpop\fP (\fBSoState\fP *state, \fBconst\fP \fBSoElement\fP *\fBprevTopElement\fP)" .br .ti -1c .RI "\fBSoCache\fP * \fBgetCache\fP (\fBvoid\fP) \fBconst\fP" .br .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 "\fBSoCacheElement\fP * \fBgetNextCacheElement\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 "\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 .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBset\fP (\fBSoState\fP *\fBconst\fP state, \fBSoCache\fP *\fBconst\fP cache)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBanyOpen\fP (\fBSoState\fP *\fBconst\fP state)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBinvalidate\fP (\fBSoState\fP *\fBconst\fP state)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBaddElement\fP (\fBSoState\fP *\fBconst\fP state, \fBconst\fP \fBSoElement\fP *\fBconst\fP element)" .br .ti -1c .RI "\fBstatic\fP \fBvoid\fP \fBaddCacheDependency\fP (\fBSoState\fP *\fBconst\fP state, \fBSoCache\fP *\fBconst\fP cache)" .br .ti -1c .RI "\fBstatic\fP SbBool \fBsetInvalid\fP (\fBconst\fP SbBool \fBnewvalue\fP)" .br .ti -1c .RI "\fBstatic\fP \fBSoCache\fP * \fBgetCurrentCache\fP (\fBSoState\fP *\fBconst\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 Member Functions" .in +1c .ti -1c .RI "\fBvirtual\fP \fB~SoCacheElement\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 "\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 .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 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 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 \fBSoCacheElement\fP class stores and manages the open caches\&. .SH "Constructor & Destructor Documentation" .PP .SS "SoCacheElement::~SoCacheElement (\fBvoid\fP)\fC [protected]\fP, \fC [virtual]\fP" Destructor\&. .SH "Member Function Documentation" .PP .SS "\fBSoType\fP SoCacheElement::getClassTypeId (\fBvoid\fP)\fC [static]\fP" This static method returns the \fBSoType\fP object associated with objects of this class\&. .br .SS "int SoCacheElement::getClassStackIndex (\fBvoid\fP)\fC [static]\fP" This static method returns the state stack index for the class\&. .br .SS "\fBvoid\fP * SoCacheElement::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 "\fBvoid\fP SoCacheElement::initClass (\fBvoid\fP)\fC [static]\fP" Initialize relevant common data for all instances, like the type system\&. .SS "\fBvoid\fP SoCacheElement::init (\fBSoState\fP * state)\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\&. .SS "\fBvoid\fP SoCacheElement::push (\fBSoState\fP * state)\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\&. .SS "\fBvoid\fP SoCacheElement::pop (\fBSoState\fP * state, \fBconst\fP \fBSoElement\fP * prevTopElement)\fC [virtual]\fP" This method is called when the state is popped, and the depth of the element is bigger than the current state depth\&. \fBpop()\fP is called on the new top of stack, and a pointer to the previous top of stack is passed in \fIprevTopElement\fP\&. .PP Override this method if you need to copy some state information from the previous top of stack\&. .PP Reimplemented from \fBSoElement\fP\&. .SS "\fBvoid\fP SoCacheElement::set (\fBSoState\fP *\fBconst\fP state, \fBSoCache\fP *\fBconst\fP cache)\fC [static]\fP" Sets the current cache\&. The cache is ref'ed before returning\&. .SS "\fBSoCache\fP * SoCacheElement::getCache (\fBvoid\fP) const" This method returns the cache, or NULL if there is no cache\&. .SS "SbBool SoCacheElement::anyOpen (\fBSoState\fP *\fBconst\fP state)\fC [static]\fP" This method returns TRUE if a cache is currently open\&. .SS "\fBvoid\fP SoCacheElement::invalidate (\fBSoState\fP *\fBconst\fP state)\fC [static]\fP" This method invalidates open caches\&. It should be called by uncacheable nodes\&. .SS "SbBool SoCacheElement::matches (\fBconst\fP \fBSoElement\fP * element) const\fC [virtual]\fP" \fBSoCacheElement\fP objects should not be compared because you obviously don't cache them in the cache\&. .PP Implements \fBSoElement\fP\&. .SS "\fBSoElement\fP * SoCacheElement::copyMatchInfo (\fBvoid\fP) const\fC [virtual]\fP" \fBSoCacheElement\fP objects should not be 'copied' because you obviously don't cache them in the cache\&. .PP \fBSee also\fP .RS 4 SbBool \fBSoCacheElement::matches(const SoElement * element) const\fP .RE .PP .PP Implements \fBSoElement\fP\&. .SS "\fBSoCacheElement\fP * SoCacheElement::getNextCacheElement (\fBvoid\fP) const" This method returns the next cache element\&. That is the next cache element pointing towards the bottom of the state\&. .SS "\fBvoid\fP SoCacheElement::addElement (\fBSoState\fP *\fBconst\fP state, \fBconst\fP \fBSoElement\fP *\fBconst\fP element)\fC [static]\fP" This method adds \fIelement\fP to the elements used lists of all the open caches in \fIstate\fP\&. .SS "\fBvoid\fP SoCacheElement::addCacheDependency (\fBSoState\fP *\fBconst\fP state, \fBSoCache\fP *\fBconst\fP cache)\fC [static]\fP" This method creates dependencies on \fIcache\fP for all the open caches in \fIstate\fP\&. .SS "SbBool SoCacheElement::setInvalid (\fBconst\fP SbBool newvalue)\fC [static]\fP" This method returns the old invalidated bit value, and sets it to \fInewvalue\fP\&. .SS "\fBSoCache\fP * SoCacheElement::getCurrentCache (\fBSoState\fP *\fBconst\fP state)\fC [static]\fP" This method returns the current cache\&. No cache dependencies are honored\&. .SH "Author" .PP Generated automatically by Doxygen for Coin from the source code\&.