SoAmbientColorElement(3)

💅 SoAmbientColorElement — from the Library Functions Manual (3) section, bestie 🎀

Okay so real talk, this one's a <lavender>library functions manual</lavender> page, and it's about the class SoAmbientColorElement. Sit down, hydrate, let's go ✨

---

🌸 NAME 🌸

SoAmbientColorElement — the SoAmbientColorElement class is yet to be documented. Yeah. That's it. That's the whole name section. The docs said "yet to be documented" and honestly? They meant it. 😭

---

✨ SYNOPSIS ✨

#include <Inherits SoReplacedElement./elements/SoAmbientColorElement.h>

Wait, no, hold up — the include is:

#include <Inventor/elements/SoAmbientColorElement.h>

And it Inherits SoReplacedElement. 👑

🫶 Public Member Functions

virtual void init (SoState *state)
int32_t getNum (void) const
const SbColor & get (const int index) const
const SbColor * getArrayPtr (void) const

• virtual void init (SoState *state) — FIXME: write doc. (Not me writing a manpage where the docs are literally FIXME 😭 but okay, we move.)
• int32_t getNum (void) const — FIXME: write doc.
• const SbColor & get (const int index) const — FIXME: write doc.
• const SbColor * getArrayPtr (void) const — no FIXME here, bestie, this one's free of charge.

💜 Public Member Functions inherited from SoReplacedElement

virtual SbBool matches (const SoElement *element) const
virtual SoElement * copyMatchInfo () const
uint32_t getNodeId () const
virtual void print (FILE *file) const

🌈 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, SoNode *const node, const int32_t numcolors, const SbColor *const colors)
static const SoAmbientColorElement * getInstance (SoState *state)

• static SoType getClassTypeId (void) — classic type-id getter, iconic.
• static int getClassStackIndex (void) — stack index, but make it classy.
• static void * createInstance (void) — makes an instance, slay.
• static void initClass (void) — initializes the class, periodt.
• static void set (SoState *const state, SoNode *const node, const int32_t numcolors, const SbColor *const colors) — FIXME: write doc.
• static const SoAmbientColorElement * getInstance (SoState *state) — FIXME: write doc.

💖 Static Public Member Functions inherited from SoReplacedElement

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

virtual ~SoAmbientColorElement ()

🌷 Protected Member Functions inherited from SoReplacedElement

virtual ~SoReplacedElement ()

🧚 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 SoReplacedElement

static SoElement * getElement (SoState *const state, const int stackIndex, SoNode *const node)

🌟 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 SoReplacedElement

uint32_t nodeId

🍬 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 SoAmbientColorElement class is yet to be documented.

Yeah. Round two of the same sentence. It's giving "the docs went to get milk and never came back" 🥛😭

---

🛠️ Constructor & Destructor Documentation 🛠️

SoAmbientColorElement::~SoAmbientColorElement () — [protected], [virtual]

The destructor. That's the entire description, bestie — it's short, it's sweet, it's protected, it's virtual. 💅

---

📚 Member Function Documentation 📚

void * SoAmbientColorElement::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… <purple>hands off, babe</purple>, it's the library's business, not yours. 🙈

void SoAmbientColorElement::initClass (void ) — [static]

This static method initializes static data for the SoAmbientColorElement class. Iconic behaviour, no notes. ⭐

void SoAmbientColorElement::init (SoState * state) — [virtual]

FIXME: write doc.

Heads up, gorgeous: this one is <b>Reimplemented from SoReplacedElement.</b>

const SbColor * SoAmbientColorElement::getArrayPtr (void ) const

Return a pointer to the color array. This method is not part of the OIV API. 🎨 <cyan>(lowkey important: not OIV API, so don't go relying on it in your cross-implementation masterpiece, iykyk)</cyan>

---

✍️ Author ✍️

Generated automatically by Doxygen for Coin from the source code. So not a human author, just a robot doing its little best 🤖💖

---

And that's the whole page, bestie! It's <b>Coin</b>, <b>Version 3.1.3</b>, and this was <b>SoAmbientColorElement(3)</b> — documented by Doxygen, blessed by me, and yes, half of it literally says "FIXME: write doc." We love a work in progress. Periodt. 💅✨🎀