Python Reference Guide
 
Loading...
Searching...
No Matches
FBCharacterPose Class Reference

Used to work with character poses. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBCharacterPose:

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.
 
- Public Member Functions inherited from FBPose
 FBPose (str pName)
 Constructor.
 
int AddNode (FBModel pObject, FBMatrix pMatrix=None, bool pIsLocalMatrix=False)
 Add a new pose node.
 
 CreatePoseThumbnail ()
 Create an image thumbnail for the current pose.
 
int Find (str pNodeName)
 Look in this pose if the given node is present.
 
int GetNodeCount ()
 Returns the number of pose nodes stored.
 
FBMatrix GetNodeMatrix (int pIndex)
 Get the pose node matrix.
 
str GetNodeName (int pIndex)
 Get the pose node at specified index.
 
FBModel GetNodeObject (int pIndex)
 Get the pose node object.
 
bool IsNodeLocalMatrix (int pIndex)
 Get the type of the Matrix for a given node.
 
 RemoveNode (int pIndex)
 Remove the pose node at specified index.
 
 SetIsNodeLocalMatrix (int pIndex, bool pIsNodeLocalMatrix)
 Set the type of the Matrix for a given node.
 
 SetNodeMatrix (int pIndex, FBMatrix pMatrix)
 Set the pose node matrix.
 
 SetNodeObject (int pIndex, FBModel pObject)
 Set the pose node object.
 
- Public Member Functions inherited from FBComponent
 FBComponent ()
 Constructor.
 
str ClassName ()
 Get the class name.
 
 DisableObjectFlags (FBObjectFlag pFlags)
 Disable a specific Object Flags.
 
 EnableObjectFlags (FBObjectFlag pFlags)
 Enable a specific Object Flags.
 
bool FBCreate ()
 Open Reality Creation function.
 
 FBDelete ()
 Open Reality deletion function.
 
 FBDestroy ()
 Open Reality destruction function.
 
FBObjectFlag GetObjectFlags ()
 Get all Object Flags (concatenated).
 
bool GetObjectStatus (FBObjectStatus pStatus)
 Check to see if an object status is enabled.
 
FBFileReference GetOwnerFileReference (p0)
 Get the owner FileReference object.
 
 HardSelect ()
 HardSelect.
 
bool HasObjectFlags (FBObjectFlag pFlags)
 Check whether a specific object flag is enabled.
 
bool Is (int pTypeId)
 Returns true if object is of type TypeId.
 
bool ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessNamespaceHierarchy.
 
bool ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessObjectNamespace.
 
int PropertyAdd (FBProperty pProperty)
 Add a property to the component's property manager.
 
bool PropertyAddReferenceProperty (FBProperty pReferenceProperty)
 Add a reference property to the component's property manager.
 
FBProperty PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
 Create user or dynamic property.
 
 PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
 Get list of properties which have been modified since last loading.
 
 PropertyRemove (FBProperty pProperty)
 Remove a Property from the component's Property manager.
 
 SetObjectFlags (FBObjectFlag pFlags)
 SetObjectFlags.
 
 SetObjectStatus (FBObjectStatus pStatus, bool pValue)
 Enable/Disable a specific Object Status.
 

Additional Inherited Members

- Public Attributes inherited from FBPose
FBPoseType Type
 Read Only Property: Type of the pose (bind pose or rest pose)

 
- Public Attributes inherited from FBComponent
FBListComponent Components
 List: List of components.

 
str LongName
 Read Write Property: Name and namespace for object.

 
str Name
 Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
 
FBListComponent Parents
 List: Parents.

 
FBManager PropertyList
 Read Only Property: Manages all of the properties for the component.

 
bool Selected
 Read Write Property: Selected property.

 
int TypeInfo
 Contains the Type information of the object.

 
- Public Attributes inherited from FBPlug
str ClassGroupName
 ClassGroupName of the object.

 
int TypeInfo
 TypeInfo.

 

Detailed Description

Used to work with character poses.


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

See sample: MirrorPoseOverTime.py.

Constructor & Destructor Documentation

◆ FBCharacterPose()

FBCharacterPose ( str  pName)

Public constructor.

This constructor is used to create a new object.

Parameters
pNameObject name.

Member Function Documentation

◆ ApplyPoseCandidate()

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

ClearCharacterExtensionsPose ( )

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

◆ ClearCharacterPose()

ClearCharacterPose ( )

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

◆ ClearPose()

ClearPose ( )

Clear all the data of the pose.

◆ CopyFrom()

CopyFrom ( FBCharacterPose  pFromPose)

Copy everything from a given object.

Parameters
pFromPosePose from which to copy.
Remarks
Will copy everything, including the object name, properties, data etc. Objects will be identical.

◆ CopyPose()

CopyPose ( FBCharacter  pCharacter)

Copy the pose of a character and its extensions.

Parameters
pCharacterCharacter to copy the pose from.

◆ CopyPoseCharacter()

CopyPoseCharacter ( FBCharacter  pCharacter)

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

Parameters
pCharacterCharacter to copy the pose from.

◆ CopyPoseCharacterExtension()

CopyPoseCharacterExtension ( FBCharacterExtension  pCharacterExtension)

Copy the pose of a single character extension.

Parameters
pCharacterExtensionCharacter extension to copy the pose from.

◆ CopyPoseCharacterExtensions()

CopyPoseCharacterExtensions ( FBCharacter  pCharacter)

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

Parameters
pCharacterCharacter to copy the pose of the extensions from.

◆ CopyPoseCharacterExtensionsFrom()

CopyPoseCharacterExtensionsFrom ( FBCharacterPose  pFromPose)

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

Parameters
pFromPosePose from which to copy the data.

◆ CopyPoseCharacterFrom()

CopyPoseCharacterFrom ( FBCharacterPose  pFromPose)

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

Parameters
pFromPosePose from which to copy the data.

◆ CopyPoseDataFrom()

CopyPoseDataFrom ( FBCharacterPose  pFromPose)

Copy all the pose data from a given pose.

Parameters
pFromPosePose from which to copy the data.
Remarks
Will copy all the data of the pose.

◆ GetCharacterExtensionNameFromPose()

str 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).

◆ GetCharacterExtensionPose()

FBObjectPose GetCharacterExtensionPose ( str  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.

◆ GetCharacterExtensionPoseAt()

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.

◆ GetCharacterExtensionPoseCount()

int GetCharacterExtensionPoseCount ( )

Get the number of character extension stored in the pose.

Returns
Number of character extension stored in the pose.

◆ GetExtraBoneParentRotationOffset()

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.

◆ GetExtraBoneTransform()

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.

◆ GetExtraBoneTransformOffset()

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.

◆ GetMirrorPlaneEquation() [1/2]

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.

◆ GetMirrorPlaneEquation() [2/2]

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.

◆ GetOrCreateCharacterExtensionPose()

FBObjectPose GetOrCreateCharacterExtensionPose ( str  pCharacterExtensionName)

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

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.
Remarks
Use this function to manually add a pose of a character extension.

◆ IsCharacterExtensionPoseStored()

bool IsCharacterExtensionPoseStored ( str  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.

◆ IsCharacterPoseStored()

bool IsCharacterPoseStored ( )

Is the pose of the character stored in the pose?

Returns
true if the pose of the character stored in the pose.

◆ PastePose()

PastePose ( FBCharacter  pCharacter,
FBCharacterPoseOptions  pCharacterPoseOptions 
)

Paste the pose of a character and its extensions.

Parameters
pCharacterCharacter to paste the pose to.
pCharacterPoseOptionsOptions used to specify how to paste.
Remarks
Supports the match and mirror options.
When pasting in body part, the selected parts and extensions of the character will be pasted.

◆ PastePoseCharacter()

PastePoseCharacter ( FBCharacter  pCharacter,
FBCharacterPoseOptions  pCharacterPoseOptions 
)

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

Parameters
pCharacterCharacter to paste the pose to.
pCharacterPoseOptionsOptions used to specify how to paste.
Remarks
Does not support the match and mirror options.

◆ PastePoseCharacterExtension()

PastePoseCharacterExtension ( FBCharacterExtension  pCharacterExtension,
FBCharacterPoseOptions  pCharacterPoseOptions 
)

Paste the pose of a single character extension.

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

◆ PastePoseCharacterExtensions()

PastePoseCharacterExtensions ( FBCharacter  pCharacter,
FBCharacterPoseOptions  pCharacterPoseOptions 
)

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

Parameters
pCharacterCharacter to paste the pose of the extensions to.
pCharacterPoseOptionsOptions used to specify how to paste.
Remarks
Does not support the match and mirror options.

◆ RemoveCharacterExtensionPose()

RemoveCharacterExtensionPose ( str  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).

◆ RemoveCharacterExtensionPoseAt()

RemoveCharacterExtensionPoseAt ( int  pIndex)

Remove the pose of a character extension.

Parameters
pIndexIndex of the character extension pose to remove.