SoAccumulatedElement(3)

💖 SoAccumulatedElement(3) 💖

okay bestie, so this is SoAccumulatedElement, and it lives in the Library Functions Manual section, part of Coin Version 2.5.0. Let's get into it, no cap.

---

✨ NAME ✨

SoAccumulatedElement — the abstract class for storing accumulated state. she's abstract, she's a base class, she's iconic 👑

---

🌸 SYNOPSIS 🌸

#include <Inventor/elements/SoAccumulatedElement.h>

Inherits SoElement.

Public Member Functions

• virtual SbBool matches (const SoElement *element) const

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

• void init (SoState *state)
• 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 🦋

SoAccumulatedElement is an abstract class for storing accumulated state. periodt.

She's the superclass of elements where new element data accumulates with older data. it's giving "stacking the vibes" ✨

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. lowkey crucial for cache hygiene, ngl 💅

See also SoReplacedElement, SoFloatElement, SoInt32Element

---

💅 Member Function Documentation 💅

SbBool SoAccumulatedElement::matches (const SoElement * element) const

[virtual]

This function returns TRUE if the element matches another element (of the same class), with respect to cache validity.

If the application programmer's extension element has a matches() function, it should also have a copyMatchInfo() function. like, they're a matched set, bestie 🫶

Implements SoElement.

References nodeIds, and SoElement::SoElement().

---

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.

Reimplemented from SoElement.

References SoElement::init().

---

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.

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(). she's passing the baton fr fr 🏃‍♀️

Reimplemented from SoElement.

References SoElement::push().

---

void SoAccumulatedElement::clearNodeIds (void )

[protected]

Empty the list of node ids. poof, gone ✨

References nodeIds.

Referenced by setNodeId().

---

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

[protected]

Add the node id of node to the list of node ids.

References SoNode::getNodeId(), and nodeIds.

Referenced by setNodeId().

---

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

[protected]

Empty the list of node ids, and add the id of node. out with the old, in with the new 💖

References addNodeId(), and clearNodeIds().

---

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. 👀

References nodeIds.

Referenced by copyMatchInfo().

---

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. bestie is doing the behind-the-scenes work, main character energy but make it backstage 💅

Implements SoElement.

References copyNodeIds(), SoType::createInstance(), and SoElement::getTypeId().

---

void SoAccumulatedElement::captureThis (SoState * state) const

[protected], [virtual]

Adds the element to the cache.

Reimplemented from SoElement.

References captureThis(), SoElement::captureThis(), and SoElement::getNextInStack().

Referenced by captureThis().

---

🍓 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.

Referenced by addNodeId(), clearNodeIds(), copyNodeIds(), and matches(). she's referenced by everyone, she's the moment 🔥

---

🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code. (yes, a robot wrote the original, and now I rewrote it, we love a glow-up 💅✨)

---

and that's the whole page, bestie!! mwah 💖

signing off from the Coin library, Version 2.5.0, dated SoAccumulatedElement(3) — catch you on the next traversal 🌸🦋💜