SoBumpMapMatrixElement(3)

✨ NAME ✨

SoBumpMapMatrixElement — The SoBumpMapMatrixElement class is used to manage the bump map matrix stack.

okay so bestie, this is SoBumpMapMatrixElement(3) from the Library Functions Manual, and she is literally the girl who runs the bump map matrix stack. no cap. 💖

---

🌸 SYNOPSIS 🌸

#include <Inventor/elements/SoBumpMapMatrixElement.h>

Inherits SoAccumulatedElement.

💖 Public Member Functions 💖

• virtual void init (SoState *state)
• virtual void push (SoState *state)

🫶 Public Member Functions inherited from SoAccumulatedElement 🫶

• virtual SbBool matches (const SoElement *element) 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 makeIdentity (SoState *const state, SoNode *const node)
• static void set (SoState *const state, SoNode *const node, const SbMatrix &matrix)
• static void mult (SoState *const state, SoNode *const node, const SbMatrix &matrix)
• static void translateBy (SoState *const state, SoNode *const node, const SbVec3f &translation)
• static void rotateBy (SoState *const state, SoNode *const node, const SbRotation &rotation)
• static void scaleBy (SoState *const state, SoNode *const node, const SbVec3f &scaleFactor)
• static const SbMatrix & get (SoState *const state)

🌈 Static Public Member Functions inherited from SoAccumulatedElement 🌈

• 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 ~SoBumpMapMatrixElement ()
• virtual void makeEltIdentity (void)
• virtual void setElt (const SbMatrix &matrix)
• virtual void multElt (const SbMatrix &matrix)
• virtual void translateEltBy (const SbVec3f &translation)
• virtual void rotateEltBy (const SbRotation &rotation)
• virtual void scaleEltBy (const SbVec3f &scaleFactor)
• virtual const SbMatrix & getElt (void) const

🌸 Protected Member Functions inherited from SoAccumulatedElement 🌸

• void clearNodeIds (void)
• void addNodeId (const SoNode *const node)
• void setNodeId (const SoNode *const node)
• void copyNodeIds (const SoAccumulatedElement *copyfrom)
• virtual SoElement * copyMatchInfo (void) const
• virtual void captureThis (SoState *state) const

🧚 Protected Member Functions inherited from SoElement 🧚

• SoElement (void)
• void capture (SoState *const state) const
• void setTypeId (const SoType typeId)
• void setStackIndex (const int index)
• SoElement * getNextInStack (void) const
• SoElement * getNextFree (void) const

💅 Protected Attributes 💅

• SbMatrix bumpMapMatrix

🍓 Protected Attributes inherited from SoAccumulatedElement 🍓

• SbList< uint32_t > nodeIds

💖 Protected Attributes inherited from SoElement 💖

• SoType typeId
• int stackIndex
• int depth

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

🌟 Static Protected Attributes inherited from SoElement 🌟

• static int classStackIndex
• static SoTypeList * stackToType

---

💖 Detailed Description 💖

The SoBumpMapMatrixElement class is used to manage the bump map matrix stack.

okay so what does she actually do, bestie? The bump map matrix is used to transform bump map coordinates before being used to map bump maps onto polygons. that's the whole vibe. she takes your bump map coords, runs them through the matrix, and then they get mapped onto polygons. iconic behavior tbh. 💅

---

🎀 Constructor & Destructor Documentation 🎀

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

The destructor.

it's the destructor bestie, she cleans up after herself. protected and virtual, so you can't just call her from anywhere — she's for the class and her subclasses. periodt. 💀

---

✨ Member Function Documentation ✨

void * SoBumpMapMatrixElement::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.

translation: this one's internal, bestie. the library uses her, but if you're an application programmer you probably don't need to care. no cap. 🙈

void SoBumpMapMatrixElement::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 SoAccumulatedElement.

so init() sets up the element type inside the SoState you hand her. she gets called for the first element of every enabled element type in SoState objects. and yeah, she's reimplemented from SoAccumulatedElement — that's her origin story. 🌱

void SoBumpMapMatrixElement::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 SoAccumulatedElement.

every time a new element is needed in one of the stacks, push() shows up. this happens when you request a writable element with SoState::getElement() or indirectly with SoElement::getElement(), and the depth of the current element is less than the state depth. if your element needs to copy data from the previous top of stack, override this. push() is called on the new element, and you can find the previous one with SoElement::getNextInStack(). reimplemented from SoAccumulatedElement, obviously. 💅

void SoBumpMapMatrixElement::makeIdentity (SoState *const state, SoNode *const node) [static]

Sets current texture matrix to identity.

sets the current texture matrix to identity. simple as that. she's resetting the vibe to neutral. ✨

void SoBumpMapMatrixElement::set (SoState *const state, SoNode *const node, const SbMatrix & matrix) [static]

Sets the current texture matrix to matrix.

This method is an extension versus the Open Inventor API.

sets the current texture matrix to matrix. and bestie, this method is an extension versus the Open Inventor API — so she's extra, she's special, she's not in the original API. periodt. 💅

void SoBumpMapMatrixElement::mult (SoState *const state, SoNode *const node, const SbMatrix & matrix) [static]

Multiplies matrix into the current texture matrix.

multiplies matrix into the current texture matrix. stacking those transformations like it's nothing. 🔥

void SoBumpMapMatrixElement::translateBy (SoState *const state, SoNode *const node, const SbVec3f & translation) [static]

Appends translation to the current texture matrix.

appends translation to the current texture matrix. she's adding that translation to the end, no big deal. 🦋

void SoBumpMapMatrixElement::rotateBy (SoState *const state, SoNode *const node, const SbRotation & rotation) [static]

Appends rotation to the current texture matrix.

appends rotation to the current texture matrix. spin it, bestie. ✨

void SoBumpMapMatrixElement::scaleBy (SoState *const state, SoNode *const node, const SbVec3f & scaleFactor) [static]

Appends scaleFactor to the current texture matrix.

appends scaleFactor to the current texture matrix. scale it up, scale it down, she's flexible. 💅

const SbMatrix & SoBumpMapMatrixElement::get (SoState *const state) [static]

Returns current texture matrix.

returns the current texture matrix. that's it, that's the tweet. ✨

void SoBumpMapMatrixElement::makeEltIdentity (void ) [protected], [virtual]

virtual method which is called from makeIdentity(). Sets element matrix to identity.

virtual method called from makeIdentity(). sets the element matrix to identity. so makeIdentity() does the current texture matrix, and makeEltIdentity() does the element matrix. two different girls, same energy. 💖

void SoBumpMapMatrixElement::setElt (const SbMatrix & matrix) [protected], [virtual]

virtual method which is called from set(). Sets the texture matrix to matrix.

This method is an extension versus the Open Inventor API.

virtual method called from set(). sets the texture matrix to matrix. and yes, this one is also an extension versus the Open Inventor API. she's exclusive. 💅

void SoBumpMapMatrixElement::multElt (const SbMatrix & matrix) [protected], [virtual]

virtual method which is called from mult(). Multiplies matrix into element matrix.

virtual method called from mult(). multiplies matrix into the element matrix. 🔥

void SoBumpMapMatrixElement::translateEltBy (const SbVec3f & translation) [protected], [virtual]

virtual method which is called from translateBy(). Appends translation to the element matrix.

virtual method called from translateBy(). appends translation to the element matrix. 🦋

void SoBumpMapMatrixElement::rotateEltBy (const SbRotation & rotation) [protected], [virtual]

virtual method which is called from rotateBy(). Appends rotation to the element matrix.

virtual method called from rotateBy(). appends rotation to the element matrix. ✨

void SoBumpMapMatrixElement::scaleEltBy (const SbVec3f & scaleFactor) [protected], [virtual]

virtual method which is called from scaleBy(). Append scaleFactor to the element matrix.

virtual method called from scaleBy(). append scaleFactor to the element matrix. 💅

const SbMatrix & SoBumpMapMatrixElement::getElt (void ) const [protected], [virtual]

Returns element matrix. Called from get().

returns the element matrix. called from get(). that's the whole thing. ✨

---

💎 Member Data Documentation 💎

SbMatrix SoBumpMapMatrixElement::bumpMapMatrix [protected]

The matrix.

it's the matrix, bestie. SbMatrix type, protected, named bumpMapMatrix. the whole point of this class. 👑

---

👑 Author 👑

Generated automatically by Doxygen for Coin from the source code.

so yeah, Doxygen auto-generated this for Coin from the source code. not a human author, a whole robot. iconic. 💖

---

that's the whole page, bestie. this was Coin Version 3.1.3, page SoBumpMapMatrixElement(3). go forth and bump map those matrices. 💖✨💅