FBObjectPose class. More...
#include <pyfbsdk.h>
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. | |
![]() | |
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. | |
![]() | |
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 | |
![]() | |
FBPoseType | Type |
Read Only Property: Type of the pose (bind pose or rest pose) | |
![]() | |
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. | |
![]() | |
str | ClassGroupName |
ClassGroupName of the object. | |
int | TypeInfo |
TypeInfo. | |
FBObjectPose class.
This class exposes the object used to store the pose of objects.
FBObjectPose | ( | str | pName | ) |
Public constructor.
This constructor is used to create a new object.
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.
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 | ( | FBObjectPose | pStancePose, |
FBPoseTransformType | pPoseTransformType = kFBPoseTransformInvalid |
||
) |
Add the StanceOffset to all the objects in the pose.
pStancePose | Pose representing the stance of all objects. |
pPoseTransformType | Transform type in which to add the offset (Local, Global or LocalRef). |
ClearPose | ( | ) |
Clear all the data of the pose.
CopyFrom | ( | FBObjectPose | pFromPose | ) |
Copy everything from a given object.
pFromPose | Pose from which to copy. |
CopyObjectPose | ( | str | pObjectName, |
FBComponent | pObject | ||
) |
Copy the pose of all the properties of an object.
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 | ( | FBObjectPose | pFromPose, |
FBPoseTransformType | pPoseTransformType = kFBPoseTransformInvalid |
||
) |
Copy all the transforms from a given pose.
pFromPose | Pose from which to copy the data. |
pPoseTransformType | Transform type from which to copy the transform (Local, Global or LocalRef). |
CopyPoseDataFrom | ( | FBObjectPose | pFromPose | ) |
Copy all the pose data from a given pose.
pFromPose | Pose from which to copy the data. |
CopyPoseTransformFrom | ( | FBObjectPose | pFromPose, |
str | pObjectName, | ||
FBPoseTransformType | pPoseTransformType = kFBPoseTransformInvalid |
||
) |
Copy the transforms of an object from a given pose.
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 | ( | str | pObjectName, |
FBProperty | pProperty | ||
) |
Copy the pose of a property of an object.
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 | ( | str | pObjectName, |
FBComponent | pObject, | ||
FBObjectPoseOptions | pObjectPoseOptions | ||
) |
Copy the transform of an object.
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). |
Get the value of a property stored in the pose.
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. |
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.
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). |
bool IsPropertyPoseable | ( | FBProperty | pProperty | ) |
Is the property poseable?
Is the property stored in the pose?
pObjectName | Name of the object. |
pPropertyName | Name of the property. |
bool IsTransformStored | ( | str | pObjectName, |
FBPoseTransformType | pPoseTransformType = kFBPoseTransformInvalid |
||
) |
Is the transform of this object stored in the specified TransformType?
pObjectName | Name of the object. |
pPoseTransformType | Transform type in which to check. |
MirrorPose | ( | str | pObjectName, |
FBObjectPoseMirrorOptions | pObjectPoseMirrorOptions | ||
) |
Mirror the transform of an object in the pose.
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.
pObjectPoseMirrorOptions | MirrorOptions used to specify the mirror plane. |
MultTransform | ( | str | pObjectName, |
FBMatrix | pGX, | ||
FBModelTransformationType | pTransformAttribute, | ||
FBPoseTransformType | pPoseTransformType | ||
) |
Multiply the transform of an objects in the pose.
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, |
FBModelTransformationType | pTransformAttribute, | ||
FBPoseTransformType | pPoseTransformType | ||
) |
Multiply the transform of all objects in the pose.
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.
pObjectName | Name of the object stored in the pose. |
pObject | Object which will receive the values stored in the pose. |
PastePropertyPose | ( | str | pObjectName, |
FBProperty | pProperty | ||
) |
Paste the pose of a property of an object.
pObjectName | Name of the object stored in the pose. |
pProperty | Property which will receive the value stored in the pose. |
PasteTransform | ( | str | pObjectName, |
FBComponent | pObject, | ||
FBObjectPoseOptions | pObjectPoseOptions, | ||
FBEvaluateInfo | pEvaluateInfo = None |
||
) |
Paste the transform of an object.
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 | ( | str | pObjectName, |
FBObjectPose | pStancePose, | ||
FBPoseTransformType | pPoseTransformType = kFBPoseTransformInvalid |
||
) |
Remove the StanceOffset from an object in the pose.
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 | ( | FBObjectPose | pStancePose, |
FBPoseTransformType | pPoseTransformType = kFBPoseTransformInvalid |
||
) |
Remove the StanceOffset from all the objects in the pose.
pStancePose | Pose representing the stance of all objects. |
pPoseTransformType | Transform type in which to remove the offset (Local, Global or LocalRef). |
Set the value of a property in the pose.
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.
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). |