FBCharacterPose Class Reference

Search for all occurrences

---

Detailed Description

Used to work with character poses.

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

Examples

Tasks/MirrorPoseOverTime.py

Inheritance diagram for FBCharacterPose:

List of all members.

Public Member Functions
	__init__ (str pName, object pObject=None)
	Public constructor.
	ClearPose ()
	Clear all the data of the pose.
	ClearCharacterPose ()
	Clear only the pose of the character (omit the extensions).
	ClearCharacterExtensionsPose ()
	Clear only the pose of the character extensions (omit the character).
	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).
	CopyPoseCharacterExtensions (FBCharacter pCharacter)
	Copy the pose of only the character extensions (omit the character).
	CopyPoseCharacterExtension (FBCharacterExtension pCharacterExtension)
	Copy the pose of a single character extension.
	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).
	PastePoseCharacterExtensions (FBCharacter pCharacter, FBCharacterPoseOptions pCharacterPoseOptions)
	Paste the pose of only the character extensions (omit the character).
	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 (str pCharacterExtensionName)
	Is the pose of the character extension stored in the pose?.
	CopyFrom (FBCharacterPose pFromPose)
	Copy everything from a given object.
	CopyPoseDataFrom (FBCharacterPose pFromPose)
	Copy all the pose data from a given pose.
	CopyPoseCharacterFrom (FBCharacterPose pFromPose)
	Copy the pose data of only the character from a given pose.
	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.
FBObjectPose	GetCharacterExtensionPoseAt (int pIndex)
	Get the pose of a character extension.
FBObjectPose	GetCharacterExtensionPose (str pCharacterExtensionName)
	Get the pose of a character extension.
FBObjectPose	GetOrCreateCharacterExtensionPose (str pCharacterExtensionName)
	Get the pose of a character extension and create it if necessary.
	RemoveCharacterExtensionPoseAt (int pIndex)
	Remove the pose of a character extension.
	RemoveCharacterExtensionPose (str pCharacterExtensionName)
	Remove the pose of a character extension.
str	GetCharacterExtensionNameFromPose (FBObjectPose pCharacterExtensionPose)
	Get the name of the character extension for the specified pose.
	GetMirrorPlaneEquation (FBVector4 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.
int	GetExtraBoneCount ()
	Get the number of extra bones contained in the character pose.
FBModel	GetExtraBoneModelAt (int pIndex)
	Get the extra bone model at the specified index.
	GetExtraBoneTransformOffset (FBVector3 pT, FBVector3 pR, FBVector3 pS, int pIndex)
	Get the extra bone transformation offset.
	GetExtraBoneTransform (FBVector3 pT, FBVector3 pR, FBVector3 pS, int pIndex)
	Get the extra bone transformation.
	GetExtraBoneParentRotationOffset (FBVector3 pR, int pIndex)
	Get the extra bone transformation offset.
	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.

---

Member Function Documentation

__init__	(	str	pName,
		object	pObject = None
	)

Search for all occurrences

Public constructor.

This constructor is used to create a new object.

Parameters:

pName	Object name.
pObject	For internal use only.

Examples

Tasks/MirrorPoseOverTime.py

Reimplemented from FBPose.

ClearPose

(

)

Search for all occurrences

Clear all the data of the pose.

ClearCharacterPose

(

)

Search for all occurrences

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

ClearCharacterExtensionsPose

(

)

Search for all occurrences

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

CopyPose

(

FBCharacter

pCharacter

)

Search for all occurrences

Copy the pose of a character and its extensions.

Parameters:

pCharacter

Character to copy the pose from.

CopyPoseCharacter

(

FBCharacter

pCharacter

)

Search for all occurrences

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

Parameters:

pCharacter

Character to copy the pose from.

CopyPoseCharacterExtensions

(

FBCharacter

pCharacter

)

Search for all occurrences

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

Parameters:

pCharacter

Character to copy the pose of the extensions from.

CopyPoseCharacterExtension

(

FBCharacterExtension

pCharacterExtension

)

Search for all occurrences

Copy the pose of a single character extension.

Parameters:

pCharacterExtension

Character extension to copy the pose from.

PastePose	(	FBCharacter	pCharacter,
		FBCharacterPoseOptions	pCharacterPoseOptions
	)

Search for all occurrences

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:

pCharacter	Character to paste the pose to.
pCharacterPoseOptions	Options used to specify how to paste.

PastePoseCharacter	(	FBCharacter	pCharacter,
		FBCharacterPoseOptions	pCharacterPoseOptions
	)

Search for all occurrences

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

Remarks:

Does not support the match and mirror options.

Parameters:

pCharacter	Character to paste the pose to.
pCharacterPoseOptions	Options used to specify how to paste.

PastePoseCharacterExtensions	(	FBCharacter	pCharacter,
		FBCharacterPoseOptions	pCharacterPoseOptions
	)

Search for all occurrences

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

Remarks:

Does not support the match and mirror options.

Parameters:

pCharacter	Character to paste the pose of the extensions to.
pCharacterPoseOptions	Options used to specify how to paste.

PastePoseCharacterExtension	(	FBCharacterExtension	pCharacterExtension,
		FBCharacterPoseOptions	pCharacterPoseOptions
	)

Search for all occurrences

Paste the pose of a single character extension.

Remarks:

Does not support the match and mirror options.

Parameters:

pCharacterExtension	Character extension to paste the pose to.
pCharacterPoseOptions	Options used to specify how to paste.

bool IsCharacterPoseStored

(

)

Search for all occurrences

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

Returns:

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

bool IsCharacterExtensionPoseStored

(

str

pCharacterExtensionName

)

Search for all occurrences

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

Parameters:

pCharacterExtensionName

Name of the character extension.

Returns:

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

CopyFrom

(

FBCharacterPose

pFromPose

)

Search for all occurrences

Copy everything from a given object.

Remarks:

Will copy everything, including the object name, properties, data etc. Objects will be identical.

Parameters:

pFromPose

Pose from which to copy.

CopyPoseDataFrom

(

FBCharacterPose

pFromPose

)

Search for all occurrences

Copy all the pose data from a given pose.

Remarks:

Will copy all the data of the pose.

Parameters:

pFromPose

Pose from which to copy the data.

CopyPoseCharacterFrom

(

FBCharacterPose

pFromPose

)

Search for all occurrences

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

Parameters:

pFromPose

Pose from which to copy the data.

CopyPoseCharacterExtensionsFrom

(

FBCharacterPose

pFromPose

)

Search for all occurrences

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

Parameters:

pFromPose

Pose from which to copy the data.

int GetCharacterExtensionPoseCount

(

)

Search for all occurrences

Get the number of character extension stored in the pose.

Returns:

Number of character extension stored in the pose.

FBObjectPose GetCharacterExtensionPoseAt

(

int

pIndex

)

Search for all occurrences

Get the pose of a character extension.

Parameters:

pIndex

Index of the character extension pose to get.

Returns:

The pose of the character extension.

FBObjectPose GetCharacterExtensionPose

(

str

pCharacterExtensionName

)

Search for all occurrences

Get the pose of a character extension.

Parameters:

pCharacterExtensionName

Name 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

(

str

pCharacterExtensionName

)

Search for all occurrences

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:

pCharacterExtensionName

Name of the character extension pose to get (It is the label name of the character extension).

Returns:

The pose of the character extension.

RemoveCharacterExtensionPoseAt

(

int

pIndex

)

Search for all occurrences

Remove the pose of a character extension.

Parameters:

pIndex

Index of the character extension pose to remove.

RemoveCharacterExtensionPose

(

str

pCharacterExtensionName

)

Search for all occurrences

Remove the pose of a character extension.

Parameters:

pCharacterExtensionName

Name of the character extension pose to remove (It is the label name of the character extension).

str GetCharacterExtensionNameFromPose

(

FBObjectPose

pCharacterExtensionPose

)

Search for all occurrences

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

Parameters:

pCharacterExtensionPose

Pose of a character extension to check its name.

Returns:

The name of the character extension (It is the label name of the character extension).

GetMirrorPlaneEquation	(	FBVector4	pMirrorPlaneEquation,
		FBCharacter	pCharacter,
		FBCharacterPoseOptions	pCharacterPoseOptions
	)

Search for all occurrences

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

Parameters:

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
	)

Search for all occurrences

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

Parameters:

pMirrorPlaneEquation	Out: Mirror plane equation.
pCharacter	Character to receive the pose.
pCharacterPoseOptions	Options used to paste the pose.

int GetExtraBoneCount

(

)

Search for all occurrences

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

)

Search for all occurrences

Get the extra bone model at the specified index.

Parameters:

pIndex

Index of the extra bone to get.

Returns:

The extra bone model if the index was valid, otherwise, null is returned.

GetExtraBoneTransformOffset	(	FBVector3	pT,
		FBVector3	pR,
		FBVector3	pS,
		int	pIndex
	)

Search for all occurrences

Get the extra bone transformation offset.

Parameters:

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.

GetExtraBoneTransform	(	FBVector3	pT,
		FBVector3	pR,
		FBVector3	pS,
		int	pIndex
	)

Search for all occurrences

Get the extra bone transformation.

Parameters:

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.

GetExtraBoneParentRotationOffset	(	FBVector3	pR,
		int	pIndex
	)

Search for all occurrences

Get the extra bone transformation offset.

Parameters:

pR	A vector that will contains the parent rotation offset value on return.
pIndex	Index of the extra bone to get.

ApplyPoseCandidate

(

)

Search for all occurrences

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.