FBPose Class Reference

This reference page is linked to from the following overview topics: FBPose - Poses.

---

Search for all occurrences

---

Detailed Description

Pose class.

Definition at line 75 of file fbpose.h.

#include <fbpose.h>

Inheritance diagram for FBPose:

List of all members.

Public Member Functions
	FBPose (char *pName, HIObject pObject=NULL)
	Constructor.
	IQuery_Declare (Implementation)
int	GetNodeCount ()
	Returns the number of pose nodes stored.
int	AddNode (HFBModel pObject, FBMatrix *pMatrix=NULL, bool pIsLocalMatrix=false)
	Add a new pose node.
void	RemoveNode (int pIndex)
	Remove the pose node at specified index.
void	SetNodeObject (int pIndex, HFBModel pObject)
	Set the pose node object.
HFBModel	GetNodeObject (int pIndex)
	Get the pose node object.
FBString	GetNodeName (int pIndex) const
	Get the pose node at specified index.
void	SetNodeMatrix (int pIndex, FBMatrix *pMatrix)
	Set the pose node matrix.
FBMatrix	GetNodeMatrix (int pIndex) const
	Get the pose node matrix.
FBMatrix	GetNodeMatrixGlobal (int pIndex) const
	Get the global pose node matrix.
void	SetIsNodeLocalMatrix (int pIndex, bool pIsNodeLocalMatrix)
	Set the type of the Matrix for a given node.
bool	IsNodeLocalMatrix (int pIndex)
	Get the type of the Matrix for a given node.
int	Find (FBString pNodeName)
	Look in this pose if the given node is present.
Public Attributes
FBPropertyPoseType	Type
	Read Only Property: Type of the pose (bind pose or rest pose)

---

Constructor & Destructor Documentation

FBPose	(	char *	pName,
		HIObject	pObject = NULL
	)

Constructor.

Parameters:

pName	Name of pose.
pObject	For internal use only (default=NULL).

---

Member Function Documentation

IQuery_Declare

(

Implementation

)

Search for all occurrences

int GetNodeCount

(

)

Search for all occurrences

Returns the number of pose nodes stored.

int AddNode	(	HFBModel	pObject,
		FBMatrix *	pMatrix = NULL,
		bool	pIsLocalMatrix = false
	)

Search for all occurrences

Add a new pose node.

Parameters:

pObject	The object for which we are creating the pose information.
pMatrix	The transformation of the object we want to save.
pIsLocalMatrix	Is the matrix a local matrix?

void RemoveNode

(

int

pIndex

)

Search for all occurrences

Remove the pose node at specified index.

Parameters:

pIndex

Index of the node to be removed.

void SetNodeObject	(	int	pIndex,
		HFBModel	pObject
	)

Search for all occurrences

Set the pose node object.

Parameters:

pIndex	Index of the node.
pObject	Object to associate with this pose node.

HFBModel GetNodeObject

(

int

pIndex

)

Search for all occurrences

Get the pose node object.

Parameters:

pIndex

Index of the node.

Returns:

a pointer to the node's Object.

Remarks:

if the index is invalid a null pointer is returned.

FBString GetNodeName

(

int

pIndex

)

const

Search for all occurrences

Get the pose node at specified index.

Parameters:

pIndex

Index of the node.

Remarks:

if the index is invalid a reference to an empty string is returned.

The reference will become undefined if this object is destroyed.

void SetNodeMatrix	(	int	pIndex,
		FBMatrix *	pMatrix
	)

Search for all occurrences

Set the pose node matrix.

Parameters:

pIndex	Index of the node.
pMatrix	Matrix to set for this pose node.

FBMatrix GetNodeMatrix

(

int

pIndex

)

const

Search for all occurrences

Get the pose node matrix.

Parameters:

pIndex

Index of the node.

Returns:

a reference to the node's Matrix.

Remarks:

if the index is invalid a reference to an identiy matrix is returned.

The reference will become undefined if this object is destroyed.

FBMatrix GetNodeMatrixGlobal

(

int

pIndex

)

const

Search for all occurrences

Get the global pose node matrix.

Parameters:

pIndex

Index of the node.

Returns:

a reference to the node's Global Matrix.

Remarks:

if the index is invalid a reference to an identiy matrix is returned.

The reference will become undefined if this object is destroyed.

void SetIsNodeLocalMatrix	(	int	pIndex,
		bool	pIsNodeLocalMatrix
	)

Search for all occurrences

Set the type of the Matrix for a given node.

Parameters:

pIndex	Index of the node.
pIsNodeLocalMatrix	True if the matrix of the node is a local matrix.

bool IsNodeLocalMatrix

(

int

pIndex

)

Search for all occurrences

Get the type of the Matrix for a given node.

Parameters:

pIndex

Index of the node.

Returns:

true if the matrix is defined in Local coordinate space.

Remarks:

If this object is configured to hold BindPose data, this method will always return false.

int Find

(

FBString

pNodeName

)

Search for all occurrences

Look in this pose if the given node is present.

Parameters:

pNodeName

Name of the node we are looking for.

Returns:

-1 if the node is not in the list or it's position.

---

Member Data Documentation

FBPropertyPoseType Type

Search for all occurrences

Read Only Property: Type of the pose (bind pose or rest pose)

Definition at line 165 of file fbpose.h.

---

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

• fbsdk/fbpose.h