Public Member Functions

FBCharacterPose Class Reference

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


Search for all occurrences

Detailed Description

Used to work with character poses.

This class exposes the object used to store the pose of objects.

Definition at line 179 of file fbcharacterpose.h.

#include <fbcharacterpose.h>

Inheritance diagram for FBCharacterPose:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBCharacterPose (const char *pName, HIObject pObject=NULL)
 Public constructor.
void ClearPose ()
 Clear all the data of the pose.
void ClearCharacterPose ()
 Clear only the pose of the character (omit the extensions).
void ClearCharacterExtensionsPose ()
 Clear only the pose of the character extensions (omit the character).
void CopyPose (FBCharacter &pCharacter)
 Copy the pose of a character and its extensions.
void CopyPoseCharacter (FBCharacter &pCharacter)
 Copy the pose of only the character (omit the extensions).
void CopyPoseCharacterExtensions (FBCharacter &pCharacter)
 Copy the pose of only the character extensions (omit the character).
void CopyPoseCharacterExtension (FBCharacterExtension &pCharacterExtension)
 Copy the pose of a single character extension.
void PastePose (FBCharacter &pCharacter, FBCharacterPoseOptions &pCharacterPoseOptions)
 Paste the pose of a character and its extensions.
void PastePoseCharacter (FBCharacter &pCharacter, FBCharacterPoseOptions &pCharacterPoseOptions)
 Paste the pose of only the character (omit the extensions).
void PastePoseCharacterExtensions (FBCharacter &pCharacter, FBCharacterPoseOptions &pCharacterPoseOptions)
 Paste the pose of only the character extensions (omit the character).
void PastePoseCharacterExtension (FBCharacterExtension &pCharacterExtension, FBCharacterPoseOptions &pCharacterPoseOptions)
 Paste the pose of a single character extension.
bool IsCharacterPoseStored ()
 Is the pose of the character stored in the pose?
bool IsCharacterExtensionPoseStored (const char *pCharacterExtensionName)
 Is the pose of the character extension stored in the pose?
void CopyFrom (FBCharacterPose &pFromPose)
 Copy everything from a given object.
void CopyPoseDataFrom (FBCharacterPose &pFromPose)
 Copy all the pose data from a given pose.
void CopyPoseCharacterFrom (FBCharacterPose &pFromPose)
 Copy the pose data of only the character from a given pose.
void CopyPoseCharacterExtensionsFrom (FBCharacterPose &pFromPose)
 Copy the pose data of only the character extensions from a given pose.
int GetCharacterExtensionPoseCount ()
 Get the number of character extension stored in the pose.
FBObjectPoseGetCharacterExtensionPoseAt (int pIndex)
 Get the pose of a character extension.
FBObjectPoseGetCharacterExtensionPose (const char *pCharacterExtensionName)
 Get the pose of a character extension.
FBObjectPoseGetOrCreateCharacterExtensionPose (const char *pCharacterExtensionName)
 Get the pose of a character extension and create it if necessary.
void RemoveCharacterExtensionPoseAt (int pIndex)
 Remove the pose of a character extension.
void RemoveCharacterExtensionPose (const char *pCharacterExtensionName)
 Remove the pose of a character extension.
FBString GetCharacterExtensionNameFromPose (FBObjectPose &pCharacterExtensionPose)
 Get the name of the character extension for the specified pose.
void GetMirrorPlaneEquation (FBVector4< double > &pMirrorPlaneEquation, FBCharacter &pCharacter, FBCharacterPoseOptions &pCharacterPoseOptions)
 Get the mirror plane equation that would be used to mirror according to the CharacterPoseOptions.
void GetMirrorPlaneEquation (FBMatrix &pMirrorPlaneEquation, FBCharacter &pCharacter, FBCharacterPoseOptions &pCharacterPoseOptions)
 Get the mirror plane equation that would be used to mirror according to the CharacterPoseOptions.
int GetExtraBoneCount ()
 Get the number of extra bones contained in the character pose.
FBModelGetExtraBoneModelAt (int pIndex)
 Get the extra bone model at the specified index.
void GetExtraBoneTransformOffset (FBVector3d &pT, FBVector3d &pR, FBVector3d &pS, int pIndex)
 Get the extra bone transformation offset.
void GetExtraBoneTransform (FBVector3d &pT, FBVector3d &pR, FBVector3d &pS, int pIndex)
 Get the extra bone transformation.
void GetExtraBoneParentRotationOffset (FBRVector &pR, int pIndex)
 Get the extra bone transformation offset.
void ApplyPoseCandidate ()
 After setting the candidate on the skeleton node, calling this function will allow subsequent call to get the TRS value of a skeleton node to return the candidate value.

Constructor & Destructor Documentation

FBCharacterPose ( const char *  pName,
HIObject  pObject = NULL 
)

Public constructor.

This constructor is used to create a new object.

Parameters:
pNameObject name.
pObjectFor internal use only.

Member Function Documentation

void ClearPose ( )

Clear all the data of the pose.

void ClearCharacterPose ( )

Clear only the pose of the character (omit the extensions).

void ClearCharacterExtensionsPose ( )

Clear only the pose of the character extensions (omit the character).

void CopyPose ( FBCharacter pCharacter)

Copy the pose of a character and its extensions.

Parameters:
pCharacterCharacter to copy the pose from.
void CopyPoseCharacter ( FBCharacter pCharacter)

Copy the pose of only the character (omit the extensions).

Parameters:
pCharacterCharacter to copy the pose from.
void CopyPoseCharacterExtensions ( FBCharacter pCharacter)

Copy the pose of only the character extensions (omit the character).

Parameters:
pCharacterCharacter to copy the pose of the extensions from.
void CopyPoseCharacterExtension ( FBCharacterExtension pCharacterExtension)

Copy the pose of a single character extension.

Parameters:
pCharacterExtensionCharacter extension to copy the pose from.
void PastePose ( FBCharacter pCharacter,
FBCharacterPoseOptions pCharacterPoseOptions 
)

Paste the pose of a character and its extensions.

Remarks:
Supports the match and mirror options.
When pasting in body part, the selected parts and extensions of the character will be pasted.
Parameters:
pCharacterCharacter to paste the pose to.
pCharacterPoseOptionsOptions used to specify how to paste.
void PastePoseCharacter ( FBCharacter pCharacter,
FBCharacterPoseOptions pCharacterPoseOptions 
)

Paste the pose of only the character (omit the extensions).

Remarks:
Does not support the match and mirror options.
Parameters:
pCharacterCharacter to paste the pose to.
pCharacterPoseOptionsOptions used to specify how to paste.
void PastePoseCharacterExtensions ( FBCharacter pCharacter,
FBCharacterPoseOptions pCharacterPoseOptions 
)

Paste the pose of only the character extensions (omit the character).

Remarks:
Does not support the match and mirror options.
Parameters:
pCharacterCharacter to paste the pose of the extensions to.
pCharacterPoseOptionsOptions used to specify how to paste.
void PastePoseCharacterExtension ( FBCharacterExtension pCharacterExtension,
FBCharacterPoseOptions pCharacterPoseOptions 
)

Paste the pose of a single character extension.

Remarks:
Does not support the match and mirror options.
Parameters:
pCharacterExtensionCharacter extension to paste the pose to.
pCharacterPoseOptionsOptions used to specify how to paste.
bool IsCharacterPoseStored ( )

Is the pose of the character stored in the pose?

Returns:
true if the pose of the character stored in the pose.
bool IsCharacterExtensionPoseStored ( const char *  pCharacterExtensionName)

Is the pose of the character extension stored in the pose?

Parameters:
pCharacterExtensionNameName of the character extension.
Returns:
true if the pose of the character extension stored in the pose.
void CopyFrom ( FBCharacterPose pFromPose)

Copy everything from a given object.

Remarks:
Will copy everything, including the object name, properties, data etc. Objects will be identical.
Parameters:
pFromPosePose from which to copy.
void CopyPoseDataFrom ( FBCharacterPose pFromPose)

Copy all the pose data from a given pose.

Remarks:
Will copy all the data of the pose.
Parameters:
pFromPosePose from which to copy the data.
void CopyPoseCharacterFrom ( FBCharacterPose pFromPose)

Copy the pose data of only the character from a given pose.

Parameters:
pFromPosePose from which to copy the data.
void CopyPoseCharacterExtensionsFrom ( FBCharacterPose pFromPose)

Copy the pose data of only the character extensions from a given pose.

Parameters:
pFromPosePose from which to copy the data.
int GetCharacterExtensionPoseCount ( )

Get the number of character extension stored in the pose.

Returns:
Number of character extension stored in the pose.
FBObjectPose* GetCharacterExtensionPoseAt ( int  pIndex)

Get the pose of a character extension.

Parameters:
pIndexIndex of the character extension pose to get.
Returns:
The pose of the character extension.
FBObjectPose* GetCharacterExtensionPose ( const char *  pCharacterExtensionName)

Get the pose of a character extension.

Parameters:
pCharacterExtensionNameName of the character extension pose to get (It is the label name of the character extension).
Returns:
The pose of the character extension, NULL if not found.
FBObjectPose* GetOrCreateCharacterExtensionPose ( const char *  pCharacterExtensionName)

Get the pose of a character extension and create it if necessary.

Remarks:
Use this function to manually add a pose of a character extension.
Parameters:
pCharacterExtensionNameName of the character extension pose to get (It is the label name of the character extension).
Returns:
The pose of the character extension.
void RemoveCharacterExtensionPoseAt ( int  pIndex)

Remove the pose of a character extension.

Parameters:
pIndexIndex of the character extension pose to remove.
void RemoveCharacterExtensionPose ( const char *  pCharacterExtensionName)

Remove the pose of a character extension.

Parameters:
pCharacterExtensionNameName of the character extension pose to remove (It is the label name of the character extension).
FBString GetCharacterExtensionNameFromPose ( FBObjectPose pCharacterExtensionPose)

Get the name of the character extension for the specified pose.

Parameters:
pCharacterExtensionPosePose of a character extension to check its name.
Returns:
The name of the character extension (It is the label name of the character extension).
void GetMirrorPlaneEquation ( FBVector4< double > &  pMirrorPlaneEquation,
FBCharacter pCharacter,
FBCharacterPoseOptions pCharacterPoseOptions 
)

Get the mirror plane equation that would be used to mirror according to the CharacterPoseOptions.

Parameters:
pMirrorPlaneEquationOut: Mirror plane equation.
pCharacterCharacter to receive the pose.
pCharacterPoseOptionsOptions used to paste the pose.
void GetMirrorPlaneEquation ( FBMatrix pMirrorPlaneEquation,
FBCharacter pCharacter,
FBCharacterPoseOptions pCharacterPoseOptions 
)

Get the mirror plane equation that would be used to mirror according to the CharacterPoseOptions.

Parameters:
pMirrorPlaneEquationOut: Mirror plane equation.
pCharacterCharacter to receive the pose.
pCharacterPoseOptionsOptions used to paste the pose.
int GetExtraBoneCount ( )

Get the number of extra bones contained in the character pose.

Returns:
The number of extra bones contained in the character pose.
FBModel* GetExtraBoneModelAt ( int  pIndex)

Get the extra bone model at the specified index.

Parameters:
pIndexIndex of the extra bone to get.
Returns:
The extra bone model if the index was valid, otherwise, null is returned.
void GetExtraBoneTransformOffset ( FBVector3d pT,
FBVector3d pR,
FBVector3d pS,
int  pIndex 
)

Get the extra bone transformation offset.

Parameters:
pTA vector that will contains the translation offset value on return.
pRA vector that will contains the rotation offset value on return.
pSA vector that will contains the scale offset value on return.
pIndexIndex of the extra bone to get.
void GetExtraBoneTransform ( FBVector3d pT,
FBVector3d pR,
FBVector3d pS,
int  pIndex 
)

Get the extra bone transformation.

Parameters:
pTA vector that will contains the translation value on return.
pRA vector that will contains the rotation value on return.
pSA vector that will contains the scale value on return.
pIndexIndex of the extra bone to get.
void GetExtraBoneParentRotationOffset ( FBRVector pR,
int  pIndex 
)

Get the extra bone transformation offset.

Parameters:
pRA vector that will contains the parent rotation offset value on return.
pIndexIndex of the extra bone to get.
void ApplyPoseCandidate ( )

After setting the candidate on the skeleton node, calling this function will allow subsequent call to get the TRS value of a skeleton node to return the candidate value.


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

FBCharacterPose FBCharacterPose FBCharacterPose FBCharacterPose FBCharacterPose FBCharacterPose FBCharacterPose FBCharacterPose FBCharacterPose FBCharacterPose
FBCharacterPose FBCharacterPose FBCharacterPose FBCharacterPose FBCharacterPose FBCharacterPose FBCharacterPose FBCharacterPose FBCharacterPose FBCharacterPose