#include <pyfbsdk.h>

Inheritance diagram for FBObjectPose:

[legend]

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.

FBStringList	GetStoredObjectNames ()
	Get all the object names currently stored in this 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, FBModelTransformationType pTransformAttribute, FBPoseTransformType pPoseTransformType)
	Multiply the transform of an objects in the pose.

	MultTransformAllObjects (FBMatrix pGX, FBModelTransformationType 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, FBEvaluateInfo pEvaluateInfo=None)
	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.

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

FBObjectPose class.

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

Constructor & Destructor Documentation

◆ FBObjectPose()

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.

Member Function Documentation

◆ AddStanceOffset()

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

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

ClearPose ( )

Clear all the data of the pose.

◆ CopyFrom()

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

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

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

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

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

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

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

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.

◆ GetStoredObjectNames()

FBStringList GetStoredObjectNames ( )

Get all the object names currently stored in this pose.

Returns: All the object names currently stored in this pose.

◆ GetTransform()

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.

◆ IsPropertyPoseable()

bool IsPropertyPoseable ( FBProperty pProperty )

Is the property poseable?

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

◆ IsPropertyStored()

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.

◆ IsTransformStored()

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

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

MirrorPoseAllObjects ( FBObjectPoseMirrorOptions pObjectPoseMirrorOptions )

Mirror the transform of all objects in the pose.

Parameters

pObjectPoseMirrorOptions MirrorOptions used to specify the mirror plane.

◆ MultTransform()

MultTransform	(	str	pObjectName,
		FBMatrix	pGX,
		FBModelTransformationType	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()

MultTransformAllObjects	(	FBMatrix	pGX,
		FBModelTransformationType	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()

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

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

PasteTransform	(	str	pObjectName,
		FBComponent	pObject,
		FBObjectPoseOptions	pObjectPoseOptions,
		FBEvaluateInfo	pEvaluateInfo = `None`
	)

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.
pEvaluateInfo	Information concerning the evaluation of the animation (time, etc.)

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

◆ RemoveStanceOffset()

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

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

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBObjectPose()

Member Function Documentation

◆ AddStanceOffset()

◆ AddStanceOffsetAllObjects()

◆ ClearPose()

◆ CopyFrom()

◆ CopyObjectPose()

◆ CopyPoseAllObjectsTransformFrom()

◆ CopyPoseDataFrom()

◆ CopyPoseTransformFrom()

◆ CopyPropertyPose()

◆ CopyTransform()

◆ GetPropertyValue()

◆ GetStoredObjectNames()

◆ GetTransform()

◆ IsPropertyPoseable()

◆ IsPropertyStored()

◆ IsTransformStored()

◆ MirrorPose()

◆ MirrorPoseAllObjects()

◆ MultTransform()

◆ MultTransformAllObjects()

◆ PasteObjectPose()

◆ PastePropertyPose()

◆ PasteTransform()

◆ RemoveStanceOffset()

◆ RemoveStanceOffsetAllObjects()

◆ SetPropertyValue()

◆ SetTransform()