SoCacheElement(3)

✨ NAME ✨

SoCacheElement — bestie, this class is the one that stores and manages the open caches. That's literally the whole vibe. 💖

---

🦋 SYNOPSIS 🦋

#include <Inventor/elements/SoCacheElement.h>

okay so it Inherits SoElement — yes, it's part of that whole element family tree, iykyk. 🌸

👑 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

• 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 🌈

The SoCacheElement class stores and manages the open caches. That's the whole serve. No notes. 💅

---

🎀 Constructor & Destructor Documentation 🎀

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

The destructor. She's doing her final cleanup era. 🫶

---

✨ Member Function Documentation ✨

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

ngl bestie, this API member is considered internal to the library, as it is not likely to be of interest to the application programmer. So like... not your problem, main character. 🙈

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

This one initializes the element type in the given SoState. It gets called for the first element of each enabled element type in SoState objects. ✨

Reimplemented from SoElement.

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

okay so this method gets called every single time a new element is required in one of the stacks. When does that happen? When a writable element is requested — either via SoState::getElement() or indirectly via 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. push() gets called on the new element, and you can find the previous element using SoElement::getNextInStack(). slay.

Reimplemented from SoElement.

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

This method is called when the state is popped, and the depth of the element is bigger than the current state depth. pop() gets 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.

Reimplemented from SoElement.

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

Sets the current cache. And bestie, the cache is ref'ed before returning — that's not optional, that's the whole deal. 💖

SoCache * SoCacheElement::getCache (void ) const

This method returns the cache... or NULL if there is no cache. It's giving "sometimes the answer is nothing." 😭

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

Returns TRUE if a cache is currently open. 💅

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

This method invalidates open caches. It should be called by uncacheable nodes — like, that's the assignment, okay? 🔥

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. Obviously. 💀

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 — and by "next" we mean the next cache element pointing towards the bottom of the state. Downward, bestie. ⬇️✨

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. Dependency queen. 🌸

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

This method returns the old invalidated bit value, and then sets it to newvalue. Out with the old, in with the new. 💖

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

This method returns the current cache. And no — no cache dependencies are honored. Zero. None. Don't even try. 😭

---

🫶 Author 🫶

Generated automatically by Doxygen for Coin from the source code. (The robots wrote it, bestie, we just made it cute.)

---

okay so that's literally the whole page 💖 big kiss, mwah — this was Coin Version 3.1.3, and you just read SoCacheElement(3). go be iconic with your caches, bestie 🎀✨