Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://coin3d.github.io
https://www.kongsberg.com/en/kogt/
SoModelMatrixElement Class Reference

The SoModelMatrixElement class is used to manage the current transformation. More...

#include <Inventor/elements/SoModelMatrixElement.h>

Inheritance diagram for SoModelMatrixElement:
SoAccumulatedElement SoElement SoBBoxModelMatrixElement SoGLModelMatrixElement

Public Member Functions

virtual void init (SoState *state)
 
virtual void push (SoState *state)
 
virtual SbBool matches (const SoElement *element) const
 
const SbMatrixgetModelMatrix (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 SbMatrixgetCombinedCullMatrix (SoState *const state)
 
static const SbMatrixget (SoState *const state)
 
static const SbMatrixget (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 SoElementcopyMatchInfo (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)
 
SoElementgetNextInStack (void) const
 
SoElementgetNextFree (void) const
 

Protected Attributes

SbMatrix modelMatrix
 
SbMatrix cullMatrix
 
SbMatrix combinedMatrix
 
uint32_t flags
 
- Protected Attributes inherited from SoAccumulatedElement
SbList< SbUniqueId > nodeIds
 
- Protected Attributes inherited from SoElement
SoType typeId
 
int stackIndex
 
int depth
 

Additional Inherited Members

- Static Protected Member Functions inherited from SoElement
static SoElementgetElement (SoState *const state, const int stackIndex)
 
static const SoElementgetConstElement (SoState *const state, const int stackIndex)
 
static int createStackIndex (const SoType id)
 
- Static Protected Attributes inherited from SoElement
static int classStackIndex
 
static SoTypeListstackToType
 

Detailed Description

The SoModelMatrixElement class is used to manage the current transformation.

SoModelMatrixElement contains the object-to-world matrix.

The world-to-camera transformation is stored in the SoViewingMatrixElement class.

Note that one thing that can be a little confusing with the API is that SoModelMatrixElement does not contain the same matrix as the OpenGL GL_MODELVIEW matrix.

See also
SoViewingMatrixElement

Constructor & Destructor Documentation

◆ ~SoModelMatrixElement()

SoModelMatrixElement::~SoModelMatrixElement ( void  )
protectedvirtual

The destructor.

Member Function Documentation

◆ createInstance()

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.

◆ initClass()

void SoModelMatrixElement::initClass ( void  )
static

This static method initializes static data for the SoModelMatrixElement class.

◆ init()

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.

◆ push()

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.

◆ matches()

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.

Reimplemented from SoAccumulatedElement.

◆ makeIdentity()

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

Sets the current model matrix to the identity matrix.

◆ set()

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

Sets the current model matrix to matrix.

◆ setCullMatrix()

void SoModelMatrixElement::setCullMatrix ( SoState state,
SoNode node,
const SbMatrix matrix 
)
static

Sets the current cull matrix.

◆ mult()

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

Multiplies matrix into the model matrix.

◆ translateBy()

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

Appends translation to the model matrix.

◆ rotateBy()

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

Appends rotation to the model matrix.

◆ scaleBy()

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

Appends scaleFactor to the model matrix.

◆ pushMatrix()

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

Used by SoTransformSeparator to store and restore model matrix. Don't use it for any other reason.

◆ popMatrix()

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.

◆ getCombinedCullMatrix()

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

Returns the combined cull and model matrix. This matrix is cached.

◆ get() [1/2]

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

Returns the current model matrix.

◆ get() [2/2]

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.

◆ makeEltIdentity()

void SoModelMatrixElement::makeEltIdentity ( void  )
protectedvirtual

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

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

◆ setElt()

void SoModelMatrixElement::setElt ( const SbMatrix matrix)
protectedvirtual

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

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

◆ multElt()

void SoModelMatrixElement::multElt ( const SbMatrix matrix)
protectedvirtual

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

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

◆ translateEltBy()

void SoModelMatrixElement::translateEltBy ( const SbVec3f translation)
protectedvirtual

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

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

◆ rotateEltBy()

void SoModelMatrixElement::rotateEltBy ( const SbRotation rotation)
protectedvirtual

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

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

◆ scaleEltBy()

void SoModelMatrixElement::scaleEltBy ( const SbVec3f scaleFactor)
protectedvirtual

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

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

◆ pushMatrixElt()

SbMatrix SoModelMatrixElement::pushMatrixElt ( void  )
protectedvirtual

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

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

◆ popMatrixElt()

void SoModelMatrixElement::popMatrixElt ( const SbMatrix matrix)
protectedvirtual

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

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

Member Data Documentation

◆ modelMatrix

SoModelMatrixElement::modelMatrix
protected

FIXME: write doc.

◆ cullMatrix

SoModelMatrixElement::cullMatrix
protected

FIXME: write doc.

◆ combinedMatrix

SoModelMatrixElement::combinedMatrix
protected

FIXME: write doc.

◆ flags

SoModelMatrixElement::flags
protected

FIXME: write doc.


The documentation for this class was generated from the following files: