FBObjectPose Class Reference

FBObjectPose ( str pName )

Public constructor.

This constructor is used to create a new object.

Parameters:

pName

Object name. If pObject is not NULL, pName will be ignored.

AddStanceOffset	(	str	pObjectName,
		FBObjectPose	pStancePose,
		FBPoseTransformType	pPoseTransformType = `kFBPoseTransformInvalid`
	)

Add the StanceOffset to an object in the pose.

Parameters:

	pObjectName	Name of the object.
	pStancePose	Pose representing the stance of all objects.
	pPoseTransformType	Transform type in which to add the offset (Local, Global or LocalRef).

Remarks:: Working with poses with their StanceOffset removed is usefull for retargetting. If pPoseTransformType is set to kFBPoseTransformInvalid, offsets will be added in all TransformTypes.

AddStanceOffsetAllObjects	(	FBObjectPose	pStancePose,
		FBPoseTransformType	pPoseTransformType = `kFBPoseTransformInvalid`
	)

Add the StanceOffset to all the objects in the pose.

Parameters:

	pStancePose	Pose representing the stance of all objects.
	pPoseTransformType	Transform type in which to add the offset (Local, Global or LocalRef).

Remarks:: Working with poses with their StanceOffset removed is usefull for retargetting. If pPoseTransformType is set to kFBPoseTransformInvalid, offsets will be added in all TransformTypes.

ClearPose ( )

Clear all the data of the pose.

CopyFrom ( FBObjectPose pFromPose )

Copy everything from a given object.

Parameters:

pFromPose

Pose from which to copy.

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

CopyObjectPose	(	str	pObjectName,
		FBComponent	pObject
	)

Copy the pose of all the properties of an object.

Parameters:

	pObjectName	Name of the object to store in the pose.
	pObject	Object from which we'll read all the property values to store in the pose.

Remarks:: You can specify a pObjectName different from the name of pObject.

CopyPoseAllObjectsTransformFrom	(	FBObjectPose	pFromPose,
		FBPoseTransformType	pPoseTransformType = `kFBPoseTransformInvalid`
	)

Copy all the transforms from a given pose.

Parameters:

	pFromPose	Pose from which to copy the data.
	pPoseTransformType	Transform type from which to copy the transform (Local, Global or LocalRef).

Remarks:: If pPoseTransformType is set to kFBPoseTransformInvalid, copy all TransformTypes.

CopyPoseDataFrom ( FBObjectPose pFromPose )

Copy all the pose data from a given pose.

Parameters:

pFromPose

Pose from which to copy the data.

Remarks:: Will copy all the data of the pose including the transforms.

CopyPoseTransformFrom	(	FBObjectPose	pFromPose,
		str	pObjectName,
		FBPoseTransformType	pPoseTransformType = `kFBPoseTransformInvalid`
	)

Copy the transforms of an object from a given pose.

Parameters:

	pFromPose	Pose from which to copy the data.
	pObjectName	Name of object to copy the transform from.
	pPoseTransformType	Transform type from which to copy the transform (Local, Global or LocalRef).

Remarks:: If pPoseTransformType is set to kFBPoseTransformInvalid, copy all TransformTypes.

CopyPropertyPose	(	str	pObjectName,
		FBProperty	pProperty
	)

Copy the pose of a property of an object.

Parameters:

	pObjectName	Name of the object to store in the pose.
	pProperty	Property from which we'll read the value to store in the pose.

Remarks:: You can specify a pObjectName different from the name of pObject.

CopyTransform	(	str	pObjectName,
		FBComponent	pObject,
		FBObjectPoseOptions	pObjectPoseOptions
	)

Copy the transform of an object.

Parameters:

	pObjectName	Name of the object to store in the pose.
	pObject	Object from which we'll evaluate the transform values to store in the pose.
	pObjectPoseOptions	PoseOptions used to specify the transform of the reference object (Default: Identity).

Remarks:: This function will always copy all the TransformAttributes (T,R,S) in all TransformType (Local, Global, LocalRef).

GetPropertyValue	(	float	pValue,
		int	pSize,
		str	pObjectName,
		str	pPropertyName
	)

Get the value of a property stored in the pose.

Parameters:

	pValue	Value to get.
	pSize	Number of elements in pValue.
	pObjectName	Name of the object to get the value.
	pPropertyName	Name of the property to get the value.

bool GetTransform	(	FBTVector	pT,
		FBMatrix	pRM,
		FBMatrix	pSM,
		str	pObjectName,
		FBPoseTransformType	pPoseTransformType
	)

Get the transform of an object in the pose.

Parameters:

	pT	Translation to get.
	pRM	Rotation to get.
	pSM	Scaling to get.
	pObjectName	Name of the object to get the transform.
	pPoseTransformType	Transform type in which to set the transform (Local, Global or LocalRef).

Returns:: True if the transform was found in the pose.

bool IsPropertyPoseable ( FBProperty pProperty )

Is the property poseable?

Returns:: True if the value of this property can be stored in the pose.

bool IsPropertyStored	(	str	pObjectName,
		str	pPropertyName
	)

Is the property stored in the pose?

Parameters:

	pObjectName	Name of the object.
	pPropertyName	Name of the property.

Returns:: True if the property is stored in the pose.

bool IsTransformStored	(	str	pObjectName,
		FBPoseTransformType	pPoseTransformType = `kFBPoseTransformInvalid`
	)

Is the transform of this object stored in the specified TransformType?

Parameters:

	pObjectName	Name of the object.
	pPoseTransformType	Transform type in which to check.

Returns:: True if the transform of this object is stored in the specified TransformType (Local, Global and LocalRef).

Remarks:: If pPoseTransformType is set to kFBPoseTransformInvalid, will check in all TransformTypes.

MirrorPose	(	str	pObjectName,
		FBObjectPoseMirrorOptions	pObjectPoseMirrorOptions
	)

Mirror the transform of an object in the pose.

Parameters:

	pObjectName	Name of the object to mirror.
	pObjectPoseMirrorOptions	MirrorOptions used to specify the mirror plane.

MirrorPoseAllObjects ( FBObjectPoseMirrorOptions pObjectPoseMirrorOptions )

Mirror the transform of all objects in the pose.

Parameters:

pObjectPoseMirrorOptions

MirrorOptions used to specify the mirror plane.

MultTransform	(	str	pObjectName,
		FBMatrix	pGX,
		FBModelTransformationMatrix	pTransformAttribute,
		FBPoseTransformType	pPoseTransformType
	)

Multiply the transform of an objects in the pose.

Parameters:

	pObjectName	Name of the object.
	pGX	Transformation matrix to apply.
	pTransformAttribute	Transform attribute to affect. Supported: T,R,S and Transformation.
	pPoseTransformType	Transform type in which to mult the transform (Local, Global or LocalRef).

MultTransformAllObjects	(	FBMatrix	pGX,
		FBModelTransformationMatrix	pTransformAttribute,
		FBPoseTransformType	pPoseTransformType
	)

Multiply the transform of all objects in the pose.

Parameters:

	pGX	Transformation matrix to apply.
	pTransformAttribute	Transform attribute to affect. Supported: T,R,S and Transformation.
	pPoseTransformType	Transform type in which to mult the transform (Local, Global or LocalRef).

PasteObjectPose	(	str	pObjectName,
		FBComponent	pObject
	)

Paste the pose of all the properties of an object.

Parameters:

	pObjectName	Name of the object stored in the pose.
	pObject	Object which will receive the values stored in the pose.

Remarks:: You can specify a pObjectName different from the name of pObject. Properties that were not stored in the pose will not be affected.

PastePropertyPose	(	str	pObjectName,
		FBProperty	pProperty
	)

Paste the pose of a property of an object.

Parameters:

	pObjectName	Name of the object stored in the pose.
	pProperty	Property which will receive the value stored in the pose.

Remarks:: You can specify a pObjectName different from the name of pObject. The property will not be affected if it was not stored in the pose.

PasteTransform	(	str	pObjectName,
		FBComponent	pObject,
		FBObjectPoseOptions	pObjectPoseOptions
	)

Paste the transform of an object.

Parameters:

	pObjectName	Name of the object stored in the pose.
	pObject	Object which will receive the transform values stored in the pose.
	pObjectPoseOptions	PoseOptions used to specify the transform of the reference object, the TransformType and TransformAttributes to paste.

Remarks:: Use the pObjectPoseOptions to specify which TransformType to use when pasting.

RemoveStanceOffset	(	str	pObjectName,
		FBObjectPose	pStancePose,
		FBPoseTransformType	pPoseTransformType = `kFBPoseTransformInvalid`
	)

Remove the StanceOffset from an object in the pose.

Parameters:

	pObjectName	Name of the object.
	pStancePose	Pose representing the stance of all objects.
	pPoseTransformType	Transform type in which to remove the offset (Local, Global or LocalRef).

Remarks:: Working with poses with their StanceOffset removed is usefull for retargetting. If pPoseTransformType is set to kFBPoseTransformInvalid, offsets will be removed in all TransformTypes.

RemoveStanceOffsetAllObjects	(	FBObjectPose	pStancePose,
		FBPoseTransformType	pPoseTransformType = `kFBPoseTransformInvalid`
	)

Remove the StanceOffset from all the objects in the pose.

Parameters:

	pStancePose	Pose representing the stance of all objects.
	pPoseTransformType	Transform type in which to remove the offset (Local, Global or LocalRef).

Remarks:: Working with poses with their StanceOffset removed is usefull for retargetting. If pPoseTransformType is set to kFBPoseTransformInvalid, offsets will be removed in all TransformTypes.

SetPropertyValue	(	str	pObjectName,
		str	pPropertyName,
		float	pValue,
		int	pSize
	)

Set the value of a property in the pose.

Parameters:

	pObjectName	Name of the object to set the value.
	pPropertyName	Name of the property to set the value.
	pValue	Value to set.
	pSize	Number of elements in pValue.

SetTransform	(	FBTVector	pT,
		FBMatrix	pRM,
		FBMatrix	pSM,
		str	pObjectName,
		FBPoseTransformType	pPoseTransformType
	)

Set the transform of an object in the pose.

Parameters:

	pT	Translation to set.
	pRM	Rotation to set.
	pSM	Scaling to set.
	pObjectName	Name of the object to set the transform.
	pPoseTransformType	Transform type in which to set the transform (Local, Global or LocalRef).

FBObjectPose Class Reference

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation


Public Member Functions
	FBObjectPose (str pName)
	Public constructor.
	AddStanceOffset (str pObjectName, FBObjectPose pStancePose, FBPoseTransformType pPoseTransformType=kFBPoseTransformInvalid)
	Add the StanceOffset to an object in the pose.
	AddStanceOffsetAllObjects (FBObjectPose pStancePose, FBPoseTransformType pPoseTransformType=kFBPoseTransformInvalid)
	Add the StanceOffset to all the objects in the pose.
	ClearPose ()
	Clear all the data of the pose.
	CopyFrom (FBObjectPose pFromPose)
	Copy everything from a given object.
	CopyObjectPose (str pObjectName, FBComponent pObject)
	Copy the pose of all the properties of an object.
	CopyPoseAllObjectsTransformFrom (FBObjectPose pFromPose, FBPoseTransformType pPoseTransformType=kFBPoseTransformInvalid)
	Copy all the transforms from a given pose.
	CopyPoseDataFrom (FBObjectPose pFromPose)
	Copy all the pose data from a given pose.
	CopyPoseTransformFrom (FBObjectPose pFromPose, str pObjectName, FBPoseTransformType pPoseTransformType=kFBPoseTransformInvalid)
	Copy the transforms of an object from a given pose.
	CopyPropertyPose (str pObjectName, FBProperty pProperty)
	Copy the pose of a property of an object.
	CopyTransform (str pObjectName, FBComponent pObject, FBObjectPoseOptions pObjectPoseOptions)
	Copy the transform of an object.
	GetPropertyValue (float pValue, int pSize, str pObjectName, str pPropertyName)
	Get the value of a property stored in the pose.
bool	GetTransform (FBTVector pT, FBMatrix pRM, FBMatrix pSM, str pObjectName, FBPoseTransformType pPoseTransformType)
	Get the transform of an object in the pose.
bool	IsPropertyPoseable (FBProperty pProperty)
	Is the property poseable?
bool	IsPropertyStored (str pObjectName, str pPropertyName)
	Is the property stored in the pose?
bool	IsTransformStored (str pObjectName, FBPoseTransformType pPoseTransformType=kFBPoseTransformInvalid)
	Is the transform of this object stored in the specified TransformType?
	MirrorPose (str pObjectName, FBObjectPoseMirrorOptions pObjectPoseMirrorOptions)
	Mirror the transform of an object in the pose.
	MirrorPoseAllObjects (FBObjectPoseMirrorOptions pObjectPoseMirrorOptions)
	Mirror the transform of all objects in the pose.
	MultTransform (str pObjectName, FBMatrix pGX, FBModelTransformationMatrix pTransformAttribute, FBPoseTransformType pPoseTransformType)
	Multiply the transform of an objects in the pose.
	MultTransformAllObjects (FBMatrix pGX, FBModelTransformationMatrix pTransformAttribute, FBPoseTransformType pPoseTransformType)
	Multiply the transform of all objects in the pose.
	PasteObjectPose (str pObjectName, FBComponent pObject)
	Paste the pose of all the properties of an object.
	PastePropertyPose (str pObjectName, FBProperty pProperty)
	Paste the pose of a property of an object.
	PasteTransform (str pObjectName, FBComponent pObject, FBObjectPoseOptions pObjectPoseOptions)
	Paste the transform of an object.
	RemoveStanceOffset (str pObjectName, FBObjectPose pStancePose, FBPoseTransformType pPoseTransformType=kFBPoseTransformInvalid)
	Remove the StanceOffset from an object in the pose.
	RemoveStanceOffsetAllObjects (FBObjectPose pStancePose, FBPoseTransformType pPoseTransformType=kFBPoseTransformInvalid)
	Remove the StanceOffset from all the objects in the pose.
	SetPropertyValue (str pObjectName, str pPropertyName, float pValue, int pSize)
	Set the value of a property in the pose.
	SetTransform (FBTVector pT, FBMatrix pRM, FBMatrix pSM, str pObjectName, FBPoseTransformType pPoseTransformType)
	Set the transform of an object in the pose.