FBPose Class Reference


Detailed Description

Pose class.

Inheritance diagram for FBPose:

List of all members.

Public Member Functions

 __init__ (str pName, object pObject=None)
 Constructor.
 IQuery_Declare (K_IMPLEMENTATION)
int GetNodeCount ()
 Returns the number of pose nodes stored.
int AddNode (FBModel pObject, FBMatrix pMatrix=None, bool pIsLocalMatrix=False)
 Add a new pose node.
 RemoveNode (int pIndex)
 Remove the pose node at specified index.
 SetNodeObject (int pIndex, FBModel pObject)
 Set the pose node object.
FBModel GetNodeObject (int pIndex)
 Get the pose node object.
str GetNodeName (int pIndex)
 Get the pose node at specified index.
 SetNodeMatrix (int pIndex, FBMatrix pMatrix)
 Set the pose node matrix.
FBMatrix GetNodeMatrix (int pIndex)
 Get the pose node matrix.
FBMatrix GetNodeMatrixGlobal (int pIndex)
 Get the global pose node matrix.
 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 (str 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).

Member Function Documentation

__init__ ( str  pName,
object  pObject = None 
)

Constructor.

Parameters:
pNameName of pose.
pObjectFor internal use only (default=NULL).

Reimplemented in FBCharacterPose, and FBObjectPose.

IQuery_Declare ( K_IMPLEMENTATION  )
int GetNodeCount ( )

Returns the number of pose nodes stored.

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

Add a new pose node.

Parameters:
pObjectThe object for which we are creating the pose information.
pMatrixThe transformation of the object we want to save.
pIsLocalMatrixIs the matrix a local matrix?
RemoveNode ( int  pIndex)

Remove the pose node at specified index.

Parameters:
pIndexIndex of the node to be removed.
SetNodeObject ( int  pIndex,
FBModel  pObject 
)

Set the pose node object.

Parameters:
pIndexIndex of the node.
pObjectObject to associate with this pose node.
FBModel GetNodeObject ( int  pIndex)

Get the pose node object.

Parameters:
pIndexIndex of the node.
Returns:
a pointer to the node's Object.
Remarks:
if the index is invalid a null pointer is returned.
str GetNodeName ( int  pIndex)

Get the pose node at specified index.

Parameters:
pIndexIndex 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.
SetNodeMatrix ( int  pIndex,
FBMatrix  pMatrix 
)

Set the pose node matrix.

Parameters:
pIndexIndex of the node.
pMatrixMatrix to set for this pose node.
FBMatrix GetNodeMatrix ( int  pIndex)

Get the pose node matrix.

Parameters:
pIndexIndex 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)

Get the global pose node matrix.

Parameters:
pIndexIndex 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.
SetIsNodeLocalMatrix ( int  pIndex,
bool  pIsNodeLocalMatrix 
)

Set the type of the Matrix for a given node.

Parameters:
pIndexIndex of the node.
pIsNodeLocalMatrixTrue if the matrix of the node is a local matrix.
bool IsNodeLocalMatrix ( int  pIndex)

Get the type of the Matrix for a given node.

Parameters:
pIndexIndex 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 ( str  pNodeName)

Look in this pose if the given node is present.

Parameters:
pNodeNameName 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

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


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