SoModelMatrixElement(3)

🌸 NAME 🌸

SoModelMatrixElement — bestie, this is the class that manages the current transformation. That's the whole vibe. It holds the tea on where everything is. 💅

---

✨ SYNOPSIS ✨

#include <Inventor/elements/SoModelMatrixElement.h>

Inherits SoAccumulatedElement.

Inherited by SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

💖 Public Member Functions

virtual void init (SoState *state)
virtual void push (SoState *state)
virtual SbBool matches (const SoElement *element) const
const SbMatrix & getModelMatrix (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 makeIdentity (SoState *const state, SoNode *const node)
static void set (SoState *const state, SoNode *const node, const SbMatrix &matrix)
static void setCullMatrix (SoState *state, SoNode *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 SbMatrix pushMatrix (SoState *const state)
static void popMatrix (SoState *const state, const SbMatrix &matrix)
static const SbMatrix & getCombinedCullMatrix (SoState *const state)
static const SbMatrix & get (SoState *const state)
static const SbMatrix & get (SoState *const state, SbBool &isIdentity)

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 ~SoModelMatrixElement ()
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 SbMatrix pushMatrixElt (void)
virtual void popMatrixElt (const SbMatrix &matrix)

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 modelMatrix
SbMatrix cullMatrix
SbMatrix combinedMatrix
uint32_t flags

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 SoModelMatrixElement class is used to manage the current transformation. Yep, that's the job. It's the element that keeps track of where stuff is while the scene graph does its thing. 🫶

SoModelMatrixElement contains the object-to-world matrix. Like, the glow-up from "I'm a lil vertex in local space" to "I am a citizen of the world." ✨

The world-to-camera transformation lives somewhere else entirely — that's stored in the SoViewingMatrixElement class. Different element, different job, no overlap. 💅

Okay so here's the one thing that lowkey trips everyone up: SoModelMatrixElement does not contain the same matrix as the OpenGL GL_MODELVIEW matrix. Not the same. Do not confuse them. It's giving "similar name, completely different energy." 😭

See also

• SoViewingMatrixElement

---

🎀 Constructor & Destructor Documentation 🎀

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

The destructor. It cleans up. That's it, that's the whole function. She's simple, she's effective. 💖

---

👑 Member Function Documentation 👑

void * SoModelMatrixElement::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, if you're an app dev, this is not your lane bestie, move along. 🙈

void SoModelMatrixElement::initClass (void ) [static]

This static method initializes static data for the SoModelMatrixElement class. One-time setup moment. Iconic. ⭐

void SoModelMatrixElement::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.

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

void SoModelMatrixElement::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.

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

SbBool SoModelMatrixElement::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, fr fr. 🫶

Reimplemented from SoAccumulatedElement.

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

Sets the current model matrix to the identity matrix. Reset era. 🧚

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

Sets the current model matrix to matrix.

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

Sets the current cull matrix.

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

Multiplies matrix into the model matrix. Glow-up by multiplication. ✨

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

Appends translation to the model matrix. Scoot. Move. Go. 💅

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

Appends rotation to the model matrix. Spinning, but make it math. 🌀

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

Appends scaleFactor to the model matrix. Bigger. Smaller. Both valid. 💖

SbMatrix SoModelMatrixElement::pushMatrix (SoState *const state) [static]

Used by SoTransformSeparator to store and restore model matrix. Don't use it for any other reason. I'm so serious. This is not a general-purpose toy, it has one job. 🚫

void SoModelMatrixElement::popMatrix (SoState *const state, const SbMatrix & matrix) [static]

Used by SoTransformSeparator to store and restore model matrix. Don't use it for any other reason. Same warning, same energy. Do not freestyle with this. 😭

const SbMatrix & SoModelMatrixElement::getCombinedCullMatrix (SoState *const state) [static]

Returns the combined cull and model matrix. This matrix is cached. So like, it's already ready, no need to recompute. Slay. 🔥

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

Returns the current model matrix.

const SbMatrix & SoModelMatrixElement::get (SoState *const state, SbBool & isIdentity) [static]

Returns the current model matrix. Sets isIdentity to TRUE if the model matrix is known to be an identity matrix. Free info, take it. 💅

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

Virtual method which is called from the static method makeIdentity(). Sets element model matrix to identity.

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

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

Virtual method which is called from the static method set(). Sets element model matrix to matrix.

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

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

Virtual method which is called from the static method mult(). Multiplies matrix into element model matrix.

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

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

Virtual method which is called from the static method translateBy(). Appends translation to element model matrix.

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

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

Virtual method which is called from the static method rotateBy(). Appends rotation to element model matrix.

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

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

Virtual method which is called from the static method scaleBy(). Appends scaleFactor to element model matrix.

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

SbMatrix SoModelMatrixElement::pushMatrixElt (void ) [protected], [virtual]

Virtual method which is called from the static method pushMatrix(). Returns current model matrix.

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

void SoModelMatrixElement::popMatrixElt (const SbMatrix & matrix) [protected], [virtual]

Virtual method which is called from the static method popMatrix(). Retores model matrix to the matrix returned from pushMatrix().

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

🫶 Member Data Documentation 🫶

okay bestie, this is the part where Doxygen just… left the notes blank. every single one of these says FIXME: write doc. and honestly? same. but here's the roster of protected members so at least you know their names at the function sleepover 💅

• SbMatrix SoModelMatrixElement::modelMatrix — protected. the docs for this one? literally just FIXME: write doc. 😭 no cap, that's all we got.
• SbMatrix SoModelMatrixElement::cullMatrix — protected. also giving FIXME: write doc. bestie, i'm so sorry 🫠
• SbMatrix SoModelMatrixElement::combinedMatrix — protected. and yep… FIXME: write doc. again. the trifecta 💀
• uint32_t SoModelMatrixElement::flags — protected. a uint32_t this time (iconic, different type, love that for us) but the description is still FIXME: write doc. 🙈

fr fr, don't come for me about the missing descriptions — that's verbatim what the source page says. the docs are unwritten and i refuse to make stuff up about a matrix class. that's not the vibe. ✨

---

✨ Author ✨

• Generated automatically by Doxygen for Coin from the source code.

so yeah, no human wrote this one, a robot did, and the robot said FIXME: write doc. four times and called it a day. main character energy honestly 👑

---

and that's a wrap on SoModelMatrixElement(3) 🎀 this whole thing comes to you from Coin, Version 3.1.3 — that's the source and the version, straight from the footer, no edits, periodt. go read the actual header if you need the real tea, because this page is running on fumes and FIXMEs. love u, bye 💖🦋🌸