SoCoordinateElement(3)

💖 SoCoordinateElement 💖

okay bestie, so this one lives in the Library Functions Manual (yes that's the whole manual name, we stan a classic), and it's the SoCoordinateElement page. Fair warning up front: this class is yet to be documented — the source literally says FIXME: write doc. a bunch of times and honestly? iconic of it. We're gonna walk through every single thing it does tell us tho, no skips, no cuts. 🫶

---

✨ NAME ✨

SoCoordinateElement — The SoCoordinateElement class is yet to be documented. 💀

---

🌸 SYNOPSIS 🌸

#include <Inventor/elements/SoCoordinateElement.h>

Inherits SoReplacedElement.

Inherited by SoGLCoordinateElement.

---

🎀 Public Member Functions

• virtual void init (SoState *state) — FIXME: write doc.
• int32_t getNum () const — FIXME: write doc.
• SbBool is3D () const — FIXME: write doc.
• const SbVec3f & get3 (const int index) const — FIXME: write doc.
• const SbVec4f & get4 (const int index) const — FIXME: write doc.
• const SbVec3f * getArrayPtr3 () const — (no doc line for this one in the original, she's just there, mysterious 💅)
• const SbVec4f * getArrayPtr4 () const — (same, no doc line, we respect her privacy)
• virtual void print (FILE *file) const — FIXME: write doc.

Public Member Functions inherited from SoReplacedElement

• virtual SbBool matches (const SoElement *element) const
• virtual SoElement * copyMatchInfo () const
• uint32_t getNodeId () 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 set3 (SoState *const state, SoNode *const node, const int32_t numCoords, const SbVec3f *const coords) — FIXME: write doc.
• static void set4 (SoState *const state, SoNode *const node, const int32_t numCoords, const SbVec4f *const coords) — FIXME: write doc.
• static const SoCoordinateElement * getInstance (SoState *const state) — FIXME: write doc.
• static SbVec3f getDefault3 () — FIXME: write doc.
• static SbVec4f getDefault4 () — 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 ~SoCoordinateElement ()

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

---

🍓 Protected Attributes

• int32_t numCoords
• const SbVec3f * coords3D
• const SbVec4f * coords4D
• SbBool areCoords3D

Protected Attributes inherited from SoReplacedElement

• uint32_t nodeId

Protected Attributes inherited from SoElement

• SoType typeId
• int stackIndex
• int depth

---

👑 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)

Static Protected Attributes inherited from SoElement

• static int classStackIndex
• static SoTypeList * stackToType

---

💜 Detailed Description 💜

The SoCoordinateElement class is yet to be documented.

FIXME: write doc.

ngl bestie, that's the whole detailed description. she said "mystery era" and left. 🙈

---

🧚 Constructor & Destructor Documentation 🧚

SoCoordinateElement::~SoCoordinateElement (void ) [protected], [virtual]

The destructor. that's it, that's the doc, short and sweet ✨

---

💅 Member Function Documentation 💅

void * SoCoordinateElement::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 "staff only" energy. 🔥

void SoCoordinateElement::initClass (void ) [static]

This static method initializes static data for the SoCoordinateElement class.

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

FIXME: write doc.

Reimplemented from SoReplacedElement.

const SbVec3f * SoCoordinateElement::getArrayPtr3 () const

Returns a pointer to the 3D coordinate array. Don't use this method unless SoCoordinateElement::is3D() returns TRUE.

This method is not part of the original SGI Open Inventor v2.1 API.

Since: Coin 1.0

ok so this is a Coin original, not a legacy SGI thing — she's new money and we love that for her 💖

const SbVec4f * SoCoordinateElement::getArrayPtr4 () const

Returns a pointer to the 4D coordinate array. Don't use this method unless SoCoordinateElement::is3D() returns FALSE.

This method is not part of the original SGI Open Inventor v2.1 API.

Since: Coin 1.0

⚠️ note the trap: getArrayPtr3() wants is3D() == TRUE, getArrayPtr4() wants is3D() == FALSE. do NOT mix them up, that's a whole vibe check failure right there 😭

void SoCoordinateElement::print (FILE * file) const [virtual]

FIXME: write doc.

Reimplemented from SoReplacedElement.

---

⭐ Member Data Documentation ⭐

int32_t SoCoordinateElement::numCoords [protected]

FIXME: write doc.

const SbVec3f* SoCoordinateElement::coords3D [protected]

FIXME: write doc.

const SbVec4f* SoCoordinateElement::coords4D [protected]

FIXME: write doc.

SbBool SoCoordinateElement::areCoords3D [protected]

FIXME: write doc.

---

🌷 Author 🌷

Generated automatically by Doxygen for Coin from the source code.

---

and that's the whole page, bestie!! no cap, we read every last line of it together. 💜 this one was made by Doxygen for Coin, Version 3.1.3, and that's the vibe we're signing off on. slay, go forth and element-ize responsibly 💅✨