Drag[en]gine Game Engine  1.0
deComponentBone Class Reference

Scene component bone. More...

#include <deComponentBone.h>

Public Member Functions

Constructors and Destructors
 deComponentBone ()
 Creates a new component bone. More...
 
 ~deComponentBone ()
 Cleans up the component bone. More...
 
Management
const decVectorGetPosition () const
 Retrieves the position relative to the rig bone coordinate system. More...
 
void SetPosition (const decVector &position)
 Sets the position relative to the rig bone coordinate system. More...
 
const decVectorGetRotation () const
 Retrieves the rotation in radians relative to the rig bone coordinate system. More...
 
void SetRotation (const decVector &rotation)
 Sets the rotation in radians relative to the rig bone coordinate system. More...
 
const decVectorGetScale () const
 Retrieves the scaling relative to the rig bone coordinate system. More...
 
void SetScale (const decVector &scale)
 Sets the scaling relative to the rig bone coordinate system. More...
 
const decMatrixGetMatrix () const
 Retrieves the bone matrix relative to the component coordinate system. More...
 
void SetMatrix (const decMatrix &matrix)
 Retrieves the bone matrix relative to the component coordinate system. More...
 
const decMatrixGetInverseMatrix ()
 Retrieves the inverse bone matrix relative to the component coordinate system. More...
 
const decMatrixGetOriginalMatrix () const
 Retrieves the original matrix relative to the rig bone parent. More...
 
const decMatrixGetInverseOriginalMatrix () const
 Retrieves the inverse original matrix relative to the rig bone parent. More...
 
void SetOriginalMatrix (const decVector &position, const decVector &rotation)
 Set the original matrix and original inverse matrix. More...
 
const decMatrixGetWeightMatrix () const
 
void SetWeightMatrix (const decMatrix &mat)
 
int GetParentBone () const
 
void SetParentBone (int parentBone)
 

Detailed Description

Scene component bone.

Holds the state of a rig or component bone

Todo:
  • Remove weight matrix as the graphic module calculates it itself
Author
Pl├╝ss Roland
Version
1.0
Date
2015

Constructor & Destructor Documentation

◆ deComponentBone()

deComponentBone::deComponentBone ( )

Creates a new component bone.

◆ ~deComponentBone()

deComponentBone::~deComponentBone ( )

Cleans up the component bone.

Member Function Documentation

◆ GetInverseMatrix()

const decMatrix& deComponentBone::GetInverseMatrix ( )

Retrieves the inverse bone matrix relative to the component coordinate system.

Calculates the inverse matrix from the matrix if dirty. Valid only after PrepareBones has been called on the parent component.

Referenced by GetMatrix().

◆ GetInverseOriginalMatrix()

const decMatrix& deComponentBone::GetInverseOriginalMatrix ( ) const
inline

Retrieves the inverse original matrix relative to the rig bone parent.

References SetOriginalMatrix().

◆ GetMatrix()

const decMatrix& deComponentBone::GetMatrix ( ) const
inline

Retrieves the bone matrix relative to the component coordinate system.

Valid only after PrepareBones has been called on the parent component.

References GetInverseMatrix(), and SetMatrix().

◆ GetOriginalMatrix()

const decMatrix& deComponentBone::GetOriginalMatrix ( ) const
inline

Retrieves the original matrix relative to the rig bone parent.

◆ GetParentBone()

int deComponentBone::GetParentBone ( ) const
inline
Deprecated:
Information stored in rig bone.

References SetParentBone().

◆ GetPosition()

const decVector& deComponentBone::GetPosition ( ) const
inline

Retrieves the position relative to the rig bone coordinate system.

References SetPosition().

◆ GetRotation()

const decVector& deComponentBone::GetRotation ( ) const
inline

Retrieves the rotation in radians relative to the rig bone coordinate system.

References SetRotation().

◆ GetScale()

const decVector& deComponentBone::GetScale ( ) const
inline

Retrieves the scaling relative to the rig bone coordinate system.

References SetScale().

◆ GetWeightMatrix()

const decMatrix& deComponentBone::GetWeightMatrix ( ) const
inline
Deprecated:
Move to graphic/physics module.

References SetWeightMatrix().

◆ SetMatrix()

void deComponentBone::SetMatrix ( const decMatrix matrix)

Retrieves the bone matrix relative to the component coordinate system.

Marks the inverse matrix dirty causing the inverse matrix to be calculated the next time GetInverseMatrix is called.

Referenced by GetMatrix().

◆ SetOriginalMatrix()

void deComponentBone::SetOriginalMatrix ( const decVector position,
const decVector rotation 
)

Set the original matrix and original inverse matrix.

Referenced by GetInverseOriginalMatrix().

◆ SetParentBone()

void deComponentBone::SetParentBone ( int  parentBone)
Deprecated:
Information stored in rig bone.

Referenced by GetParentBone().

◆ SetPosition()

void deComponentBone::SetPosition ( const decVector position)

Sets the position relative to the rig bone coordinate system.

Referenced by GetPosition().

◆ SetRotation()

void deComponentBone::SetRotation ( const decVector rotation)

Sets the rotation in radians relative to the rig bone coordinate system.

Referenced by GetRotation().

◆ SetScale()

void deComponentBone::SetScale ( const decVector scale)

Sets the scaling relative to the rig bone coordinate system.

Referenced by GetScale().

◆ SetWeightMatrix()

void deComponentBone::SetWeightMatrix ( const decMatrix mat)
Deprecated:
Move to graphic/physics module.

Referenced by GetWeightMatrix().


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