FBPose Class Reference

FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose FBPose

Inheritance diagram for FBPose:

[legend]

List of all members.

---

Detailed Description

Pose class.

Public Member Functions
	FBPose (str pName)
	Constructor.
int	AddNode (FBModel pObject, FBMatrix pMatrix=None, bool pIsLocalMatrix=False)
	Add a new pose node.
int	Find (str pNodeName)
	Look in this pose if the given node is present.
int	GetNodeCount ()
	Returns the number of pose nodes stored.
FBMatrix	GetNodeMatrix (int pIndex)
	Get the pose node matrix.
str	GetNodeName (int pIndex)
	Get the pose node at specified index.
FBModel	GetNodeObject (int pIndex)
	Get the pose node object.
bool	IsNodeLocalMatrix (int pIndex)
	Get the type of the Matrix for a given node.
	RemoveNode (int pIndex)
	Remove the pose node at specified index.
	SetIsNodeLocalMatrix (int pIndex, bool pIsNodeLocalMatrix)
	Set the type of the Matrix for a given node.
	SetNodeMatrix (int pIndex, FBMatrix pMatrix)
	Set the pose node matrix.
	SetNodeObject (int pIndex, FBModel pObject)
	Set the pose node object.
Public Attributes
FBPoseType	Type
	Read Only Property: Type of the pose (bind pose or rest pose)

---

Constructor & Destructor Documentation

FBPose

(

str

pName

)

Constructor.

Parameters:

pName

Name of pose.

---

Member Function Documentation

int AddNode	(	FBModel	pObject,
		FBMatrix	pMatrix = None,
		bool	pIsLocalMatrix = False
	)

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?

int Find

(

str

pNodeName

)

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.

int GetNodeCount

(

)

Returns the number of pose nodes stored.

FBMatrix GetNodeMatrix

(

int

pIndex

)

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.

str GetNodeName

(

int

pIndex

)

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.

FBModel GetNodeObject

(

int

pIndex

)

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.

bool IsNodeLocalMatrix

(

int

pIndex

)

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.

RemoveNode

(

int

pIndex

)

Remove the pose node at specified index.

Parameters:

pIndex

Index of the node to be removed.

SetIsNodeLocalMatrix	(	int	pIndex,
		bool	pIsNodeLocalMatrix
	)

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.

SetNodeMatrix	(	int	pIndex,
		FBMatrix	pMatrix
	)

Set the pose node matrix.

Parameters:

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

SetNodeObject	(	int	pIndex,
		FBModel	pObject
	)

Set the pose node object.

Parameters:

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

---

Member Data Documentation

FBPoseType Type

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

---