Public Member Functions | Public Attributes

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:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBPose (const char *pName, HIObject pObject=NULL)
 Constructor.
 IQuery_Declare (K_IMPLEMENTATION)
int GetNodeCount ()
 Returns the number of pose nodes stored.
int AddNode (FBModel *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, FBModel *pObject)
 Set the pose node object.
FBModelGetNodeObject (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 ( const char *  pName,
HIObject  pObject = NULL 
)

Constructor.

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

Member Function Documentation

IQuery_Declare ( K_IMPLEMENTATION  )
int GetNodeCount ( )

Returns the number of pose nodes stored.

int AddNode ( FBModel pObject,
FBMatrix pMatrix = NULL,
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?
void RemoveNode ( int  pIndex)

Remove the pose node at specified index.

Parameters:
pIndexIndex of the node to be removed.
void 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.
FBString GetNodeName ( int  pIndex) const

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.
void 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) const

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) const

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.
void 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 ( FBString  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)

Definition at line 165 of file fbpose.h.


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

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