SoCacheElement(3)

💖 SoCacheElement(3) — the Coin manual, but make it make sense 💖

okay bestie, pull up a chair 🫶 this is the SoCacheElement page from the Coin manual, and it's literally the class that stores and manages the open caches. yes, that's the whole vibe. let's get into it ✨

---

🌸 NAME 🌸

SoCacheElement — the class that stores and manages the open caches. that's it. that's the girl. 💅

---

✨ SYNOPSIS ✨

first things first, you gotta let the compiler know she exists:

#include <Inventor/elements/SoCacheElement.h>

and she inherits SoElement, obviously. family lineage matters. 👑

🎀 Public Member Functions

virtual void init (SoState *state)
virtual void push (SoState *state)
virtual void pop (SoState *state, const SoElement *prevTopElement)
SoCache * getCache (void) const
virtual SbBool matches (const SoElement *element) const
virtual SoElement * copyMatchInfo (void) const
SoCacheElement * getNextCacheElement (void) const

🦋 Public Member Functions inherited from SoElement

she didn't come alone, she brought the whole family:

const SoType getTypeId (void) const
int getStackIndex (void) const
void setDepth (const int depth)
int getDepth (void) const
virtual void print (FILE *file=stdout) const
virtual ~SoElement ()

⭐ Static Public Member Functions

static SoType getClassTypeId (void)
static int getClassStackIndex (void)
static void * createInstance (void)
static void initClass (void)
static void set (SoState *const state, SoCache *const cache)
static SbBool anyOpen (SoState *const state)
static void invalidate (SoState *const state)
static void addElement (SoState *const state, const SoElement *const
    element)
static void addCacheDependency (SoState *const state, SoCache *const
    cache)
static SbBool setInvalid (const SbBool newvalue)
static SoCache * getCurrentCache (SoState *const state)

💜 Static Public Member Functions inherited from SoElement

static void initClass (void)
static SoType getClassTypeId (void)
static int getClassStackIndex (void)
static void initElements (void)
static int getNumStackIndices (void)
static SoType getIdFromStackIndex (const int stackIndex)

🌸 Protected Member Functions

virtual ~SoCacheElement ()

🌈 Protected Member Functions inherited from SoElement

SoElement (void)
void capture (SoState *const state) const
virtual void captureThis (SoState *state) const
void setTypeId (const SoType typeId)
void setStackIndex (const int index)
SoElement * getNextInStack (void) const
SoElement * getNextFree (void) const

👑 Additional Inherited Members

🧚 Static Protected Member Functions inherited from SoElement

static SoElement * getElement (SoState *const state, const int
    stackIndex)
static const SoElement * getConstElement (SoState *const state, const
    int stackIndex)
static int createStackIndex (const SoType id)

🍓 Protected Attributes inherited from SoElement

SoType typeId
int stackIndex
int depth

🌟 Static Protected Attributes inherited from SoElement

static int classStackIndex
static SoTypeList * stackToType

---

💫 Detailed Description 💫

bestie. listen. the SoCacheElement class stores and manages the open caches. no cap, that's the entire plot. 🎬

---

🎀 Constructor & Destructor Documentation 🎀

SoCacheElement::~SoCacheElement (void ) [protected], [virtual]

it's the destructor. she says bye. 💀✨

---

💅 Member Function Documentation 💅

SoType SoCacheElement::getClassTypeId (void ) [static]

this static method hands you the SoType object that's associated with objects of this class. it's giving ✨type system realness✨.

int SoCacheElement::getClassStackIndex (void ) [static]

this static method returns the state stack index for the class. that's the number, bestie.

void * SoCacheElement::createInstance (void ) [static]

🙈 heads up: this API member is considered internal to the library, because it's not likely to be of interest to the application programmer. iykyk.

creates a new instance of the class type corresponding to the SoType object. fresh out the box, periodt. 📦

void SoCacheElement::initClass (void ) [static]

initialize all the relevant common data for every instance, like the type system. gotta set the girls up before the party starts. 🎉

void SoCacheElement::init (SoState * state) [virtual]

this function initializes the element type inside the given SoState. it gets called for the first element of each enabled element type in SoState objects. main character debut energy. 👑

reimplemented from SoElement.

void SoCacheElement::push (SoState * state) [virtual]

this method gets called every single time a new element is required in one of the stacks. when does that even happen? 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. 🫶

void SoCacheElement::pop (SoState * state, const SoElement * prevTopElement) [virtual]

this method gets called when the state is popped and the depth of the element is bigger than the current state depth. pop() is called on the new top of stack, and a pointer to the previous top of stack gets passed in through prevTopElement.

override this method if you need to copy some state information from the previous top of stack. slay.

reimplemented from SoElement. 💖

void SoCacheElement::set (SoState *const state, SoCache *const cache) [static]

sets the current cache. the cache is ref'ed before returning. noted. 📝

SoCache * SoCacheElement::getCache (void ) const

this method returns the cache, or NULL if there is no cache. no cache? no cache. 🤷‍♀️

SbBool SoCacheElement::anyOpen (SoState *const state) [static]

this method returns TRUE if a cache is currently open. that's the whole check bestie. ✅

void SoCacheElement::invalidate (SoState *const state) [static]

this method invalidates open caches. it should be called by uncacheable nodes. don't skip this one, it matters. 🚨

SbBool SoCacheElement::matches (const SoElement * element) const [virtual]

SoCacheElement objects should not be compared, because you obviously don't cache them in the cache. like, why would you even. 😭

implements SoElement.

SoElement * SoCacheElement::copyMatchInfo (void ) const [virtual]

SoCacheElement objects should not be "copied" because you obviously don't cache them in the cache. same energy as above, fr fr. 🙅‍♀️

See also: SbBool SoCacheElement::matches(const SoElement * element) const

implements SoElement.

SoCacheElement * SoCacheElement::getNextCacheElement (void ) const

this method returns the next cache element. that's the next cache element pointing towards the bottom of the state. down, down, down we go. 🕳️✨

void SoCacheElement::addElement (SoState *const state, const SoElement *const element) [static]

this method adds element to the elements used lists of all the open caches in state. all of them. every single one. 👯‍♀️

void SoCacheElement::addCacheDependency (SoState *const state, SoCache *const cache) [static]

this method creates dependencies on cache for all the open caches in state. the way that it just links everything up... 🦋

SbBool SoCacheElement::setInvalid (const SbBool newvalue) [static]

this method returns the old invalidated bit value, and sets it to newvalue. give and take, bestie. 💞

SoCache * SoCacheElement::getCurrentCache (SoState *const state) [static]

this method returns the current cache. no cache dependencies are honored. read that again. 📢

---

🫶 Author 🫶

generated automatically by Doxygen for Coin, straight from the source code. the robots did this one, not me. 🤖✨

---

and that's the whole page, bestie!! 🎀 version 4.0.10, dated Thu Jun 25 2026 00:00:00, from the Coin source, and it's literally called SoCacheElement(3). go forth and cache responsibly. mwah 💋🌈💖