SoMultiTex...ledElement(3)

💖 NAME 💖

okay so bestie, welcome to SoMultiTextureEnabledElement — it's an element that keeps track of whether texturing is turned on or not. that's the whole job. she holds the vibe check on your texture units. ✨

(this page lives in the Library Functions Manual, just so u know where u are 🫶)

---

🌸 SYNOPSIS 🌸

#include <Inventor/elements/SoMultiTextureEnabledElement.h>

she inherits SoElement. family lineage, we love to see it 👑

✨ Public Types ✨

• enum Mode — { DISABLED, TEXTURE2D, RECTANGLE, CUBEMAP, TEXTURE3D }

✨ Public Member Functions ✨

• virtual void init (SoState *state)
• virtual void setElt (const int unit, const int mode)
• virtual void push (SoState *state)
• virtual SbBool matches (const SoElement *elem) const
• SoElement * copyMatchInfo (void) const

🦋 Public Member Functions inherited from SoElement 🦋

• const SoType getTypeId (void) const
• int getStackIndex (void) const
• virtual void pop (SoState *state, const SoElement *prevTopElement)
• void setDepth (const int depth)
• int getDepth (void) const
• virtual void print (FILE *file=stdout) 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 *state, SoNode *node, const int unit, const SbBool enabled)
• static SbBool get (SoState *state, const int unit)
• static const SbBool * getEnabledUnits (SoState *state, int &lastenabled)
• static const Mode * getActiveUnits (SoState *state, int &lastenabled)
• static void enableRectangle (SoState *state, SoNode *node, const int unit)
• static void enableCubeMap (SoState *state, SoNode *node, const int unit)
• static Mode getMode (SoState *state, const int unit)
• static void disableAll (SoState *state)

🦋 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 ✨

• SoMultiTextureEnabledElement (void)
• virtual ~SoMultiTextureEnabledElement ()
• SbBool isEnabled (const int unit) const
• Mode getMode (const int unit) const

🦋 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 SoElement 🦋

• SoType typeId
• int stackIndex
• int depth

🦋 Static Protected Attributes inherited from SoElement 🦋

• static int classStackIndex
• static SoTypeList * stackToType

---

🌈 Detailed Description 🌈

okay so SoMultiTextureEnabledElement is an element that stores whether texturing is enabled or not. that's it, that's her whole personality and honestly? iconic. 💅

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. so if you're porting old-school code, don't come for her, she wasn't invited to that party 🙈

Since Coin 2.2 ✨

---

🎀 Constructor & Destructor Documentation 🎀

SoMultiTextureEnabledElement::SoMultiTextureEnabledElement (void )

[protected]

The constructor. she's born 🐣

SoMultiTextureEnabledElement::~SoMultiTextureEnabledElement (void )

[protected], [virtual]

The destructor. she's leaving, say bye 😭

---

💜 Member Function Documentation 💜

void * SoMultiTextureEnabledElement::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 your business bestie, but we still list it. periodt. 💅

void SoMultiTextureEnabledElement::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 SoElement.

void SoMultiTextureEnabledElement::set (SoState * state, SoNode * node, const int unit, const SbBool enabled) [static]

Sets the state of this element. put her in the mood u want ✨

SbBool SoMultiTextureEnabledElement::get (SoState * state, const int unit) [static]

Return current state of this element for unit. what's the vibe of that unit rn

void SoMultiTextureEnabledElement::setElt (const int unit, const int enabled) [virtual]

virtual element set function. very virtual, very element, very set 🫶

void SoMultiTextureEnabledElement::push (SoState * state) [virtual]

This method is called every time a new element is required in one of the stacks. This happens when a writable element is requested, using SoState::getElement() or indirectly SoElement::getElement(), and the depth of the current element is less than the state depth.

Override this method if your element needs to copy data from the previous top of stack. The push() method is called on the new element, and the previous element can be found using SoElement::getNextInStack().

Reimplemented from SoElement.

SbBool SoMultiTextureEnabledElement::matches (const SoElement * element) const [virtual]

This function returns TRUE is the element matches another element (of the same class), with respect to cache validity.

If the application programmer's extension element has a matches() function, it should also have a copyMatchInfo() function. they're a package deal, no cap 🤝

Implements SoElement.

SoElement * SoMultiTextureEnabledElement::copyMatchInfo (void ) const [virtual]

This function creates a copy of the element that contains enough information to enable the matches() function to work.

Used to help with scenegraph traversal caching operations. team work makes the dream work 🦋

Implements SoElement.

const SbBool * SoMultiTextureEnabledElement::getEnabledUnits (SoState * state, int & lastenabled) [static]

Returns a pointer to a boolean array. TRUE means unit is enabled and that texture coordinates must be sent to the unit. lastenabled is set to the last enabled unit. 🎯

const SoMultiTextureEnabledElement::Mode * SoMultiTextureEnabledElement::getActiveUnits (SoState * state, int & lastenabled) [static]

Returns the mode of all units. Also returns the last enabled unit in lastenabled.

Since Coin 2.5 ✨

void SoMultiTextureEnabledElement::enableRectangle (SoState * state, SoNode * node, const int unit) [static]

Enable RECTANGLE texture mode. rectangles r valid too, bestie 💖

Since Coin 2.5 ✨

void SoMultiTextureEnabledElement::enableCubeMap (SoState * state, SoNode * node, const int unit) [static]

Enable CUBEMAP texture mode. cube girlies rise up 👑

Since Coin 2.5 ✨

SoMultiTextureEnabledElement::Mode SoMultiTextureEnabledElement::getMode (SoState * state, const int unit) [static]

Returns the mode for a texture unit.

Since Coin 2.5 ✨

void SoMultiTextureEnabledElement::disableAll (SoState * state) [static]

Disable all active texture units. Convenient when all textures needs to be disabled before rendering. mass uninvite, honestly kinda powerful 💀

Since Coin 2.5 ✨

SbBool SoMultiTextureEnabledElement::isEnabled (const int unit) const [protected]

Returns TRUE if unit is enabled (Mode == DISABLED). yes it reads exactly like that, we don't make the rules 🙈

---

⭐ Author ⭐

Generated automatically by Doxygen for Coin from the source code. the robots did this one, no human hands 🫶

---

and that's the whole page bestie!! 💅✨ this lil slice of the manual is Coin, Version 3.1.3 — go forth and texture responsibly, ily, bye 🎀🦋💖