SoGLUpdateAreaElement(3)

💖 NAME 💖

okay so bestie, meet SoGLUpdateAreaElement — and ngl, the official docs for this class are literally just "yet to be documented". That's it. That's the whole personality. 😭 So we're working with what we've got, and what we've got is extensive. This page is from the Library Functions Manual, and it's giving "mysterious icon who refuses to explain herself." 👑

---

✨ SYNOPSIS ✨

#include <Inventor/elements/SoGLUpdateAreaElement.h>

Inherits SoElement.

🫶 Public Member Functions 🫶

• virtual void init (SoState *state)
• virtual void push (SoState *state)
• virtual void pop (SoState *state, const SoElement *prevTopElement)
• virtual SbBool matches (const SoElement *element) const
• virtual SoElement * copyMatchInfo () 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, const SbVec2f &origin, const SbVec2f &size)
• static SbBool get (SoState *const state, SbVec2f &origin, SbVec2f &size)
• static SbVec2f getDefaultOrigin ()
• static SbVec2f getDefaultSize ()

💅 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 ~SoGLUpdateAreaElement ()

💅 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

🦋 Protected Attributes 🦋

• SbVec2f origin
• SbVec2f size

💅 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 SoGLUpdateAreaElement class is yet to be documented.

FIXME: write doc.

no cap, that's the entire detailed description. the class is out here living its mystery era and honestly? respect. 🙈

---

🧚 Constructor & Destructor Documentation 🧚

SoGLUpdateAreaElement::~SoGLUpdateAreaElement () [protected], [virtual]

The destructor. that's the whole note. short, sweet, iconic. ✨

---

🔥 Member Function Documentation 🔥

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

Bestie, heads up: this API member is considered internal to the library, because it's not likely to be of interest to the application programmer. so unless you're doing Coin-internal stuff, you can lowkey scroll past this one. 👑

void SoGLUpdateAreaElement::initClass (void ) [static]

This static method initializes static data for the SoGLUpdateAreaElement class. housekeeping, but make it classy. 💅

void SoGLUpdateAreaElement::init (SoState * state) [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.

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

This method is called every time a new element is required in one of the stacks. When does that happen, you ask? 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 SoGLUpdateAreaElement::pop (SoState * state, const SoElement * prevTopElement) [virtual]

This method is callled when the state is popped, and the depth of the element is bigger than the current state depth. (callled — yes, that typo is verbatim, we keep the lore intact. 😭) pop() is called on the new top of stack, and a pointer to the previous top of stack is passed in prevTopElement.

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

Reimplemented from SoElement.

SbBool SoGLUpdateAreaElement::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.

If the application programmer's extension element has a matches() function, it should also have a copyMatchInfo() function. they're a package deal, fr fr. 🫶

Implements SoElement.

SoElement * SoGLUpdateAreaElement::copyMatchInfo (void ) const [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. teamwork makes the dream work. 🌸

Implements SoElement.

void SoGLUpdateAreaElement::set (SoState *const state, const SbVec2f & origin, const SbVec2f & size) [static]

Sets the update area. This can, for instance, be used when rendering in the front buffer, to only render parts of the scene during a window expose event. origin and size is in normalized window coordinates.

SbBool SoGLUpdateAreaElement::get (SoState *const state, SbVec2f & origin, SbVec2f & size) [static]

Returns the current update area.

See also: set()

SbVec2f SoGLUpdateAreaElement::getDefaultOrigin (void ) [static]

Returns the default update area origin, (0,0).

SbVec2f SoGLUpdateAreaElement::getDefaultSize (void ) [static]

Returns the default update area size, (1,1).

---

🍓 Member Data Documentation 🍓

SbVec2f SoGLUpdateAreaElement::origin [protected]

FIXME: write doc

SbVec2f SoGLUpdateAreaElement::size [protected]

FIXME: write doc

two protected attributes, zero documentation. they're mysterious. they're booked and busy. we simply don't know their story yet. 💀

---

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code. so technically the author is a robot, and honestly? slay. 🤖✨

---

and that's the whole page, bestie — Coin, Version 3.1.3, and yes this was SoGLUpdateAreaElement(3) the entire time. go forth and render only the parts of the scene you actually need. mwah. 💖🎀🦋