SoAccumulatedElement(3)

💖 NAME 💖

SoAccumulatedElement — the abstract class for storing accumulated state, bestie. It's giving "superclass energy" and we're obsessed 💅

---

✨ SYNOPSIS ✨

#include <Inventor/elements/SoAccumulatedElement.h>

Inherits SoElement.

Inherited by SoBumpMapMatrixElement, SoClipPlaneElement, SoLightElement, SoModelMatrixElement, SoMultiTextureMatrixElement, SoProfileElement, and SoTextureMatrixElement. Not me being the mom of SEVEN iconic subclasses 😭👑

🎀 Public Member Functions 🎀

• virtual SbBool matches (const SoElement *element) const — the vibe check function, lowkey ✨

🧚 Public Member Functions inherited from SoElement 🧚

• const SoType getTypeId (void) const
• int getStackIndex (void) const
• virtual void pop (SoState *state, const SoElement *prevTopElement)
• 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 initClass (void)

🌈 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 void init (SoState *state)
• virtual 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 SoElement * copyMatchInfo (void) const
• virtual void captureThis (SoState *state) const

💜 Protected Member Functions inherited from SoElement 💜

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

⭐ Protected Attributes ⭐

• SbList< uint32_t > nodeIds

🍓 Protected Attributes inherited from SoElement 🍓

• SoType typeId
• int stackIndex
• int depth

🦋 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)

💫 Static Protected Attributes inherited from SoElement 💫

• static int classStackIndex
• static SoTypeList * stackToType

---

🔥 Detailed Description 🔥

The SoAccumulatedElement class is an abstract class for storing accumulated state. Periodt.

This is the superclass of elements where new element data accumulates with older data. It's a stacking situation, and honestly? Main character energy 🫶

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. So like, it's the receipts girlie keeping track of who showed up so the cache knows when to say "actually, no" 💅

👀 See also

SoReplacedElement, SoFloatElement, SoInt32Element

---

💅 Member Function Documentation 💅

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. It's literally the "do we match?" moment and it matters so much for caching ✨

If the application programmer's extension element has a matches() function, it should also have a copyMatchInfo() function. Bestie, they come as a set, no cap.

Implements SoElement.

Reimplemented in SoModelMatrixElement.

---

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. Like a little "hi, I exist now" moment for every element type 🌱

Reimplemented from SoElement.

Reimplemented in SoBBoxModelMatrixElement, SoBumpMapMatrixElement, SoClipPlaneElement, SoGLClipPlaneElement, SoGLModelMatrixElement, SoGLMultiTextureMatrixElement, SoGLTextureMatrixElement, SoLightElement, SoModelMatrixElement, SoMultiTextureMatrixElement, SoProfileElement, and SoTextureMatrixElement. That's a LOT of children, she's booked and busy 😭

---

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. Very "the stack grew, so now we need a fresh copy" of it all 🌸

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(). Slay, go copy your data, queen 💖

Reimplemented from SoElement.

Reimplemented in SoBBoxModelMatrixElement, SoBumpMapMatrixElement, SoClipPlaneElement, SoGLModelMatrixElement, SoGLMultiTextureMatrixElement, SoLightElement, SoModelMatrixElement, SoMultiTextureMatrixElement, SoProfileElement, and SoTextureMatrixElement.

---

void SoAccumulatedElement::clearNodeIds (void )

[protected]

Empty the list of node ids. Just — poof — gone. Clean slate energy 🧹✨

---

void SoAccumulatedElement::addNodeId (const SoNode *const node)

[protected]

Add the node id of node to the list of node ids. One more to the collection, she's a collector fr fr 🎀

---

void SoAccumulatedElement::setNodeId (const SoNode *const node)

[protected]

Empty the list of node ids, and add the id of node. So it's a full reset plus one — out with the old, in with the new, iconic behavior 👑

---

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. Coin-only treat, iykyk 💅

---

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. It's the little info packet that makes the whole match-check possible, and we love a supportive function 🫶

Implements SoElement.

---

void SoAccumulatedElement::captureThis (SoState * state) const

[protected], [virtual]

Adds the element to the cache. Straight to the cache, no detours 🔥

Reimplemented from SoElement.

---

🌈 Member Data Documentation 🌈

SbList<uint32_t> SoAccumulatedElement::nodeIds

[protected]

Stores the internal list of node id values for nodes accumulated on the stack for the element. This is THE list, the whole point, the moment 💜

---

🎀 Author 🎀

Generated automatically by Doxygen for Coin from the source code. (Yes, a robot wrote it, and it ate, honestly 🤖✨)

---

🫶 And that's the whole page, bestie! This one's from Coin, Version 3.1.3, and the manual page is SoAccumulatedElement(3). Take care of your node ids out there — bye babes! 💖🌈🦋