SoLightModelElement(3)

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

πŸ’– SoLightModelElement(3) πŸ’–

okay so bestie, welcome to the SoLightModelElement page β€” that's a section 3 manpage from the Coin library functions manual, and yeah, she's a lil mysterious. The whole class is yet to be documented, which is giving "group project where nobody wrote their part" energy, but we're gonna walk through every single thing on this page together. no skipping. 🫢


✨ NAME ✨

SoLightModelElement β€” The SoLightModelElement class is yet to be documented.

that's it. that's the name. she's undocumented and she knows it. πŸ’…


🌈 SYNOPSIS 🌈

#include <Inventor/elements/SoLightModelElement.h>

lowkey the most important line here: she Inherits SoInt32Element. so everything SoInt32Element can do, she can do too. nepotism? maybe. iconic? absolutely. πŸ‘‘


πŸŽ€ Public Types πŸŽ€

  • enum Model { BASE_COLOR, PHONG } β€” two vibes, that's it. BASE_COLOR and PHONG. pick your fighter. ✨

πŸ¦‹ Public Member Functions πŸ¦‹

  • virtual void init (SoState *state) β€” FIXME: write doc. (yes the docs literally say that, i'm not gonna pretend otherwise 😭)

πŸ’œ Public Member Functions inherited from SoInt32Element

  • virtual SbBool matches (const SoElement *element) const
  • virtual SoElement * copyMatchInfo (void) const
  • virtual void print (FILE *file) const
  • virtual void setElt (int32_t value) β€” FIXME: write doc.

🌸 Public Member Functions inherited from SoElement

  • const SoType getTypeId (void) const
  • int getStackIndex (void) const
  • virtual void push (SoState *state)
  • virtual void pop (SoState *state, const SoElement *prevTopElement)
  • 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, const Model model) β€” FIXME: write doc.
  • static void set (SoState *const state, SoNode *const node, const Model model)
  • static Model get (SoState *const state) β€” FIXME: write doc.
  • static Model getDefault () β€” FIXME: write doc.
  • static const SoLightModelElement * getInstance (SoState *state) β€” 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 ~SoLightModelElement ()

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

The SoLightModelElement class is yet to be documented.

FIXME: write doc.

like. bestie. the audacity. πŸ’€ but we move.


🧚 Member Enumeration Documentation 🧚

enum SoLightModelElement::Model

FIXME: write doc.

(so true bestie, so true. the enum exists, the docs do not. BASE_COLOR and PHONG are right there in the synopsis if you need them though 🌸)


πŸŽ€ Constructor & Destructor Documentation πŸŽ€

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

The destructor. that's her. protected, virtual, doing her lil cleanup moment. πŸ’…


πŸ’– Member Function Documentation πŸ’–

void * SoLightModelElement::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.

so like... not for you, bestie. it's giving backstage pass only. πŸ™ˆ

void SoLightModelElement::initClass (void ) [static]

This static method initializes static data for the SoLightModelElement class. that's her whole job and she does it well. ⭐

void SoLightModelElement::init (SoState * state) [virtual]

FIXME: write doc.

Reimplemented from SoInt32Element.


🫢 Author 🫢

Generated automatically by Doxygen for Coin from the source code.


aaaand that's the whole page!! no cap, we read every single line β€” every inherited member, every protected attribute, every FIXME: write doc. in the building. πŸ’–

signing off: this was Coin Version 3.1.3, and the page itself is dated... well, the footer just says SoLightModelElement(3) alongside that version, so consider this your cute lil timestamp, bestie. now go write those docs, the class is literally begging. πŸŽ€βœ¨πŸ¦‹

πŸ“¦ where this page comes from