SoTextureC...ateElement(3)

📦 version 3.1.3, in fedora 43, fedora 44

🦋 NAME 🦋

SoTextureCoordinateElement — the class that is, and I quote the devs here, "yet to be documented." 💀 no cap. That's the whole name section. We move.

✨ SYNOPSIS ✨

#include <Inventor/elements/SoTextureCoordinateElement.h>

Inherits SoReplacedElement.

Inherited by SoGLTextureCoordinateElement.

🎀 Public Types 🎀

enum CoordType { NONE = 0, TEXGEN = 0, EXPLICIT = 1, FUNCTION = 2,
    DEFAULT = 3 }

🌸 Public Member Functions 🌸

  • virtual void init (SoState *state) — FIXME: write doc.
  • virtual CoordType getType (void) const — FIXME: write doc.
  • const SbVec4f & get (const SbVec3f &point, const SbVec3f &normal) const — yeah bestie, that's the whole thing, no blurb attached.
  • int32_t getNum (void) const — FIXME: write doc.
  • SbBool is2D (void) const — FIXME: write doc. (for backwards compability. Use getDimension() instead).
  • int32_t getDimension (void) const — no extra note on this one, just the signature.
  • const SbVec2f & get2 (const int index) const — FIXME: write doc.
  • const SbVec3f & get3 (const int index) const — just vibes, no doc text.
  • const SbVec4f & get4 (const int index) const — FIXME: write doc.
  • const SbVec2f * getArrayPtr2 (void) const — no accompanying text, sorry bestie.
  • const SbVec3f * getArrayPtr3 (void) const — nothing here either.
  • const SbVec4f * getArrayPtr4 (void) const — also blank.

💜 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) — no blurb, just a signature living its truth.
  • static int getClassStackIndex (void) — same deal.
  • static void * createInstance (void) — same deal.
  • static void initClass (void) — same deal.
  • static void setDefault (SoState *const state, SoNode *const node) — FIXME: write doc.
  • static void setFunction (SoState *const state, SoNode *const node, SoTextureCoordinateFunctionCB *const func, void *const userdata) — FIXME: write doc.
  • static void set2 (SoState *const state, SoNode *const node, const int32_t numCoords, const SbVec2f *const coords) — FIXME: write doc.
  • static void set3 (SoState *const state, SoNode *const node, const int32_t numCoords, const SbVec3f *const coords) — bare signature, no notes.
  • static void set4 (SoState *const state, SoNode *const node, const int32_t numCoords, const SbVec4f *const coords) — FIXME: write doc.
  • static CoordType getType (SoState *const state) — bare signature.
  • static const SoTextureCoordinateElement * getInstance (SoState *const 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 ~SoTextureCoordinateElement () — that's it, that's the list.

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

  • CoordType whatKind
  • SoTextureCoordinateFunctionCB * funcCB
  • void * funcCBData
  • int32_t numCoords
  • const SbVec2f * coords2
  • const SbVec3f * coords3
  • const SbVec4f * coords4
  • SbBool coordsDimension
  • SbVec2f convert2
  • SbVec3f convert3
  • SbVec4f convert4

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

So the SoTextureCoordinateElement class is, in the official words, "yet to be documented." 🙈

FIXME: write doc.

Heads up bestie: be aware that this class is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API. That's a real thing, don't get caught lacking.

Since : Coin 2.2

FIXME: write doc.

🎀 Member Enumeration Documentation 🎀

enum SoTextureCoordinateElement::CoordType

FIXME: write doc.

🦋 Constructor & Destructor Documentation 🦋

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

The destructor. That's the whole note. Short queen. 💅

✨ Member Function Documentation ✨

void * SoTextureCoordinateElement::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. iykyk — if you're reaching for this, maybe don't.

void SoTextureCoordinateElement::initClass (void ) [static]

This static method initializes static data for the SoTextureCoordinateElement class. Iconic little housekeeping moment. ✨

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

FIXME: write doc.

  • Reimplemented from SoReplacedElement.
  • Reimplemented in SoGLTextureCoordinateElement.

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

FIXME: write doc.

Coin-only alert: this function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since : Coin 2.0

SoTextureCoordinateElement::CoordType SoTextureCoordinateElement::getType (SoState *const state) [static]

This method is used by shapes. Three return values are possible, and here they are, no gatekeeping:

  • DEFAULT means that the shapes should generate their own texture coordinates.
  • EXPLICIT means that discrete texture coordinates are stored, and should be fetched with get2(), get3() or get4().
  • FUNCTION means that get(point, normal) must be used to generate texture coordinates.

SoTextureCoordinateElement::CoordType SoTextureCoordinateElement::getType (void ) const [virtual]

FIXME: write doc.

  • Reimplemented in SoGLTextureCoordinateElement.

const SbVec4f & SoTextureCoordinateElement::get (const SbVec3f & point, const SbVec3f & normal) const

This method returns texture coordinate for the given point and normal. The coordinate is returned as a 4D vector where the r and q coordinates may be set to 0 and 1 respecively depending on what texture coordinate dimension we're using. (Yes, "respecively" — we keep the original spelling bestie, we don't touch the lore. 💖)

Important: this method should only be used if the CoordType is FUNCTION. Otherwise? don't. 🚫

int32_t SoTextureCoordinateElement::getDimension (void ) const

FIXME: write doc.

Coin-only alert: this function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since : Coin 2.0

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

FIXME: write doc.

Coin-only alert: this function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since : Coin 2.0

const SbVec2f * SoTextureCoordinateElement::getArrayPtr2 (void ) const

Returns a pointer to the 2D texture coordinate array. This method is not part of the OIV API. 💅

const SbVec3f * SoTextureCoordinateElement::getArrayPtr3 (void ) const

Returns a pointer to the 3D texture coordinate array.

Coin-only alert: this function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since : Coin 2.0

const SbVec4f * SoTextureCoordinateElement::getArrayPtr4 (void ) const

Returns a pointer to the 4D texture coordinate array. This method is not part of the OIV API. 💅

🌸 Member Data Documentation 🌸

CoordType SoTextureCoordinateElement::whatKind [protected]

FIXME: write doc.

SoTextureCoordinateFunctionCB* SoTextureCoordinateElement::funcCB [protected]

FIXME: write doc.

void* SoTextureCoordinateElement::funcCBData [protected]

FIXME: write doc.

int32_t SoTextureCoordinateElement::numCoords [protected]

FIXME: write doc.

const SbVec2f* SoTextureCoordinateElement::coords2 [protected]

FIXME: write doc.

const SbVec3f* SoTextureCoordinateElement::coords3 [protected]

FIXME: write doc.

Coin-only alert: this function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since : Coin 2.0

const SbVec4f* SoTextureCoordinateElement::coords4 [protected]

FIXME: write doc.

SbBool SoTextureCoordinateElement::coordsDimension [protected]

FIXME: write doc.

Coin-only alert: this function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since : Coin 2.0

SbVec2f SoTextureCoordinateElement::convert2 [protected]

FIXME: write doc.

SbVec3f SoTextureCoordinateElement::convert3 [protected]

FIXME: write doc.

Coin-only alert: this function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.

Since : Coin 2.0

SbVec4f SoTextureCoordinateElement::convert4 [protected]

FIXME: write doc.

🌈 Author 🌈

Generated automatically by Doxygen for Coin from the source code. It's giving ✨ machine-written ✨ and honestly? respect.

okay that's the whole page bestie, we ate and left no crumbs 💅 — this one came from Coin, Version 3.1.3, and it's the SoTextureC...ateElement(3) page from the Library Functions Manual. mwah 🫶💖

📦 where this page comes from