SOGLSHADOWCULLINGELEMENT(3coin3)

πŸ“¦ version 3.1.3, in fedora 43, fedora 44

✨ SoGLShadowCullingElement(3) ✨

okay bestie, buckle UP πŸ’… this is a page from the Library Functions Manual for SoGLShadowCullingElement(3) β€” and no, we do not know what it does yet, and the source code does not either, so we're all in this together 🫢


🌸 NAME 🌸

SoGLShadowCullingElement β€” the SoGLShadowCullingElement class is yet to be documented. That's it. That's the whole name section. It's giving "mystery" 😭


✨ SYNOPSIS ✨

Inherits SoInt32Element. So it's an element, it's an int32 element, it's a whole vibe.

πŸŽ€ Public Types

  • enum Mode β€” the values are AS_IS_CULLING, FRONT_FACE_CULLING, NO_CULLING πŸ‘‘

πŸŽ€ Public Member Functions

  • virtual void init (SoState *state) β€” FIXME: write doc. πŸ™ˆ
  • virtual void push (SoState *state)
  • virtual void pop (SoState *state, const SoElement *prevTopElement)
  • virtual void setElt (int32_t value) β€” FIXME: write doc. πŸ’€

πŸ’œ Public Member Functions inherited from SoInt32Element

  • virtual SbBool matches (const SoElement *element) const
  • virtual SoElement * copyMatchInfo (void) const
  • virtual void print (FILE *file) 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 ~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, SoNode *const node, const int mode) β€” FIXME: write doc. πŸ™ˆ
  • static int get (SoState *const state) β€” FIXME: write doc. πŸ™ˆ
  • static int getDefault (void) β€” FIXME: write doc. πŸ™ˆ

πŸ’œ Static Public Member Functions inherited from SoInt32Element

  • static SoType getClassTypeId (void)
  • static int getClassStackIndex (void)
  • static void initClass (void)
  • static void set (const int index, SoState *const state, SoNode *const node, const int32_t value)
  • static void set (const int index, SoState *const state, const int32_t value)
  • static int32_t get (const int index, SoState *const state) β€” FIXME: write doc. πŸ™ˆ

πŸ’œ 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 ~SoGLShadowCullingElement ()

πŸ’œ 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 SoInt32Element

  • int32_t data

πŸ’œ 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 🌟

So. The SoGLShadowCullingElement class is yet to be documented. Again. We're all just sitting here waiting for someone to write it. It's not me, it's not you, it's nobody yet. 😭

FIXME: write doc. πŸ’€

Since

Coin 2.5 β€” so it's been around a while, being mysterious, main character energy fr fr πŸ‘‘


🌸 Member Enumeration Documentation 🌸

πŸŽ€ enum SoGLShadowCullingElement::Mode

FIXME: write doc. πŸ™ˆ (but the values are AS_IS_CULLING, FRONT_FACE_CULLING, and NO_CULLING β€” we got those from the types section at least 🫢)


πŸ¦‹ Constructor & Destructor Documentation πŸ¦‹

πŸŽ€ SoGLShadowCullingElement::~SoGLShadowCullingElement (void ) [protected], [virtual]

The destructor. That's the entire documentation. She said "I'm a destructor, that's my whole thing" πŸ’…


✨ Member Function Documentation ✨

πŸŽ€ void * SoGLShadowCullingElement::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. Translation: hands off, bestie, this one's for the library's own business πŸ”’

πŸŽ€ void SoGLShadowCullingElement::init (SoState * state) [virtual]

FIXME: write doc. πŸ™ˆ

Reimplemented from SoInt32Element.

πŸŽ€ void SoGLShadowCullingElement::push (SoState * state) [virtual]

okay so this one actually HAS docs, iconic behavior ✨ 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(). so like, new element pops onto the stack, grabs a lil something from the old one via getNextInStack() β€” teamwork, no cap 🫢

Reimplemented from SoElement.

πŸŽ€ void SoGLShadowCullingElement::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. same energy as push but in reverse β€” stack says bye, you get handed the old top in prevTopElement 🌸

Reimplemented from SoElement.

πŸŽ€ void SoGLShadowCullingElement::setElt (int32_t value) [virtual]

FIXME: write doc. πŸ™ˆ

Reimplemented from SoInt32Element.


πŸ’œ Author πŸ’œ

Generated automatically by Doxygen for Coin from the source code. so if the docs are a little sparse, blame the robot that wrote them, not me 😭


and that's the whole page bestie, we survived πŸŽ€ no cap, this entire class is literally just FIXME: write doc. with extra steps β€” but hey, it's been here since Coin 2.5, and it's still slaying in Version 3.1.3, which is what this page is stamped with (and yes, it's still filed under SoGLShadowCullingElement(3)). periodt πŸ’…πŸ’–

πŸ“¦ where this page comes from