Open Inventor Reference
SoModelMatrixElement Class Reference

Element that stores the current model matrix - the cumulative transformation applied to subsequent shapes. More...

#include <Inventor/elements/SoModelMatrixElement.h>

Inheritance diagram for SoModelMatrixElement:
SoAccumulatedElement SoElement SoBBoxModelMatrixElement SoGLModelMatrixElement

Public Member Functions

virtual void init (SoState *state)
 Initializes element.
 
virtual bool matches (const SoElement *elt) const
 Override standard matches to invalidate on cull-test.
 
virtual void push (SoState *state)
 Overrides push() method to copy values from next instance in the stack.
 
virtual void print (FILE *fp) const
 Prints element (for debugging)
 
virtual bool matches (const SoElement *elt) const
 Returns TRUE if the element matches another element, based on node-id's.
 
virtual void print (FILE *fp) const
 Prints element (for debugging)
 
- Public Member Functions inherited from SoElement
virtual void init (SoState *state)
 Initializes element.
 
virtual void push (SoState *state)
 Pushes/pops element.
 
virtual void pop (SoState *state, const SoElement *prevTopElement)
 
virtual void print (FILE *fp) const
 Prints element (for debugging)
 
virtual bool matches (const SoElement *elt) const =0
 Returns TRUE if the element matches another element (of the same class, presumably) with respect to cache validity.
 
virtual SoElementcopyMatchInfo () const =0
 Create a copy that we can put in a cache used list and call matches() on later.
 
SoType getTypeId () const
 Returns type identifier for element instance.
 
int getStackIndex () const
 Returns the stack index for an element instance.
 
void setDepth (int dpth)
 Sets stuff in an element instance.
 
void setNext (SoElement *nxt)
 
void setNextInStack (SoElement *nxt)
 
void setNextFree (SoElement *nxt)
 
int getDepth () const
 Returns stuff from element instance.
 
SoElementgetNext () const
 
virtual ~SoElement ()
 Destructor.
 

Static Public Member Functions

static void makeIdentity (SoState *state, SoNode *node)
 Sets the model matrix to the identity matrix.
 
static void set (SoState *state, SoNode *node, const SbMatrix &matrix)
 Sets the model matrix to the given matrix.
 
static void mult (SoState *state, SoNode *node, const SbMatrix &matrix)
 Multiplies the given matrix into the model matrix.
 
static void translateBy (SoState *state, SoNode *node, const SbVec3f &translation)
 Each of these multiplies a matrix that performs the specified transformation into the model matrix.
 
static void rotateBy (SoState *state, SoNode *node, const SbRotation &rotation)
 
static void scaleBy (SoState *state, SoNode *node, const SbVec3f &scaleFactor)
 
static SbMatrix pushMatrix (SoState *state)
 These methods are used by the TransformSeparator node.
 
static void popMatrix (SoState *state, const SbMatrix &m)
 
static void setCullMatrix (SoState *state, SoNode *node, const SbMatrix &matrix)
 Sets the transformation that defines the volume that view-volume culling should be tested against.
 
static const SbMatrixgetCombinedCullMatrix (SoState *state)
 This method gets the model*cullMatrix combined matrix (which is cached by this element).
 
static const SbMatrixget (SoState *state)
 Returns current model matrix from the state.
 
static const SbMatrixget (SoState *state, bool &isIdent)
 Returns current model matrix from the state, sets given flag to TRUE if matrix is known to be identity.
 
static void initClass ()
 Initializes the SoModelMatrixElement class.
 
- Static Public Member Functions inherited from SoAccumulatedElement
static void initClass ()
 Initializes the SoAccumulatedElement class.
 
- Static Public Member Functions inherited from SoElement
static SoType getClassTypeId ()
 Returns type identifier for SoElement class.
 
static void initElements ()
 Initialize ALL Inventor element classes.
 
static void initClass ()
 Initializes the SoElement class.
 
static int getNumStackIndices ()
 Returns the number of stack indices allocated.
 
static SoType getIdFromStackIndex (int stackIndex)
 Returns the id for the element with the given stack index.
 

Protected Member Functions

virtual void makeEltIdentity ()
 Sets the matrix in an instance to identity.
 
virtual void setElt (const SbMatrix &matrix)
 Sets the matrix in an instance to given matrix.
 
virtual void multElt (const SbMatrix &matrix)
 Multiplies into the matrix in an instance.
 
virtual void translateEltBy (const SbVec3f &translation)
 Each of these performs the appropriate operation on the matrix in an instance.
 
virtual void rotateEltBy (const SbRotation &translation)
 
virtual void scaleEltBy (const SbVec3f &scaleFactor)
 
virtual SbMatrix pushMatrixElt ()
 virtual methods for push/pop so GL element can Do The Right Thing:
 
virtual void popMatrixElt (const SbMatrix &m)
 
virtual ~SoModelMatrixElement ()
 
- Protected Member Functions inherited from SoAccumulatedElement
void clearNodeIds ()
 Clears out the list of node id's.
 
void addNodeId (const SoNode *node)
 Adds the id of the given node to the current list.
 
void setNodeId (const SoNode *node)
 Sets the node id list to JUST the id of the given node.
 
virtual SoElementcopyMatchInfo () const
 Create and return a copy of this element; this will copy the nodeId list properly.
 
virtual void captureThis (SoState *state) const
 Override normal capture method to capture elements at other depths that we are accumulating with.
 
virtual ~SoAccumulatedElement ()
 Destructor.
 
- Protected Member Functions inherited from SoElement
 SoElement ()
 Constructor; use typeId.createInstance to create elements.
 
void capture (SoState *state) const
 Does whatever is necessary in state to capture this element for caching purposes.
 
virtual void captureThis (SoState *state) const
 Really captures this element, once it has been determined that a cache is open to capture it.
 
void setTypeId (SoType id)
 Sets typeId in instance.
 
void setStackIndex (int index)
 Sets stackIndex in instance.
 
SoElementgetNextInStack () const
 Returns next instance in specific element stack.
 
SoElementgetNextFree () const
 Returns next free element in a specific element stack.
 

Friends

class SoLocalBBoxMatrixElement
 

Additional Inherited Members

- Static Protected Member Functions inherited from SoElement
static SoElementgetElement (SoState *state, int stackIndex)
 Returns an instance of an element from the stack with the given index in the given state.
 
static const SoElementgetConstElement (SoState *state, int stackIndex)
 Returns a read-only pointer to the top instance in the given element stack.
 
static int createStackIndex (SoType id)
 Creates and returns a new stack index.
 
- Protected Attributes inherited from SoAccumulatedElement
SbPList nodeIds
 This stores the list of node id's as pointers, since they should be the same length as int32_ts.
 
- Static Protected Attributes inherited from SoElement
static int classStackIndex
 Stack index for SoElement class.
 

Detailed Description

Because the matrix is cumulative, this class is derived from SoAccumulatedElement. The set() method replaces the current matrix, while all the others (mult(), translateBy(), etc.) multiply into it. Node id's of the nodes that affect the element are accumulated properly.

This element also stores the current view-volume culling transformation, which is normally the view*projection matrices (set by cameras), but which may be modified by sophisticated culling schemes.

Definition at line 80 of file SoModelMatrixElement.h.

Constructor & Destructor Documentation

◆ ~SoModelMatrixElement()

virtual SoModelMatrixElement::~SoModelMatrixElement ( )
protectedvirtual

Member Function Documentation

◆ get() [1/2]

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

◆ get() [2/2]

static const SbMatrix & SoModelMatrixElement::get ( SoState state,
bool &  isIdent 
)
static

◆ getCombinedCullMatrix()

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

◆ init()

virtual void SoModelMatrixElement::init ( SoState state)
virtual

Reimplemented from SoElement.

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

◆ initClass()

static void SoModelMatrixElement::initClass ( )
static

◆ makeEltIdentity()

virtual void SoModelMatrixElement::makeEltIdentity ( )
protectedvirtual

◆ makeIdentity()

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

◆ matches()

virtual bool SoModelMatrixElement::matches ( const SoElement elt) const
virtual

Reimplemented from SoAccumulatedElement.

◆ mult()

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

◆ multElt()

virtual void SoModelMatrixElement::multElt ( const SbMatrix matrix)
protectedvirtual

◆ popMatrix()

static void SoModelMatrixElement::popMatrix ( SoState state,
const SbMatrix m 
)
static

◆ popMatrixElt()

virtual void SoModelMatrixElement::popMatrixElt ( const SbMatrix m)
protectedvirtual

◆ print()

virtual void SoModelMatrixElement::print ( FILE *  fp) const
virtual

Reimplemented from SoAccumulatedElement.

◆ push()

virtual void SoModelMatrixElement::push ( SoState state)
virtual

Reimplemented from SoElement.

Reimplemented in SoBBoxModelMatrixElement, and SoGLModelMatrixElement.

◆ pushMatrix()

static SbMatrix SoModelMatrixElement::pushMatrix ( SoState state)
static

WARNING! For proper caching behavior, the matrix returned by pushMatrix() must be used ONLY as a later argument to popMatrix(), and you must NOT modify the matrix between the push and the pop. If you need the matrix for any other reason, you MUST use the get() routine.

◆ pushMatrixElt()

virtual SbMatrix SoModelMatrixElement::pushMatrixElt ( )
protectedvirtual

◆ rotateBy()

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

◆ rotateEltBy()

virtual void SoModelMatrixElement::rotateEltBy ( const SbRotation translation)
protectedvirtual

◆ scaleBy()

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

◆ scaleEltBy()

virtual void SoModelMatrixElement::scaleEltBy ( const SbVec3f scaleFactor)
protectedvirtual

◆ set()

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

◆ setCullMatrix()

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

◆ setElt()

virtual void SoModelMatrixElement::setElt ( const SbMatrix matrix)
protectedvirtual

◆ translateBy()

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

◆ translateEltBy()

virtual void SoModelMatrixElement::translateEltBy ( const SbVec3f translation)
protectedvirtual

Friends And Related Symbol Documentation

◆ SoLocalBBoxMatrixElement

friend class SoLocalBBoxMatrixElement
friend

Definition at line 179 of file SoModelMatrixElement.h.

Member Data Documentation

◆ haveCullMatrix

unsigned int SoModelMatrixElement::haveCullMatrix

Definition at line 175 of file SoModelMatrixElement.h.

◆ haveModelCull

unsigned int SoModelMatrixElement::haveModelCull

Definition at line 176 of file SoModelMatrixElement.h.

◆ isModelIdentity

unsigned int SoModelMatrixElement::isModelIdentity

Definition at line 174 of file SoModelMatrixElement.h.


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