This class exposes the object used to store the pose of objects.
See sample: MirrorPoseOverTime.py.
Public Member Functions |
|
FBCharacterPose (str pName) | |
Public constructor. |
|
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.
|
|
ClearCharacterExtensionsPose () | |
Clear only the pose of the character
extensions (omit the character). |
|
ClearCharacterPose () | |
Clear only the pose of the character (omit
the extensions). |
|
ClearPose () | |
Clear all the data of the pose. |
|
CopyFrom (FBCharacterPose pFromPose) | |
Copy everything from a given object. |
|
CopyPose (FBCharacter pCharacter) | |
Copy the pose of a character and its
extensions. |
|
CopyPoseCharacter (FBCharacter pCharacter) | |
Copy the pose of only the character (omit
the extensions). |
|
CopyPoseCharacterExtension (FBCharacterExtension pCharacterExtension) | |
Copy the pose of a single character
extension. |
|
CopyPoseCharacterExtensions (FBCharacter pCharacter) | |
Copy the pose of only the character
extensions (omit the character). |
|
CopyPoseCharacterExtensionsFrom (FBCharacterPose pFromPose) | |
Copy the pose data of only the character
extensions from a given pose. |
|
CopyPoseCharacterFrom (FBCharacterPose pFromPose) | |
Copy the pose data of only the character
from a given pose. |
|
CopyPoseDataFrom (FBCharacterPose pFromPose) | |
Copy all the pose data from a given pose.
|
|
str | GetCharacterExtensionNameFromPose (FBObjectPose pCharacterExtensionPose) |
Get the name of the character extension for
the specified pose. |
|
FBObjectPose | GetCharacterExtensionPose (str pCharacterExtensionName) |
Get the pose of a character extension.
|
|
FBObjectPose | GetCharacterExtensionPoseAt (int pIndex) |
Get the pose of a character extension.
|
|
int | GetCharacterExtensionPoseCount () |
Get the number of character extension stored
in the pose. |
|
GetExtraBoneParentRotationOffset (FBRVector pR, int pIndex) | |
Get the extra bone transformation offset.
|
|
GetExtraBoneTransform (FBVector3d pT, FBVector3d pR, FBVector3d pS, int pIndex) | |
Get the extra bone transformation. |
|
GetExtraBoneTransformOffset (FBVector3d pT, FBVector3d pR, FBVector3d pS, int pIndex) | |
Get the extra bone transformation offset.
|
|
GetMirrorPlaneEquation (FBVector4< double > pMirrorPlaneEquation, FBCharacter pCharacter, FBCharacterPoseOptions pCharacterPoseOptions) | |
Get the mirror plane equation that would be
used to mirror according to the CharacterPoseOptions. |
|
GetMirrorPlaneEquation (FBMatrix pMirrorPlaneEquation, FBCharacter pCharacter, FBCharacterPoseOptions pCharacterPoseOptions) | |
Get the mirror plane equation that would be
used to mirror according to the CharacterPoseOptions. |
|
FBObjectPose | GetOrCreateCharacterExtensionPose (str pCharacterExtensionName) |
Get the pose of a character extension and
create it if necessary. |
|
bool | IsCharacterExtensionPoseStored (str pCharacterExtensionName) |
Is the pose of the character extension
stored in the pose? |
|
bool | IsCharacterPoseStored () |
Is the pose of the character stored in the
pose? |
|
PastePose (FBCharacter pCharacter, FBCharacterPoseOptions pCharacterPoseOptions) | |
Paste the pose of a character and its
extensions. |
|
PastePoseCharacter (FBCharacter pCharacter, FBCharacterPoseOptions pCharacterPoseOptions) | |
Paste the pose of only the character (omit
the extensions). |
|
PastePoseCharacterExtension (FBCharacterExtension pCharacterExtension, FBCharacterPoseOptions pCharacterPoseOptions) | |
Paste the pose of a single character
extension. |
|
PastePoseCharacterExtensions (FBCharacter pCharacter, FBCharacterPoseOptions pCharacterPoseOptions) | |
Paste the pose of only the character
extensions (omit the character). |
|
RemoveCharacterExtensionPose (str pCharacterExtensionName) | |
Remove the pose of a character extension.
|
|
RemoveCharacterExtensionPoseAt (int pIndex) | |
Remove the pose of a character extension.
|
FBCharacterPose | ( | str | pName | ) |
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.
ClearCharacterExtensionsPose | ( | ) |
Clear only the pose of the character extensions (omit the character).
ClearCharacterPose | ( | ) |
Clear only the pose of the character (omit the extensions).
ClearPose | ( | ) |
Clear all the data of the pose.
CopyFrom | ( | FBCharacterPose | pFromPose | ) |
CopyPose | ( | FBCharacter | pCharacter | ) |
Copy the pose of a character and its extensions.
pCharacter | Character to copy the pose from. |
CopyPoseCharacter | ( | FBCharacter | pCharacter | ) |
Copy the pose of only the character (omit the extensions).
pCharacter | Character to copy the pose from. |
CopyPoseCharacterExtension | ( | FBCharacterExtension | pCharacterExtension | ) |
Copy the pose of a single character extension.
pCharacterExtension | Character extension to copy the pose from. |
CopyPoseCharacterExtensions | ( | FBCharacter | pCharacter | ) |
Copy the pose of only the character extensions (omit the character).
pCharacter | Character to copy the pose of the extensions from. |
CopyPoseCharacterExtensionsFrom | ( | FBCharacterPose | pFromPose | ) |
Copy the pose data of only the character extensions from a given pose.
pFromPose | Pose from which to copy the data. |
CopyPoseCharacterFrom | ( | FBCharacterPose | pFromPose | ) |
Copy the pose data of only the character from a given pose.
pFromPose | Pose from which to copy the data. |
CopyPoseDataFrom | ( | FBCharacterPose | pFromPose | ) |
Copy all the pose data from a given pose.
pFromPose | Pose from which to copy the data. |
str GetCharacterExtensionNameFromPose | ( | FBObjectPose | pCharacterExtensionPose | ) |
Get the name of the character extension for the specified pose.
pCharacterExtensionPose | Pose of a character extension to check its name. |
FBObjectPose GetCharacterExtensionPose | ( | str | pCharacterExtensionName | ) |
Get the pose of a character extension.
pCharacterExtensionName | Name of the character extension pose to get (It is the label name of the character extension). |
FBObjectPose GetCharacterExtensionPoseAt | ( | int | pIndex | ) |
Get the pose of a character extension.
pIndex | Index of the character extension pose to get. |
int GetCharacterExtensionPoseCount | ( | ) |
Get the number of character extension stored in the pose.
GetExtraBoneParentRotationOffset | ( | FBRVector | pR, | |
int | pIndex | |||
) |
Get the extra bone transformation offset.
pR | A vector that will contains the parent rotation offset value on return. | |
pIndex | Index of the extra bone to get. |
GetExtraBoneTransform | ( | FBVector3d | pT, | |
FBVector3d | pR, | |||
FBVector3d | pS, | |||
int | pIndex | |||
) |
Get the extra bone transformation.
pT | A vector that will contains the translation value on return. | |
pR | A vector that will contains the rotation value on return. | |
pS | A vector that will contains the scale value on return. | |
pIndex | Index of the extra bone to get. |
GetExtraBoneTransformOffset | ( | FBVector3d | pT, | |
FBVector3d | pR, | |||
FBVector3d | pS, | |||
int | pIndex | |||
) |
Get the extra bone transformation offset.
pT | A vector that will contains the translation offset value on return. | |
pR | A vector that will contains the rotation offset value on return. | |
pS | A vector that will contains the scale offset value on return. | |
pIndex | Index of the extra bone to get. |
GetMirrorPlaneEquation | ( | FBVector4< double > | pMirrorPlaneEquation, | |
FBCharacter | pCharacter, | |||
FBCharacterPoseOptions | pCharacterPoseOptions | |||
) |
Get the mirror plane equation that would be used to mirror according to the CharacterPoseOptions.
pMirrorPlaneEquation | Out: Mirror plane equation. | |
pCharacter | Character to receive the pose. | |
pCharacterPoseOptions | Options used to paste the pose. |
GetMirrorPlaneEquation | ( | FBMatrix | pMirrorPlaneEquation, | |
FBCharacter | pCharacter, | |||
FBCharacterPoseOptions | pCharacterPoseOptions | |||
) |
Get the mirror plane equation that would be used to mirror according to the CharacterPoseOptions.
pMirrorPlaneEquation | Out: Mirror plane equation. | |
pCharacter | Character to receive the pose. | |
pCharacterPoseOptions | Options used to paste the pose. |
FBObjectPose GetOrCreateCharacterExtensionPose | ( | str | pCharacterExtensionName | ) |
Get the pose of a character extension and create it if necessary.
pCharacterExtensionName | Name of the character extension pose to get (It is the label name of the character extension). |
Is the pose of the character extension stored in the pose?
pCharacterExtensionName | Name of the character extension. |
bool IsCharacterPoseStored | ( | ) |
Is the pose of the character stored in the pose?
PastePose | ( | FBCharacter | pCharacter, | |
FBCharacterPoseOptions | pCharacterPoseOptions | |||
) |
Paste the pose of a character and its extensions.
pCharacter | Character to paste the pose to. | |
pCharacterPoseOptions | Options used to specify how to paste. |
PastePoseCharacter | ( | FBCharacter | pCharacter, | |
FBCharacterPoseOptions | pCharacterPoseOptions | |||
) |
Paste the pose of only the character (omit the extensions).
pCharacter | Character to paste the pose to. | |
pCharacterPoseOptions | Options used to specify how to paste. |
PastePoseCharacterExtension | ( | FBCharacterExtension | pCharacterExtension, | |
FBCharacterPoseOptions | pCharacterPoseOptions | |||
) |
Paste the pose of a single character extension.
pCharacterExtension | Character extension to paste the pose to. | |
pCharacterPoseOptions | Options used to specify how to paste. |
PastePoseCharacterExtensions | ( | FBCharacter | pCharacter, | |
FBCharacterPoseOptions | pCharacterPoseOptions | |||
) |
Paste the pose of only the character extensions (omit the character).
pCharacter | Character to paste the pose of the extensions to. | |
pCharacterPoseOptions | Options used to specify how to paste. |
RemoveCharacterExtensionPose | ( | str | pCharacterExtensionName | ) |
Remove the pose of a character extension.
pCharacterExtensionName | Name of the character extension pose to remove (It is the label name of the character extension). |
RemoveCharacterExtensionPoseAt | ( | int | pIndex | ) |
Remove the pose of a character extension.
pIndex | Index of the character extension pose to remove. |