Class Description

This class contains the description of a Pose and provide some methods to access Pose info in one FBX scene.

The FbxPose object can be setup to hold "Bind Pose" data or "Rest Pose" data.

The Bind Pose holds the transformation (translation, rotation and scaling) matrix of all the nodes implied in a link deformation. This includes the geometry being deformed, the links deforming the geometry, and recursively all the ancestors nodes of the link. The Bind Pose gives you the transformation of the nodes at the moment of the binding operation when no deformation occurs.

The Rest Pose is a snapshot of a node transformation. A Rest Pose can be used to store the position of every node of a character at a certain point in time. This pose can then be used as a reference position for animation tasks, like editing walk cycles.

One difference between the two modes is in the validation performed before adding an item and the kind of matrix stored.

In "Bind Pose" mode, the matrix is assumed to be defined in the global space, while in "Rest Pose" the type of the matrix may be specified by the caller. So local system matrices can be used. Actually, because there is one such flag for each entry (FbxPoseInfo), it is possible to have mixed types in a FbxPose elements. It is therefore the responsibility of the caller to check for the type of the retrieved matrix and to do the appropriate conversions if required.

The validation of the data to be added consists of the following steps:

If this FbxPose object stores "Bind Poses", then add a FbxPoseInfo only if the node is not already associated to another "Bind Pose". This check is done by visiting ALL the FbxPose objects in the system.

The above test is only performed for the "Bind Pose" type. While the next one is always performed, no matter what kind of poses this FbxPose object is setup to hold.

If a node is already inserted in the FbxPose internal list, then the passed matrix MUST be equal to the one already stored. If this is not the case, the Add method will return -1, indicating that no new FbxPoseInfo has been created.

If the Add method succeeds, it will return the index of the FbxPoseInfo structure that as been created and held by the FbxPose object.

To ensure data integrity, the stored information can only be accessed using the provided methods (read-only). If an entry needs to be modified, the caller has to remove the FbxPoseInfo item by calling Remove(i) and then Add a new one.

The internal list is not ordered and the search inside this list is linear (from the first element to ... the first match or the end of the list).

Examples:: ExportScene01/main.cxx, ImportScene/DisplayPose.cxx, SwitchBinding/main.cxx, ViewScene/DrawScene.cxx, ViewScene/DrawScene.h, ViewScene/GetPosition.cxx, ViewScene/GetPosition.h, and ViewScene/SceneContext.cxx.

Definition at line 96 of file fbxpose.h.

Inheritance diagram for FbxPose:

List of all members.

Public Member Functions
void	SetIsBindPose (bool pIsBindPose)
	Set the type of pose.
bool	IsBindPose () const
	Pose identifier flag.
bool	IsRestPose () const
	Pose identifier flag.
int	GetCount () const
	Get number of stored items.
int	Add (FbxNode *pNode, const FbxMatrix &pMatrix, bool pLocalMatrix=false, bool pMultipleBindPose=true)
	Stores the pose transformation for the given node.
void	Remove (int pIndex)
	Remove the pIndexth item from the Pose object.
FbxNameHandler	GetNodeName (int pIndex) const
	Get the node name.
FbxNode *	GetNode (int pIndex) const
	Get the node.
const FbxMatrix &	GetMatrix (int pIndex) const
	Get the transform matrix.
bool	IsLocalMatrix (int pIndex) const
	Get the type of the matrix.
Search Section
enum	ENameComponent { eInitialNameComponent = 1, eCurrentNameComponent = 2, eAllNameComponents = 3 }
	This structure defines the strategy of comparing FBX node name. More...
int	Find (const FbxNameHandler &pNodeName, char pCompareWhat=eAllNameComponents) const
	Look in the FbxPose object for the given node name.
int	Find (const FbxNode *pNode) const
	Look in the FbxPose object for the given node.
Utility Section
bool	IsValidBindPose (FbxNode pRoot, double pMatrixCmpTolerance=0.0001, FbxStatus pStatus=NULL)
	Check this BindPose and report an error if all the conditions to a valid bind pose are not met.
bool	IsValidBindPoseVerbose (FbxNode pRoot, NodeList &pMissingAncestors, NodeList &pMissingDeformers, NodeList &pMissingDeformersAncestors, NodeList &pWrongMatrices, double pMatrixCmpTolerance=0.0001, FbxStatus pStatus=NULL)
	Same as IsValidBindPose() but slower because it will not stop as soon as a failure occurs.
bool	IsValidBindPoseVerbose (FbxNode pRoot, FbxUserNotification pUserNotification, double pMatrixCmpTolerance=0.0001, FbxStatus *pStatus=NULL)
	Same as IsValidBindPose() but slower because it will not stop as soon as a failure occurs.
static bool	GetPosesContaining (FbxManager &pManager, FbxNode *pNode, PoseList &pPoseList, FbxArray< int > &pIndex)
	Get the list of Poses objects that contain the node with name pNodeName.
static bool	GetPosesContaining (FbxScene pScene, FbxNode pNode, PoseList &pPoseList, FbxArray< int > &pIndex)
	Get the list of Poses objects that contain the node with name pNodeName.
static bool	GetBindPoseContaining (FbxManager &pManager, FbxNode *pNode, PoseList &pPoseList, FbxArray< int > &pIndex)
	Get the list of BindPose objects that contain the node with name pNodeName.
static bool	GetBindPoseContaining (FbxScene pScene, FbxNode pNode, PoseList &pPoseList, FbxArray< int > &pIndex)
	Get the list of BindPose objects that contain the node with name pNodeName.
static bool	GetRestPoseContaining (FbxManager &pManager, FbxNode *pNode, PoseList &pPoseList, FbxArray< int > &pIndex)
	Get the list of RestPose objects that contain the node with name pNodeName.
static bool	GetRestPoseContaining (FbxScene pScene, FbxNode pNode, PoseList &pPoseList, FbxArray< int > &pIndex)
	Get the list of RestPose objects that contain the node with name pNodeName.

eInitialNameComponent	Search for all occurrences
eCurrentNameComponent	use initial name when compare two nodes Search for all occurrences
eAllNameComponents	use current name when compare two nodes Search for all occurrences

int Add	(	FbxNode *	pNode,
		const FbxMatrix &	pMatrix,
		bool	pLocalMatrix = `false`,
		bool	pMultipleBindPose = `true`
	)

pNode	pointer to the node for which the pose is stored.
pMatrix	Pose transform of the node.
pLocalMatrix	Flag to indicate if pMatrix is defined in Local or Global space.
pMultipleBindPose	Flag to indicate if multiple bind pose exist. If this is false, all matrix for one node should be same in different bind pose.

int Find	(	const FbxNameHandler &	pNodeName,
		char	pCompareWhat = `eAllNameComponents`
	)		const

pNodeName	Name of the node we are looking for.
pCompareWhat	Bitwise or of the following flags: INTIALNAME_COMPONENT, eCurrentNameComponent

static bool GetPosesContaining	(	FbxManager &	pManager,
		FbxNode *	pNode,
		PoseList &	pPoseList,
		FbxArray< int > &	pIndex
	)		`[static]`

pManager	The manager owning the poses and scenes.
pNode	The node being explored.
pPoseList	List of BindPoses/RestPoses that have the node.
pIndex	List of indices of the nodes in the corresponding poses lists.

static bool GetPosesContaining	(	FbxScene *	pScene,
		FbxNode *	pNode,
		PoseList &	pPoseList,
		FbxArray< int > &	pIndex
	)		`[static]`

pScene	Scene owning the poses.
pNode	The node being explored.
pPoseList	List of BindPoses/RestPoses that have the node.
pIndex	List of indices of the nodes in the corresponding poses lists.

static bool GetBindPoseContaining	(	FbxManager &	pManager,
		FbxNode *	pNode,
		PoseList &	pPoseList,
		FbxArray< int > &	pIndex
	)		`[static]`

bool IsValidBindPose	(	FbxNode *	pRoot,
		double	pMatrixCmpTolerance = `0.0001`,
		FbxStatus *	pStatus = `NULL`
	)

bool IsValidBindPoseVerbose	(	FbxNode *	pRoot,
		NodeList &	pMissingAncestors,
		NodeList &	pMissingDeformers,
		NodeList &	pMissingDeformersAncestors,
		NodeList &	pWrongMatrices,
		double	pMatrixCmpTolerance = `0.0001`,
		FbxStatus *	pStatus = `NULL`
	)

pManager	The manager owning the poses.
pNode	The node being explored.
pPoseList	List of BindPoses that have the node.
pIndex	List of indices of the nodes in the corresponding bind poses lists.

pScene	The scene owning the poses.
pNode	The node being explored.
pPoseList	List of BindPoses that have the node.
pIndex	List of indices of the nodes in the corresponding bind poses lists.

static bool GetRestPoseContaining	(	FbxManager &	pManager,
		FbxNode *	pNode,
		PoseList &	pPoseList,
		FbxArray< int > &	pIndex
	)		`[static]`

pRoot	This node is used as the stop point when visiting the parents (cannot be NULL).
pMatrixCmpTolerance	Tolerance value when comparing the matrices.
pStatus	The FbxStatus object to hold error codes.

pRoot	This node is used as the stop point when visiting the parents (cannot be NULL).
pMissingAncestors	Each ancestor missing from the BindPose is added to this list.
pMissingDeformers	Each deformer missing from the BindPose is added to this list.
pMissingDeformersAncestors	Each deformer ancestors missing from the BindPose is added to this list.
pWrongMatrices	Nodes that yield to a wrong matrix comparisons are added to this list.
pMatrixCmpTolerance	Tolerance value when comparing the matrices.
pStatus	The FbxStatus object to hold error codes.

pRoot	This node is used as the stop point when visiting the parents (cannot be NULL).
pUserNotification	Pointer to the user notification where the messages will be accumulated.
pMatrixCmpTolerance	Tolerance value when comparing the matrices.
pStatus	The FbxStatus object to hold error codes.

Class Description

Public Member Functions

Search Section

Utility Section

Member Enumeration Documentation

Member Function Documentation