#include <fbobjectpose.h>

Inheritance diagram for FBObjectPose:

[legend]

Public Member Functions
	FBObjectPose (const char *pName, HIObject pObject=NULL)
	Public constructor.

void	ClearPose ()
	Clear all the data of the pose.

bool	IsPropertyPoseable (FBProperty &pProperty)
	Is the property poseable?

FBStringList	GetStoredObjectNames ()
	Get all the object names currently stored in this pose.

void	CopyObjectPose (const char *pObjectName, FBComponent &pObject)
	Copy the pose of all the properties of an object.

void	CopyPropertyPose (const char *pObjectName, FBProperty &pProperty)
	Copy the pose of a property of an object.

void	PasteObjectPose (const char *pObjectName, FBComponent &pObject)
	Paste the pose of all the properties of an object.

void	PastePropertyPose (const char *pObjectName, FBProperty &pProperty)
	Paste the pose of a property of an object.

void	SetPropertyValue (const char pObjectName, const char pPropertyName, double *pValue, int pSize)
	Set the value of a property in the pose.

void	GetPropertyValue (double pValue, int pSize, const char pObjectName, const char *pPropertyName)
	Get the value of a property stored in the pose.

bool	IsPropertyStored (const char pObjectName, const char pPropertyName)
	Is the property stored in the pose?

void	CopyTransform (const char *pObjectName, FBComponent &pObject, FBObjectPoseOptions &pObjectPoseOptions)
	Copy the transform of an object.

void	PasteTransform (const char pObjectName, FBComponent &pObject, FBObjectPoseOptions &pObjectPoseOptions, FBEvaluateInfo pEvaluateInfo=NULL)
	Paste the transform of an object.

void	SetTransform (FBTVector &pT, FBMatrix &pRM, FBMatrix &pSM, const char *pObjectName, FBPoseTransformType pPoseTransformType)
	Set the transform of an object in the pose.

bool	GetTransform (FBTVector &pT, FBMatrix &pRM, FBMatrix &pSM, const char *pObjectName, FBPoseTransformType pPoseTransformType)
	Get the transform of an object in the pose.

bool	IsTransformStored (const char *pObjectName, FBPoseTransformType pPoseTransformType=kFBPoseTransformInvalid)
	Is the transform of this object stored in the specified TransformType?

void	MultTransformAllObjects (FBMatrix &pGX, FBModelTransformationType pTransformAttribute, FBPoseTransformType pPoseTransformType)
	Multiply the transform of all objects in the pose.

void	MultTransform (const char *pObjectName, FBMatrix &pGX, FBModelTransformationType pTransformAttribute, FBPoseTransformType pPoseTransformType)
	Multiply the transform of an objects in the pose.

void	MirrorPoseAllObjects (FBObjectPoseMirrorOptions &pObjectPoseMirrorOptions)
	Mirror the transform of all objects in the pose.

void	MirrorPose (const char *pObjectName, FBObjectPoseMirrorOptions &pObjectPoseMirrorOptions)
	Mirror the transform of an object in the pose.

void	RemoveStanceOffsetAllObjects (FBObjectPose &pStancePose, FBPoseTransformType pPoseTransformType=kFBPoseTransformInvalid)
	Remove the StanceOffset from all the objects in the pose.

void	RemoveStanceOffset (const char *pObjectName, FBObjectPose &pStancePose, FBPoseTransformType pPoseTransformType=kFBPoseTransformInvalid)
	Remove the StanceOffset from an object in the pose.

void	AddStanceOffsetAllObjects (FBObjectPose &pStancePose, FBPoseTransformType pPoseTransformType=kFBPoseTransformInvalid)
	Add the StanceOffset to all the objects in the pose.

void	AddStanceOffset (const char *pObjectName, FBObjectPose &pStancePose, FBPoseTransformType pPoseTransformType=kFBPoseTransformInvalid)
	Add the StanceOffset to an object in the pose.

void	CopyFrom (FBObjectPose &pFromPose)
	Copy everything from a given object.

void	CopyPoseDataFrom (FBObjectPose &pFromPose)
	Copy all the pose data from a given pose.

void	CopyPoseAllObjectsTransformFrom (FBObjectPose &pFromPose, FBPoseTransformType pPoseTransformType=kFBPoseTransformInvalid)
	Copy all the transforms from a given pose.

void	CopyPoseTransformFrom (FBObjectPose &pFromPose, const char *pObjectName, FBPoseTransformType pPoseTransformType=kFBPoseTransformInvalid)
	Copy the transforms of an object from a given pose.

Public Member Functions inherited from FBPose
	FBPose (const char *pName, HIObject pObject=NULL)
	Constructor.

	IQuery_Declare (override)

int	GetNodeCount ()
	Returns the number of pose nodes stored.

int	AddNode (FBModel pObject, FBMatrix pMatrix=NULL, bool pIsLocalMatrix=false)
	Add a new pose node.

void	RemoveNode (int pIndex)
	Remove the pose node at specified index.

void	SetNodeObject (int pIndex, FBModel *pObject)
	Set the pose node object.

FBModel *	GetNodeObject (int pIndex)
	Get the pose node object.

FBString	GetNodeName (int pIndex) const
	Get the pose node at specified index.

void	SetNodeMatrix (int pIndex, FBMatrix *pMatrix)
	Set the pose node matrix.

FBMatrix	GetNodeMatrix (int pIndex) const
	Get the pose node matrix.

FBMatrix	GetNodeMatrixGlobal (int pIndex) const
	Get the global pose node matrix.

void	SetIsNodeLocalMatrix (int pIndex, bool pIsNodeLocalMatrix)
	Set the type of the Matrix for a given node.

bool	IsNodeLocalMatrix (int pIndex)
	Get the type of the Matrix for a given node.

int	Find (FBString pNodeName)
	Look in this pose if the given node is present.

void	CreatePoseThumbnail ()
	Create an image thumbnail for the current pose.

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor.

virtual	~FBComponent ()
	Destructor.

virtual bool	FBCreate ()
	Open Reality Creation function.

virtual void	FBDestroy ()
	Open Reality destruction function.

virtual void	FBDelete () override
	Open Reality deletion function.

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer.

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

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager.

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace.

virtual const char *	ClassName () override
	Get the class name.

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not.

const char *	GetFullName (void)
	Get the full name.

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object.

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object.

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object.

void	HardSelect ()
	HardSelect.

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId.

virtual int	GetTypeId () override
	GetTypeId( int pTypeId )

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject.

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Static Public Member Functions
static void	MirrorRetargetPoseAllObjects (FBObjectPose &pDstPose, FBObjectPose &pSrcPose, FBObjectPose &pDstStancePose, FBObjectPose &pSrcStancePose, FBVector4< double > &pMirrorPlaneEquation)
	Mirror the transform of all objects in the SrcPose and retarget the result on the DstPose.

static void	MirrorRetargetPose (FBObjectPose &pDstPose, FBObjectPose &pSrcPose, FBObjectPose &pDstStancePose, FBObjectPose &pSrcStancePose, FBVector4< double > &pMirrorPlaneEquation, const char pDstObjectName, const char pSrcObjectName)
	Mirror the transform of an object in the SrcPose and retarget the result on the DstPose.

static void	RetargetPose (FBObjectPose &pDstPose, FBObjectPose &pSrcPose, const char pDstObjectName, const char pSrcObjectName)
	Retarget the non-transform properties from the SrcPose to the DstPose.

Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Additional Inherited Members
Public Attributes inherited from FBPose
FBPropertyPoseType	Type
	Read Only Property: Type of the pose (bind pose or rest pose)

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

FBPropertyListComponent	Components
	List: List of components.

FBPropertyListComponent	Parents
	List: Parents.

FBPropertyBool	Selected
	Read Write Property: Selected property.

FBPropertyString	Name
	Read Write Property: Unique name of object.

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

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component.

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object.

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component.

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection.

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection.

void	DisconnectAllSrc ()
	Remove all source connections.

void	DisconnectAllDst ()
	Remove all destination connections.

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index.

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index.

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index.

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index.

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B.

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex.

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc.

int	GetSrcCount ()
	Get source connection count.

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index.

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index.

int	GetDstCount ()
	Get destination connection count.

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index.

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index.

bool	BeginChange ()
	Begins a change on multiple plugs.

void	EndChange ()
	Ends a change on multiple plugs.

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag.

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed.

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag.

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed.

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List.

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status.

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag.

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed.

FBPlug *	GetOwner ()
	Get the owner of this plug.

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index.

int	GetOwnedCount ()
	Get the owned plug count.

virtual const char *	ClassName ()
	internal System vars.

virtual bool	Is (int pTypeId)
	Is( int pTypeId )

virtual int	GetTypeId ()
	GetTypeId( int pTypeId )

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.

virtual void	FBDelete ()
	Actual destructor for a FBPlug.

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id.

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component.

HIObject	mObject
	Handle on the Plug.

bool	mSDKComponent
	bool Plug is an SDK component.

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object.

static int	TypeInfo
	TypeInfo.

static int	mGlobalTypeInfo
	Represente the Type Index.

Detailed Description

FBObjectPose class.

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

Definition at line 192 of file fbobjectpose.h.

Constructor & Destructor Documentation

◆ FBObjectPose()

FBObjectPose	(	const char *	pName,
		HIObject	pObject = `NULL`
	)

Public constructor.

This constructor is used to create a new object.

Parameters

pName	Object name. If pObject is not NULL, pName will be ignored.
pObject	For internal use only.

Member Function Documentation

◆ AddStanceOffset()

void AddStanceOffset	(	const char *	pObjectName,
		FBObjectPose &	pStancePose,
		FBPoseTransformType	pPoseTransformType = `kFBPoseTransformInvalid`
	)

Add the StanceOffset to an object in the pose.

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.

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

◆ AddStanceOffsetAllObjects()

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

Add the StanceOffset to all the objects in the pose.

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.

Parameters

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

◆ ClearPose()

void ClearPose ( )

Clear all the data of the pose.

◆ CopyFrom()

void CopyFrom ( FBObjectPose & pFromPose )

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.

◆ CopyObjectPose()

void CopyObjectPose	(	const char *	pObjectName,
		FBComponent &	pObject
	)

Copy the pose of all the properties of an object.

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

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.

◆ CopyPoseAllObjectsTransformFrom()

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

Copy all the transforms from a given pose.

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

Parameters

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

◆ CopyPoseDataFrom()

void CopyPoseDataFrom ( FBObjectPose & pFromPose )

Copy all the pose data from a given pose.

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

Parameters

pFromPose Pose from which to copy the data.

◆ CopyPoseTransformFrom()

void CopyPoseTransformFrom	(	FBObjectPose &	pFromPose,
		const char *	pObjectName,
		FBPoseTransformType	pPoseTransformType = `kFBPoseTransformInvalid`
	)

Copy the transforms of an object from a given pose.

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

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

◆ CopyPropertyPose()

void CopyPropertyPose	(	const char *	pObjectName,
		FBProperty &	pProperty
	)

Copy the pose of a property of an object.

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

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.

◆ CopyTransform()

void CopyTransform	(	const char *	pObjectName,
		FBComponent &	pObject,
		FBObjectPoseOptions &	pObjectPoseOptions
	)

Copy the transform of an object.

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

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

◆ GetPropertyValue()

void GetPropertyValue	(	double *	pValue,
		int	pSize,
		const char *	pObjectName,
		const char *	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,
		const char *	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	(	const char *	pObjectName,
		const char *	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	(	const char *	pObjectName,
		FBPoseTransformType	pPoseTransformType = `kFBPoseTransformInvalid`
	)

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

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

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

◆ MirrorPose()

void MirrorPose	(	const char *	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()

void MirrorPoseAllObjects ( FBObjectPoseMirrorOptions & pObjectPoseMirrorOptions )

Mirror the transform of all objects in the pose.

Parameters

pObjectPoseMirrorOptions MirrorOptions used to specify the mirror plane.

◆ MirrorRetargetPose()

static void MirrorRetargetPose	(	FBObjectPose &	pDstPose,
		FBObjectPose &	pSrcPose,
		FBObjectPose &	pDstStancePose,
		FBObjectPose &	pSrcStancePose,
		FBVector4< double > &	pMirrorPlaneEquation,
		const char *	pDstObjectName,
		const char *	pSrcObjectName
	)

static

Mirror the transform of an object in the SrcPose and retarget the result on the DstPose.

Remarks: This function can be used to mirror the pose of a right-arm on a left-arm, or a tail on itself.; The mirror plane should intersect with the origin because we mirror the pose with stance offsets removed.

Parameters

pDstPose	Destination pose to receive the result.
pSrcPose	Source pose to mirror.
pDstStancePose	Stance pose for the DstPose.
pSrcStancePose	Stance pose for the SrcPose.
pMirrorPlaneEquation	Mirror plane used to mirror the SrcPose once the stance offsets are removed.
pDstObjectName	Name of the object in the DstPose to receive the mirror of the SrcPose.
pSrcObjectName	Name of the object to mirror from the SrcPose.

◆ MirrorRetargetPoseAllObjects()

static void MirrorRetargetPoseAllObjects	(	FBObjectPose &	pDstPose,
		FBObjectPose &	pSrcPose,
		FBObjectPose &	pDstStancePose,
		FBObjectPose &	pSrcStancePose,
		FBVector4< double > &	pMirrorPlaneEquation
	)

static

Mirror the transform of all objects in the SrcPose and retarget the result on the DstPose.

Remarks: This function can be used to mirror the pose of a right-arm on a left-arm, or a tail on itself.; The mirror plane should intersect with the origin because we mirror the pose with stance offsets removed.

Parameters

pDstPose	Destination pose to receive the result.
pSrcPose	Source pose to mirror.
pDstStancePose	Stance pose for the DstPose.
pSrcStancePose	Stance pose for the SrcPose.
pMirrorPlaneEquation	Mirror plane used to mirror the SrcPose once the stance offsets are removed.

◆ MultTransform()

void MultTransform	(	const char *	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()

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

void PasteObjectPose	(	const char *	pObjectName,
		FBComponent &	pObject
	)

Paste the pose of all the properties of an object.

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

Parameters

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

◆ PastePropertyPose()

void PastePropertyPose	(	const char *	pObjectName,
		FBProperty &	pProperty
	)

Paste the pose of a property of an object.

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.

Parameters

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

◆ PasteTransform()

void PasteTransform	(	const char *	pObjectName,
		FBComponent &	pObject,
		FBObjectPoseOptions &	pObjectPoseOptions,
		FBEvaluateInfo *	pEvaluateInfo = `NULL`
	)

Paste the transform of an object.

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

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

◆ RemoveStanceOffset()

void RemoveStanceOffset	(	const char *	pObjectName,
		FBObjectPose &	pStancePose,
		FBPoseTransformType	pPoseTransformType = `kFBPoseTransformInvalid`
	)

Remove the StanceOffset from an object in the pose.

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.

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

◆ RemoveStanceOffsetAllObjects()

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

Remove the StanceOffset from all the objects in the pose.

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.

Parameters

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

◆ RetargetPose()

static void RetargetPose	(	FBObjectPose &	pDstPose,
		FBObjectPose &	pSrcPose,
		const char *	pDstObjectName,
		const char *	pSrcObjectName
	)

static

Retarget the non-transform properties from the SrcPose to the DstPose.

Remarks: This will copy all stored properties from the specified object in SrcPose to the specified object in DstPose.

Parameters

pDstPose	Destination pose.
pSrcPose	Source pose.
pDstObjectName	Name of the object in the DstPose to receive the copy.
pSrcObjectName	Name of the object to copy from the SrcPose.

◆ SetPropertyValue()

void SetPropertyValue	(	const char *	pObjectName,
		const char *	pPropertyName,
		double *	pValue,
		int	pSize
	)

Set the value of a property in the pose.

Parameters

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

◆ SetTransform()

void SetTransform	(	FBTVector &	pT,
		FBMatrix &	pRM,
		FBMatrix &	pSM,
		const char *	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).

The documentation for this class was generated from the following file:

fbobjectpose.h

Public Member Functions

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

◆ MirrorRetargetPose()

◆ MirrorRetargetPoseAllObjects()

◆ MultTransform()

◆ MultTransformAllObjects()

◆ PasteObjectPose()

◆ PastePropertyPose()

◆ PasteTransform()

◆ RemoveStanceOffset()

◆ RemoveStanceOffsetAllObjects()

◆ RetargetPose()

◆ SetPropertyValue()

◆ SetTransform()