SoModelMatrixElement Class Reference

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

#include <Inventor/elements/SoModelMatrixElement.h>

Inheritance diagram for SoModelMatrixElement:

Public Member Functions
const SbMatrix &	getModelMatrix (void) const
virtual void	init (SoState *state)
virtual SbBool	matches (const SoElement *element) const
virtual void	push (SoState *state)
Public Member Functions inherited from SoElement
virtual	~SoElement ()
int	getDepth (void) const
int	getStackIndex (void) const
const SoType	getTypeId (void) const
virtual void	pop (SoState *state, const SoElement *prevTopElement)
virtual void	print (FILE *file=stdout) const
void	setDepth (const int depth)

Static Public Member Functions
static void *	createInstance (void)
static const SbMatrix &	get (SoState *const state)
static const SbMatrix &	get (SoState *const state, SbBool &isIdentity)
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static const SbMatrix &	getCombinedCullMatrix (SoState *const state)
static void	initClass (void)
static void	makeIdentity (SoState *const state, SoNode *const node)
static void	mult (SoState *const state, SoNode *const node, const SbMatrix &matrix)
static void	popMatrix (SoState *const state, const SbMatrix &matrix)
static SbMatrix	pushMatrix (SoState *const state)
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 void	set (SoState *const state, SoNode *const node, const SbMatrix &matrix)
static void	setCullMatrix (SoState *state, SoNode *node, const SbMatrix &matrix)
static void	translateBy (SoState *const state, SoNode *const node, const SbVec3f &translation)
Static Public Member Functions inherited from SoAccumulatedElement
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static void	initClass (void)
Static Public Member Functions inherited from SoElement
static int	getClassStackIndex (void)
static SoType	getClassTypeId (void)
static SoType	getIdFromStackIndex (const int stackIndex)
static int	getNumStackIndices (void)
static void	initClass (void)
static void	initElements (void)

Protected Member Functions
virtual	~SoModelMatrixElement ()
virtual void	makeEltIdentity (void)
virtual void	multElt (const SbMatrix &matrix)
virtual void	popMatrixElt (const SbMatrix &matrix)
virtual SbMatrix	pushMatrixElt (void)
virtual void	rotateEltBy (const SbRotation &rotation)
virtual void	scaleEltBy (const SbVec3f &scaleFactor)
virtual void	setElt (const SbMatrix &matrix)
virtual void	translateEltBy (const SbVec3f &translation)
Protected Member Functions inherited from SoAccumulatedElement
virtual	~SoAccumulatedElement ()
void	addNodeId (const SoNode *const node)
virtual void	captureThis (SoState *state) const
void	clearNodeIds (void)
virtual SoElement *	copyMatchInfo (void) const
void	copyNodeIds (const SoAccumulatedElement *copyfrom)
void	setNodeId (const SoNode *const node)
Protected Member Functions inherited from SoElement
	SoElement (void)
void	capture (SoState *const state) const
SoElement *	getNextFree (void) const
SoElement *	getNextInStack (void) const
void	setStackIndex (const int index)
void	setTypeId (const SoType typeId)

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

Additional Inherited Members
Static Protected Member Functions inherited from SoElement
static int	createStackIndex (const SoType id)
static const SoElement *	getConstElement (SoState *const state, const int stackIndex)
static SoElement *	getElement (SoState *const state, const int stackIndex)
Static Protected Attributes inherited from SoElement
static int	classStackIndex
static SoTypeList *	stackToType

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

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.

Creates a new instance of the class type corresponding to the SoType object.

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.

getClassStackIndex()

int SoModelMatrixElement::getClassStackIndex ( void )

static

This static method returns the state stack index for the class.

getClassTypeId()

SoType SoModelMatrixElement::getClassTypeId ( void )

static

This static method returns the SoType object associated with objects of this class.

getCombinedCullMatrix()

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

static

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

getModelMatrix()

const SbMatrix & SoModelMatrixElement::getModelMatrix

(

void

)

const

Returns the current model matrix.

init()

void SoModelMatrixElement::init ( SoState * state )

virtual

Initializes the element to its default value. The default value for modelMatrix is the identity matrix.

Reimplemented from SoAccumulatedElement.

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

initClass()

void SoModelMatrixElement::initClass ( void )

static

Initialize relevant common data for all instances, like the type system.

makeEltIdentity()

void SoModelMatrixElement::makeEltIdentity ( void )

protectedvirtual

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

Reimplemented in SoGLModelMatrixElement, and SoBBoxModelMatrixElement.

makeIdentity()

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

static

Sets the current model matrix to the identity matrix.

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.

mult()

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

static

Multiplies matrix into the model matrix.

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.

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.

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.

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.

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.

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.

rotateBy()

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

static

Appends rotation to the model matrix.

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.

scaleBy()

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

static

Appends scaleFactor to the model matrix.

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.

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.

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.

translateBy()

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

static

Appends translation to the model matrix.

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.

Member Data Documentation

combinedMatrix

SoModelMatrixElement::combinedMatrix

protected

FIXME: write doc.

cullMatrix

SoModelMatrixElement::cullMatrix

protected

FIXME: write doc.

flags

SoModelMatrixElement::flags

protected

FIXME: write doc.

modelMatrix

SoModelMatrixElement::modelMatrix

protected

FIXME: write doc.

---

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

• SoModelMatrixElement.h
• SoModelMatrixElement.cpp