SoGLUpdateAreaElement(3)

📦
version 4.0.10 · 4 versions
, in fedora 43, fedora 44

💖 NAME 💖

SoGLUpdateAreaElement — bestie, the docs for this class literally do not exist yet. That's it, that's the name. 🫶

✨ SYNOPSIS ✨

#include <Inventor/elements/SoGLUpdateAreaElement.h>

Inherits SoElement. It's giving nepo baby of the element hierarchy, and honestly? Slay.

👑 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. — bestie the maintainers literally left us on read, not me having to explain this class with zero lore 😭

🛠 Constructor & Destructor Documentation 🛠

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

Destructor. Say bye, babe. 👋 It's protected, so it's an inside-job kind of goodbye, iykyk.

📚 Member Function Documentation 📚

⭐ SoType SoGLUpdateAreaElement::getClassTypeId (void ) [static]

This static method returns the SoType object associated with objects of this class. It's the class's little ID badge. 🪪

⭐ int SoGLUpdateAreaElement::getClassStackIndex (void ) [static]

This static method returns the state stack index for the class. Where you sit in the stack? Iconic. 👑

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

This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.

Creates a new instance of the class type corresponding to the SoType object. Very "I made this" energy. ✨

⭐ void SoGLUpdateAreaElement::initClass (void ) [static]

Initialize relevant common data for all instances, like the type system. Setting the whole squad up fr fr. 🫶

⭐ 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. 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().

Reimplemented from SoElement.

⭐ void SoGLUpdateAreaElement::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() 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.

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 scene graph traversal caching operations. It's the plus-one that makes matches() actually function, no cap. 💅

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. Selective rendering? Obsessed. 🔥

⭐ 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). The humble beginning. 🌱

⭐ SbVec2f SoGLUpdateAreaElement::getDefaultSize (void ) [static]

Returns the default update area size, (1,1). Whole window, full main character energy. 👑

🗂 Member Data Documentation 🗂

🌸 SbVec2f SoGLUpdateAreaElement::origin [protected]

FIXME: write doc — yeah bestie, they left this one blank too 🙈

🌸 SbVec2f SoGLUpdateAreaElement::size [protected]

FIXME: write doc — same vibe, same void, same mystery 💀

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code. So technically the author is a robot and I'm just the translator, periodt. 🤖✨

Okay so that's the whole page, babe — and the cute little sign-off down here says Version 4.0.10, dated Thu Jun 25 2026 00:00:00, filed under SoGLUpdateAreaElement(3). Take care of her, she's undocumented but she's trying. 🫶💖

📦 where this page comes from