KFbxXMatrix Class Reference

#include <kfbxxmatrix.h>

Inheritance diagram for KFbxXMatrix:

[legend]

List of all members.

---

Detailed Description

FBX SDK affine matrix class.

Matrices are defined using the Column Major scheme. When a KFbxXMatrix represents a transformation (translation, rotation and scale), the last row of the matrix represents the translation part of the transformation.

Remarks:

It is important to realize that an affine matrix must respect a certain structure. To be sure the structure is respected, use SetT, SetR, SetS, SetQ, SetTRS or SetTQS. If by mistake bad data is entered in this affine matrix, some functions such as Inverse() will yield wrong results. If a matrix is needed to hold values that aren't associate with an affine matrix, please use KFbxMatrix instead.

Definition at line 61 of file kfbxxmatrix.h.

Constructors and Destructor
	KFbxXMatrix ()
	Constructor.
	KFbxXMatrix (const KFbxXMatrix &pXMatrix)
	Copy constructor.
	KFbxXMatrix (const KFbxVector4 &pT, const KFbxVector4 &pR, const KFbxVector4 &pS)
	Constructor.
	~KFbxXMatrix ()
	Destructor.
Access
double	Get (int pY, int pX) const
	Retrieve matrix element.
KFbxVector4	GetT () const
	Extract translation vector.
KFbxVector4	GetR () const
	Extract rotation vector.
KFbxQuaternion	GetQ () const
	Extract quaternion vector.
KFbxVector4	GetS () const
	Extract scale vector.
KFbxVector4	GetRow (int pY) const
	Extract a row vector.
KFbxVector4	GetColumn (int pX) const
	Extract a column vector.
void	SetIdentity ()
	Set matrix to identity.
void	SetT (const KFbxVector4 &pT)
	Set matrix's translation.
void	SetR (const KFbxVector4 &pR)
	Set matrix's Euler rotation.
void	SetQ (const KFbxQuaternion &pQ)
	Set matrix's quaternion.
void	SetS (const KFbxVector4 &pS)
	Set matrix's scale.
void	SetTRS (const KFbxVector4 &pT, const KFbxVector4 &pR, const KFbxVector4 &pS)
	Set matrix.
void	SetTQS (const KFbxVector4 &pT, const KFbxQuaternion &pQ, const KFbxVector4 &pS)
	Set matrix.
KFbxXMatrix &	operator= (const KFbxXMatrix &pM)
	Assignment operator.
Scalar Operations
KFbxXMatrix	operator* (double pValue) const
	Multiply matrix by a scalar value.
KFbxXMatrix	operator/ (double pValue) const
	Divide matrix by a scalar value.
KFbxXMatrix &	operator*= (double pValue)
	Multiply matrix by a scalar value.
KFbxXMatrix &	operator/= (double pValue)
	Divide matrix by a scalar value.
Vector Operations
KFbxVector4	MultT (const KFbxVector4 &pVector4) const
	Multiply matrix by a translation vector.
KFbxVector4	MultR (const KFbxVector4 &pVector4) const
	Multiply matrix by an Euler rotation vector.
KFbxQuaternion	MultQ (const KFbxQuaternion &pQuaternion) const
	Multiply matrix by a quaternion.
KFbxVector4	MultS (const KFbxVector4 &pVector4) const
	Multiply matrix by a scale vector.
Matrix Operations
KFbxXMatrix	operator- () const
	Unary minus operator.
KFbxXMatrix	operator* (const KFbxXMatrix &pXMatrix) const
	Multiply two matrices together.
KFbxXMatrix &	operator*= (const KFbxXMatrix &pXMatrix)
	Multiply two matrices together.
KFbxXMatrix	Inverse () const
	Calculate the matrix inverse.
KFbxXMatrix	Transpose () const
	Calculate the matrix transpose.
Boolean Operations
bool	operator== (const KFbxXMatrix &pXMatrix) const
	Equivalence operator.
bool	operator!= (const KFbxXMatrix &pXMatrix) const
	Non-equivalence operator.
Casting
	operator double * ()
	Cast the matrix in a double pointer.
	operator const double * () const
	Cast the matrix in a const double pointer.
typedef const	double (kDouble44)[4][4]
	Define 4*4 array as a new type.
kDouble44 &	Double44 () const
	Cast the matrix in a reference to a 4*4 array.

---

Constructor & Destructor Documentation

KFbxXMatrix

(

)

Constructor.

KFbxXMatrix

(

const KFbxXMatrix &

pXMatrix

)

Copy constructor.

Parameters:

pXMatrix

KFbxXMatrix copied to this one.

KFbxXMatrix	(	const KFbxVector4 &	pT,
		const KFbxVector4 &	pR,
		const KFbxVector4 &	pS
	)

Constructor.

Parameters:

	pT	Translation vector.
	pR	Euler rotation vector.
	pS	Scale vector.

~KFbxXMatrix

(

)

Destructor.

---

Member Function Documentation

double Get	(	int	pY,
		int	pX
	)			const

Retrieve matrix element.

Parameters:

	pY	Row index.
	pX	Column index.

Returns:

Cell [ pX, pY ] value.

KFbxVector4 GetT

(

)

const

Extract translation vector.

Returns:

Translation vector.

Referenced by KFbxCharacterPose::GetLocalPosition().

KFbxVector4 GetR

(

)

const

Extract rotation vector.

Returns:

Rotation vector.

Referenced by KFbxCharacterPose::GetLocalPosition().

KFbxQuaternion GetQ

(

)

const

Extract quaternion vector.

Returns:

Quaternion vector.

KFbxVector4 GetS

(

)

const

Extract scale vector.

Returns:

Scale vector.

Referenced by KFbxCharacterPose::GetLocalPosition().

KFbxVector4 GetRow

(

int

pY

)

const

Extract a row vector.

Parameters:

pY

Row index.

Returns:

The row vector.

KFbxVector4 GetColumn

(

int

pX

)

const

Extract a column vector.

Parameters:

pX

Column index.

Returns:

The column vector.

void SetIdentity

(

)

Set matrix to identity.

void SetT

(

const KFbxVector4 &

pT

)

Set matrix's translation.

Parameters:

pT

Translation vector.

void SetR

(

const KFbxVector4 &

pR

)

Set matrix's Euler rotation.

Parameters:

pR

X, Y and Z rotation values expressed as a vector.

void SetQ

(

const KFbxQuaternion &

pQ

)

Set matrix's quaternion.

Parameters:

pQ

The new quaternion.

void SetS

(

const KFbxVector4 &

pS

)

Set matrix's scale.

Parameters:

pS

X, Y and Z scaling factors expressed as a vector.

void SetTRS	(	const KFbxVector4 &	pT,
		const KFbxVector4 &	pR,
		const KFbxVector4 &	pS
	)

Set matrix.

Parameters:

	pT	Translation vector.
	pR	Rotation vector.
	pS	Scale vector.

Referenced by KFbxCharacterPose::GetOffset().

void SetTQS	(	const KFbxVector4 &	pT,
		const KFbxQuaternion &	pQ,
		const KFbxVector4 &	pS
	)

Set matrix.

Parameters:

	pT	Translation vector.
	pQ	Quaternion vector.
	pS	Scale vector.

KFbxXMatrix& operator=

(

const KFbxXMatrix &

pM

)

Assignment operator.

Parameters:

pM

KFbxXMatrix assigned to this one.

KFbxXMatrix operator*

(

double

pValue

)

const

Multiply matrix by a scalar value.

Parameters:

pValue

Scalar value.

Returns:

The scaled matrix.

Remarks:

The passed value is not checked. This operator operates on the first three rows and columns of the matrix. So only the rotation and scaling are scaled, not the translation part. After operation, the translation vector will be set as (0,0,0,1);

KFbxXMatrix operator/

(

double

pValue

)

const

Divide matrix by a scalar value.

Parameters:

pValue

Scalar value.

Returns:

The divided matrix.

Remarks:

The passed value is not checked. This operator operates on the first three rows and columns of the matrix. So only the rotation and scaling are scaled, not the translation part. After operation, the translation vector will be set as (0,0,0,1);

KFbxXMatrix& operator*=

(

double

pValue

)

Multiply matrix by a scalar value.

Parameters:

pValue

Scalar value.

Returns:

this updated with the result of the multiplication.

Remarks:

The passed value is not checked. This operator operates on the first three rows and columns of the matrix. So only the rotation and scaling are scaled, not the translation part. After operation, the translation vector will keep original value.

KFbxXMatrix& operator/=

(

double

pValue

)

Divide matrix by a scalar value.

Parameters:

pValue

Scalar value.

Returns:

this updated with the result of the division.

Remarks:

The passed value is not checked. This operator operates on the first three rows and columns of the matrix. So only the rotation and scaling are scaled, not the translation part. After operation, the translation vector will keep original value.

KFbxVector4 MultT

(

const KFbxVector4 &

pVector4

)

const

Multiply matrix by a translation vector.

Parameters:

pVector4

Translation vector.

Returns:

t' = M * t

KFbxVector4 MultR

(

const KFbxVector4 &

pVector4

)

const

Multiply matrix by an Euler rotation vector.

Parameters:

pVector4

Euler Rotation vector.

Returns:

r' = M * r

KFbxQuaternion MultQ

(

const KFbxQuaternion &

pQuaternion

)

const

Multiply matrix by a quaternion.

Parameters:

pQuaternion

Rotation value.

Returns:

q' = M * q

KFbxVector4 MultS

(

const KFbxVector4 &

pVector4

)

const

Multiply matrix by a scale vector.

Parameters:

pVector4

Scaling vector.

Returns:

s' = M * s

KFbxXMatrix operator-

(

)

const

Unary minus operator.

Returns:

A matrix where each element is multiplied by -1.

KFbxXMatrix operator*

(

const KFbxXMatrix &

pXMatrix

)

const

Multiply two matrices together.

Parameters:

pXMatrix

A Matrix.

Returns:

this * pMatrix.

KFbxXMatrix& operator*=

(

const KFbxXMatrix &

pXMatrix

)

Multiply two matrices together.

Parameters:

pXMatrix

A Matrix.

Returns:

this updated with the result of the multiplication.

KFbxXMatrix Inverse

(

)

const

Calculate the matrix inverse.

Returns:

The inverse matrix of this.

KFbxXMatrix Transpose

(

)

const

Calculate the matrix transpose.

Returns:

The transposed matrix of this.

bool operator==

(

const KFbxXMatrix &

pXMatrix

)

const

Equivalence operator.

Parameters:

pXMatrix

The matrix to be compared to this.

Returns:

true if the two matrices are equal (each element is within a 1.0e-6 tolerance) and false otherwise.

bool operator!=

(

const KFbxXMatrix &

pXMatrix

)

const

Non-equivalence operator.

Parameters:

pXMatrix

The matrix to be compared to this.

Returns:

false if the two matrices are equal (each element is within a 1.0e-6 tolerance) and true otherwise.

operator double *

(

)

Cast the matrix in a double pointer.

operator const double *

(

)

const

Cast the matrix in a const double pointer.

typedef const double

(

kDouble44

)

Define 4*4 array as a new type.

kDouble44& Double44

(

)

const [inline]

Cast the matrix in a reference to a 4*4 array.

Definition at line 327 of file kfbxxmatrix.h.