PLMesh::JointState Class Reference

Joint state class. More...

#include <JointState.h>

Inheritance diagram for PLMesh::JointState:

List of all members.

Public Member Functions
PLMESH_API	JointState ()
	Constructor.
virtual PLMESH_API	~JointState ()
	Destructor.
PLMESH_API const PLMath::Vector3 &	GetTranslation () const
	Gets the joint translation.
PLMESH_API void	SetTranslation (const PLMath::Vector3 &vTranslation)
	Sets the joint translation.
PLMESH_API const PLMath::Quaternion &	GetRotation () const
	Gets the joint rotation.
PLMESH_API void	SetRotation (const PLMath::Quaternion &qRotation)
	Sets the joint rotation.
PLMESH_API const PLMath::Vector3 &	GetTranslationAbsolute () const
	Gets the absolute joint translation.
PLMESH_API void	SetTranslationAbsolute (const PLMath::Vector3 &vTranslation)
	Sets the absolute joint translation.
PLMESH_API const PLMath::Quaternion &	GetRotationAbsolute () const
	Gets the absolute joint rotation.
PLMESH_API void	SetRotationAbsolute (const PLMath::Quaternion &qRotation)
	Sets the absolute joint rotation.
PLMESH_API const PLMath::Matrix3x4 &	GetMatrixAbsolute () const
	Gets the absolute joint matrix.
PLMESH_API const PLMath::Matrix3x3 &	GetMatrixTransform () const
	Gets the transform joint matrix.
PLMESH_API const PLMath::Vector3 &	GetTranslationJointSpace () const
	Gets the joint space joint translation.
PLMESH_API void	SetTranslationJointSpace (const PLMath::Vector3 &vTranslation)
	Sets the joint space joint translation.
PLMESH_API const PLMath::Quaternion &	GetRotationJointSpace () const
	Gets the joint space joint rotation.
PLMESH_API void	SetRotationJointSpace (const PLMath::Quaternion &qRotation)
	Sets the joint space joint rotation.
PLMESH_API JointState &	operator= (const JointState &cSource)
	Copy operator.
PLMESH_API bool	operator== (const JointState &cJointState) const
	Compares two joint states.
Protected Attributes
PLMath::Vector3	m_vTranslation
PLMath::Quaternion	m_qRotation
PLMath::Vector3	m_vTranslationAbsolute
PLMath::Quaternion	m_qRotationAbsolute
PLMath::Matrix3x4	m_mTransAbsolute
PLMath::Matrix3x3	m_mTrans
PLMath::Vector3	m_vTranslationJointSpace
PLMath::Quaternion	m_qRotationJointSpace

---

Detailed Description

Joint state class.

---

Constructor & Destructor Documentation

PLMESH_API PLMesh::JointState::JointState

(

)

Constructor.

virtual PLMESH_API PLMesh::JointState::~JointState

(

)

[virtual]

Destructor.

---

Member Function Documentation

PLMESH_API const PLMath::Vector3& PLMesh::JointState::GetTranslation

(

)

const

Gets the joint translation.

Returns:

Joint translation

PLMESH_API void PLMesh::JointState::SetTranslation

(

const PLMath::Vector3 &

vTranslation

)

Sets the joint translation.

Parameters:

[in]

vTranslation

Joint translation

PLMESH_API const PLMath::Quaternion& PLMesh::JointState::GetRotation

(

)

const

Gets the joint rotation.

Returns:

Joint rotation

PLMESH_API void PLMesh::JointState::SetRotation

(

const PLMath::Quaternion &

qRotation

)

Sets the joint rotation.

Parameters:

[in]

qRotation

Joint rotation

PLMESH_API const PLMath::Vector3& PLMesh::JointState::GetTranslationAbsolute

(

)

const

Gets the absolute joint translation.

Returns:

Absolute joint translation

PLMESH_API void PLMesh::JointState::SetTranslationAbsolute

(

const PLMath::Vector3 &

vTranslation

)

Sets the absolute joint translation.

Parameters:

[in]

vTranslation

Absolute joint translation

PLMESH_API const PLMath::Quaternion& PLMesh::JointState::GetRotationAbsolute

(

)

const

Gets the absolute joint rotation.

Returns:

Absolute joint rotation

PLMESH_API void PLMesh::JointState::SetRotationAbsolute

(

const PLMath::Quaternion &

qRotation

)

Sets the absolute joint rotation.

Parameters:

[in]

qRotation

Absolute joint rotation

PLMESH_API const PLMath::Matrix3x4& PLMesh::JointState::GetMatrixAbsolute

(

)

const

Gets the absolute joint matrix.

Returns:

Absolute joint matrix

Note:

• This absolute transform matrix is created using the absolute joint translation and rotation.

PLMESH_API const PLMath::Matrix3x3& PLMesh::JointState::GetMatrixTransform

(

)

const

Gets the transform joint matrix.

Returns:

Transform joint matrix

PLMESH_API const PLMath::Vector3& PLMesh::JointState::GetTranslationJointSpace

(

)

const

Gets the joint space joint translation.

Returns:

Joint space joint translation

PLMESH_API void PLMesh::JointState::SetTranslationJointSpace

(

const PLMath::Vector3 &

vTranslation

)

Sets the joint space joint translation.

Parameters:

[in]

vTranslation

Joint space joint translation

PLMESH_API const PLMath::Quaternion& PLMesh::JointState::GetRotationJointSpace

(

)

const

Gets the joint space joint rotation.

Returns:

Joint space joint rotation

PLMESH_API void PLMesh::JointState::SetRotationJointSpace

(

const PLMath::Quaternion &

qRotation

)

Sets the joint space joint rotation.

Parameters:

[in]

qRotation

Joint space joint rotation

PLMESH_API JointState& PLMesh::JointState::operator=

(

const JointState &

cSource

)

Copy operator.

Parameters:

[in]

cSource

Source to copy from

Returns:

This joint state

PLMESH_API bool PLMesh::JointState::operator==

(

const JointState &

cJointState

)

const

Compares two joint states.

Parameters:

[in]

cJointState

Joint state to compare with

Returns:

'true' if both joint states are equal, else 'false'

---

Member Data Documentation

PLMath::Vector3 PLMesh::JointState::m_vTranslation [protected]

Translation

PLMath::Quaternion PLMesh::JointState::m_qRotation [protected]

Rotation

PLMath::Vector3 PLMesh::JointState::m_vTranslationAbsolute [protected]

Absolute translation

PLMath::Quaternion PLMesh::JointState::m_qRotationAbsolute [protected]

Absolute rotation

PLMath::Matrix3x4 PLMesh::JointState::m_mTransAbsolute [protected]

Absolute transformation matrix

PLMath::Matrix3x3 PLMesh::JointState::m_mTrans [protected]

3x3 orthonormal rotation matrix

PLMath::Vector3 PLMesh::JointState::m_vTranslationJointSpace [protected]

Joint space 3D translation vector

PLMath::Quaternion PLMesh::JointState::m_qRotationJointSpace [protected]

Joint space rotation

---

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

• JointState.h