SoProfileC...ateElement(3)

💖 SoProfileC...ateElement(3) 💖

okay bestie, so this page is from the Library Functions Manual, and the whole vibe is: it's SoProfileC...ateElement(3), which is a Coin thing, and ngl the docs are a little... unfinished. We're gonna walk through every single bit anyway because that's what we do. 🫶

---

✨ NAME ✨

SoProfileCoordinateElement — the SoProfileCoordinateElement class is, and I quote the source material here, yet to be documented. 💀 (yes really. that's the NAME section. we move.)

---

🌸 SYNOPSIS 🌸

It inherits SoReplacedElement.

💅 Public Member Functions

• virtual void init (SoState *state)
• int32_t getNum (void) const
• const SbVec2f & get2 (const int index) const
• const SbVec3f & get3 (const int index) const
• SbBool is2D (void) const
• const SbVec2f * getArrayPtr2 (void) const
• const SbVec3f * getArrayPtr3 (void) const

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 set2 (SoState *const state, SoNode *const node, const int32_t numCoords, const SbVec2f *const coords)
• static void set3 (SoState *const state, SoNode *const node, const int32_t numCoords, const SbVec3f *const coords)
• static const SoProfileCoordinateElement * getInstance (SoState *const state)
• static SbVec2f getDefault2 (void)
• static SbVec3f getDefault3 (void)

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 ~SoProfileCoordinateElement ()

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 SbVec2f * coords2
• const SbVec3f * coords3
• SbBool coordsAre2D

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

FIXME: write doc.

bestie that's literally all it says. no cap. the documentation is a promise that hasn't been kept yet. 💀

---

🧚 Constructor & Destructor Documentation 🧚

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

The destructor. that's it, that's the description. iconic minimalism honestly. 💅

---

🔥 Member Function Documentation 🔥

void * SoProfileCoordinateElement::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... lowkey not for you, bestie. 🙈

void SoProfileCoordinateElement::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 SoReplacedElement.

void SoProfileCoordinateElement::set2 (SoState *const state, SoNode *const node, const int32_t numCoords, const SbVec2f *const coords) [static]

Sets the profile coordinates. ✨ (the 2D ones, iykyk)

void SoProfileCoordinateElement::set3 (SoState *const state, SoNode *const node, const int32_t numCoords, const SbVec3f *const coords) [static]

Sets the profile coordinates. ✨ (and these are the 3D ones)

const SoProfileCoordinateElement * SoProfileCoordinateElement::getInstance (SoState *const state) [static]

Returns the current element. like, the one that's giving main character energy right now. 👑

int32_t SoProfileCoordinateElement::getNum (void ) const

Returns the number of profile coordinates in this element.

const SbVec2f & SoProfileCoordinateElement::get2 (const int index) const

Returns the index'th 2D coordinate.

See also: is2D()

const SbVec3f & SoProfileCoordinateElement::get3 (const int index) const

Returns the index'th 3D coordinate.

See also: is2D()

SbBool SoProfileCoordinateElement::is2D (void ) const

Returns if this element contains 2D coordinates. (a little vibe check on the dimensionality, if you will 🦋)

SbVec2f SoProfileCoordinateElement::getDefault2 (void ) [static]

Returns the default 2D coordinate.

SbVec3f SoProfileCoordinateElement::getDefault3 (void ) [static]

Returns the default 3D coordinate.

const SbVec2f * SoProfileCoordinateElement::getArrayPtr2 (void ) const

Returns a pointer to the 2D coordinates.

const SbVec3f * SoProfileCoordinateElement::getArrayPtr3 (void ) const

Returns a pointer to the 3D coordinates.

---

🍓 Member Data Documentation 🍓

int32_t SoProfileCoordinateElement::numCoords [protected]

FIXME: write doc.

const SbVec2f* SoProfileCoordinateElement::coords2 [protected]

FIXME: write doc.

const SbVec3f* SoProfileCoordinateElement::coords3 [protected]

FIXME: write doc.

SbBool SoProfileCoordinateElement::coordsAre2D [protected]

FIXME: write doc.

four FIXMEs in a row. the documentation said "not today" and honestly? respect. 😭 but fr fr, that's genuinely all the original gives us — we are not inventing lore.

---

💜 Author 💜

Generated automatically by Doxygen for Coin from the source code. (not me, not you, a robot. slay.)

---

and that's the whole page, bestie!! this little bundle of joy is from Coin, version 3.1.3, and it lives in the manual as SoProfileC...ateElement(3). go forth and profile-coordinate-element responsibly. 🎀✨🫶