This reference page is linked to from the following overview topics: FBPose - Poses.
#include <mobu-python-api.h>
FBObjectPose class. This class exposes the object used to store the pose of objects.
def __reduce__ | ( | ) |
Reimplemented from FBPose.
def __init__ | ( | ) |
Python Docstring:
__init__( (object)arg1, (str)arg2) -> None
C++ Constructors:
The reference documentation for the following C++ symbols may
contain additional relevant information.
Reimplemented from FBPose.
def AddStanceOffsetAllObjects | ( | ) |
Python Docstring:
AddStanceOffsetAllObjects( (FBObjectPose)arg1, (FBObjectPose)arg2 [, (FBPoseTransformType)arg3]) -> None
C++ Signature:
void AddStanceOffsetAllObjects(FBObjectPose & pStancePose, FBPoseTransformType pPoseTransformType = kFBPoseTransformInvalid)
Add the StanceOffset to all the objects in the pose.
If pPoseTransformType is set to kFBPoseTransformInvalid, offsets will be added in all TransformTypes.
pStancePose | Pose representing the stance of all objects. |
pPoseTransformType | Transform type in which to add the offset (Local, Global or LocalRef). |
def AddStanceOffset | ( | ) |
Python Docstring:
AddStanceOffset( (FBObjectPose)arg1, (str)arg2, (FBObjectPose)arg3 [, (FBPoseTransformType)arg4]) -> None
C++ Signature:
void AddStanceOffset(const char * pObjectName, FBObjectPose & pStancePose, FBPoseTransformType pPoseTransformType = kFBPoseTransformInvalid)
Add the StanceOffset to an object in the pose.
If pPoseTransformType is set to kFBPoseTransformInvalid, offsets will be added in all TransformTypes.
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). |
def ClearPose | ( | ) |
Python Docstring:
ClearPose( (FBObjectPose)arg1) -> None
C++ Signature:
void ClearPose()
Clear all the data of the pose.
def CopyFrom | ( | ) |
Python Docstring:
CopyFrom( (FBObjectPose)arg1, (FBObjectPose)arg2) -> None
C++ Signature:
void CopyFrom(FBObjectPose & pFromPose)
Copy everything from a given object.
pFromPose | Pose from which to copy. |
def CopyObjectPose | ( | ) |
Python Docstring:
CopyObjectPose( (FBObjectPose)arg1, (str)arg2, (FBComponent)arg3) -> None
C++ Signature:
void CopyObjectPose(const char * 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. |
def CopyPropertyPose | ( | ) |
Python Docstring:
CopyPropertyPose( (FBObjectPose)arg1, (str)arg2, (FBProperty)arg3) -> None
C++ Signature:
void CopyPropertyPose(const char * 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. |
def CopyPoseDataFrom | ( | ) |
Python Docstring:
CopyPoseDataFrom( (FBObjectPose)arg1, (FBObjectPose)arg2) -> None
C++ Signature:
void CopyPoseDataFrom(FBObjectPose & pFromPose)
Copy all the pose data from a given pose.
pFromPose | Pose from which to copy the data. |
def CopyPoseAllObjectsTransformFrom | ( | ) |
Python Docstring:
CopyPoseAllObjectsTransformFrom( (FBObjectPose)arg1, (FBObjectPose)arg2 [, (FBPoseTransformType)arg3]) -> None
C++ Signature:
void 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). |
def CopyPoseTransformFrom | ( | ) |
Python Docstring:
CopyPoseTransformFrom( (FBObjectPose)arg1, (FBObjectPose)arg2, (str)arg3 [, (FBPoseTransformType)arg4]) -> None
C++ Signature:
void CopyPoseTransformFrom(FBObjectPose & pFromPose, const char * 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). |
def CopyTransform | ( | ) |
Python Docstring:
CopyTransform( (FBObjectPose)arg1, (str)arg2, (FBComponent)arg3, (FBObjectPoseOptions)arg4) -> None
C++ Signature:
void CopyTransform(const char * 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). |
def GetPropertyValue | ( | ) |
Python Docstring:
GetPropertyValue( (FBObjectPose)arg1, (list)arg2, (object)arg3, (str)arg4, (str)arg5) -> None
C++ Signature:
void GetPropertyValue(double * pValue, int pSize, const char * pObjectName, const char * pPropertyName)
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. |
def GetTransform | ( | ) |
Python Docstring:
GetTransform( (FBObjectPose)arg1, (object)arg2, (FBMatrix)arg3, (FBMatrix)arg4, (str)arg5, (FBPoseTransformType)arg6) -> bool
C++ Signature:
bool GetTransform(FBVector4 & pT, FBMatrix & pRM, FBMatrix & pSM, const char * 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). |
True
if the transform was found in the pose.def IsPropertyPoseable | ( | ) |
Python Docstring:
IsPropertyPoseable( (FBObjectPose)arg1, (FBProperty)arg2) -> bool
C++ Signature:
bool IsPropertyPoseable(FBProperty & pProperty)
Is the property poseable?
True
if the value of this property can be stored
in the pose.def IsPropertyStored | ( | ) |
Python Docstring:
IsPropertyStored( (FBObjectPose)arg1, (str)arg2, (str)arg3) -> bool
C++ Signature:
bool IsPropertyStored(const char * pObjectName, const char * pPropertyName)
Is the property stored in the pose?
pObjectName | Name of the object. |
pPropertyName | Name of the property. |
True
if the property is stored in the pose.def IsTransformStored | ( | ) |
Python Docstring:
IsTransformStored( (FBObjectPose)arg1, (str)arg2 [, (FBPoseTransformType)arg3]) -> bool
C++ Signature:
bool IsTransformStored(const char * 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. |
True
if the transform of this object is stored in
the specified TransformType (Local, Global and LocalRef).def MirrorPoseAllObjects | ( | ) |
Python Docstring:
MirrorPoseAllObjects( (FBObjectPose)arg1, (FBObjectPoseMirrorOptions)arg2) -> None
C++ Signature:
void MirrorPoseAllObjects(FBObjectPoseMirrorOptions & pObjectPoseMirrorOptions)
Mirror the transform of all objects in the pose.
pObjectPoseMirrorOptions | MirrorOptions used to specify the mirror plane. |
def MirrorPose | ( | ) |
Python Docstring:
MirrorPose( (FBObjectPose)arg1, (str)arg2, (FBObjectPoseMirrorOptions)arg3) -> None
C++ Signature:
void MirrorPose(const char * 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. |
def MultTransformAllObjects | ( | ) |
Python Docstring:
MultTransformAllObjects( (FBObjectPose)arg1, (FBMatrix)arg2, (FBModelTransformationType)arg3, (FBPoseTransformType)arg4) -> None
C++ Signature:
void 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). |
def MultTransform | ( | ) |
Python Docstring:
MultTransform( (FBObjectPose)arg1, (str)arg2, (FBMatrix)arg3, (FBModelTransformationType)arg4, (FBPoseTransformType)arg5) -> None
C++ Signature:
void MultTransform(const char * 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). |
def PasteObjectPose | ( | ) |
Python Docstring:
PasteObjectPose( (FBObjectPose)arg1, (str)arg2, (FBComponent)arg3) -> None
C++ Signature:
void PasteObjectPose(const char * pObjectName, FBComponent & pObject)
Paste the pose of all the properties of an object.
Properties that were not stored in the pose will not be affected.
pObjectName | Name of the object stored in the pose. |
pObject | Object which will receive the values stored in the pose. |
def PastePropertyPose | ( | ) |
Python Docstring:
PastePropertyPose( (FBObjectPose)arg1, (str)arg2, (FBProperty)arg3) -> None
C++ Signature:
void PastePropertyPose(const char * pObjectName, FBProperty & pProperty)
Paste the pose of a property of an object.
The property will not be affected if it was not stored in the pose.
pObjectName | Name of the object stored in the pose. |
pProperty | Property which will receive the value stored in the pose. |
def PasteTransform | ( | ) |
Python Docstring:
PasteTransform( (FBObjectPose)arg1, (str)arg2, (FBComponent)arg3, (FBObjectPoseOptions)arg4) -> None
C++ Signature:
void PasteTransform(const char * pObjectName, FBComponent & pObject, FBObjectPoseOptions & pObjectPoseOptions, FBEvaluateInfo * pEvaluateInfo = NULL)
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.) |
def RemoveStanceOffsetAllObjects | ( | ) |
Python Docstring:
RemoveStanceOffsetAllObjects( (FBObjectPose)arg1, (FBObjectPose)arg2 [, (FBPoseTransformType)arg3]) -> None
C++ Signature:
void RemoveStanceOffsetAllObjects(FBObjectPose & pStancePose, FBPoseTransformType pPoseTransformType = kFBPoseTransformInvalid)
Remove the StanceOffset from all the objects in the pose.
If pPoseTransformType is set to kFBPoseTransformInvalid, offsets will be removed in all TransformTypes.
pStancePose | Pose representing the stance of all objects. |
pPoseTransformType | Transform type in which to remove the offset (Local, Global or LocalRef). |
def RemoveStanceOffset | ( | ) |
Python Docstring:
RemoveStanceOffset( (FBObjectPose)arg1, (str)arg2, (FBObjectPose)arg3 [, (FBPoseTransformType)arg4]) -> None
C++ Signature:
void RemoveStanceOffset(const char * pObjectName, FBObjectPose & pStancePose, FBPoseTransformType pPoseTransformType = kFBPoseTransformInvalid)
Remove the StanceOffset from an object in the pose.
If pPoseTransformType is set to kFBPoseTransformInvalid, offsets will be removed in all TransformTypes.
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). |
def SetPropertyValue | ( | ) |
Python Docstring:
SetPropertyValue( (FBObjectPose)arg1, (str)arg2, (str)arg3, (object)arg4, (object)arg5) -> None
C++ Signature:
void SetPropertyValue(const char * pObjectName, const char * pPropertyName, double * pValue, int pSize)
Set the value of a property in the pose.
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. |
def SetTransform | ( | ) |
Python Docstring:
SetTransform( (FBObjectPose)arg1, (object)arg2, (FBMatrix)arg3, (FBMatrix)arg4, (str)arg5, (FBPoseTransformType)arg6) -> None
C++ Signature:
void SetTransform(FBVector4 & pT, FBMatrix & pRM, FBMatrix & pSM, const char * 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). |
def AddNode | ( | ) | [inherited] |
Python Docstring:
AddNode( (FBPose)arg1, (FBModel)arg2 [, (FBMatrix)arg3 [, (object)arg4]]) -> int
C++ Signature:
int AddNode(FBModel * pObject, FBMatrix * pMatrix = NULL, bool pIsLocalMatrix = false)
Add a new pose node.
pObject | The object for which we are creating the pose information. |
pMatrix | The transformation of the object we want to save. |
pIsLocalMatrix | Is the matrix a local matrix? |
def Find | ( | ) | [inherited] |
Python Docstring:
Find( (FBPose)arg1, (str)arg2) -> int
C++ Signature:
int Find(FBString pNodeName)
Look in this pose if the given node is present.
pNodeName | Name of the node we are looking for. |
def GetNodeCount | ( | ) | [inherited] |
Python Docstring:
GetNodeCount( (FBPose)arg1) -> int
C++ Signature:
int GetNodeCount()
Returns the number of pose nodes stored.
def GetNodeMatrix | ( | ) | [inherited] |
Python Docstring:
GetNodeMatrix( (FBPose)arg1, (object)arg2) -> FBMatrix
C++ Signature:
FBMatrix GetNodeMatrix(int pIndex)
Get the pose node matrix.
pIndex | Index of the node. |
The reference will become undefined if this object is destroyed.
def GetNodeName | ( | ) | [inherited] |
Python Docstring:
GetNodeName( (FBPose)arg1, (object)arg2) -> str
C++ Signature:
FBString GetNodeName(int pIndex)
Get the pose node at specified index.
pIndex | Index of the node. |
The reference will become undefined if this object is destroyed.
def GetNodeObject | ( | ) | [inherited] |
Python Docstring:
GetNodeObject( (FBPose)arg1, (object)arg2) -> object
C++ Signature:
FBModel * GetNodeObject(int pIndex)
Get the pose node object.
pIndex | Index of the node. |
def IsNodeLocalMatrix | ( | ) | [inherited] |
Python Docstring:
IsNodeLocalMatrix( (FBPose)arg1, (object)arg2) -> bool
C++ Signature:
bool IsNodeLocalMatrix(int pIndex)
Get the type of the Matrix for a given node.
pIndex | Index of the node. |
def RemoveNode | ( | ) | [inherited] |
Python Docstring:
RemoveNode( (FBPose)arg1, (object)arg2) -> None
C++ Signature:
void RemoveNode(int pIndex)
Remove the pose node at specified index.
pIndex | Index of the node to be removed. |
def SetIsNodeLocalMatrix | ( | ) | [inherited] |
Python Docstring:
SetIsNodeLocalMatrix( (FBPose)arg1, (object)arg2, (object)arg3) -> None
C++ Signature:
void SetIsNodeLocalMatrix(int pIndex, bool pIsNodeLocalMatrix)
Set the type of the Matrix for a given node.
pIndex | Index of the node. |
pIsNodeLocalMatrix | True if the matrix of the node is a local matrix. |
def SetNodeMatrix | ( | ) | [inherited] |
Python Docstring:
SetNodeMatrix( (FBPose)arg1, (object)arg2, (FBMatrix)arg3) -> None
C++ Signature:
void SetNodeMatrix(int pIndex, FBMatrix * pMatrix)
Set the pose node matrix.
pIndex | Index of the node. |
pMatrix | Matrix to set for this pose node. |
def SetNodeObject | ( | ) | [inherited] |
Python Docstring:
SetNodeObject( (FBPose)arg1, (object)arg2, (FBModel)arg3) -> None
C++ Signature:
void SetNodeObject(int pIndex, FBModel * pObject)
Set the pose node object.
pIndex | Index of the node. |
pObject | Object to associate with this pose node. |
def PropertyGetModifiedList | ( | ) | [inherited] |
Python Docstring:
PropertyGetModifiedList( (FBComponent)arg1, (FBPlugModificationFlag)arg2) -> FBPropertyList
C++ Signature:
void PropertyGetModifiedList(FBArrayTemplate< FBProperty * > & pPropList, FBPlugModificationFlag pModificationFlags)
Get list of properties which have been modified since last loading.
pPropList | property list to hold the modified properties. |
pModificationFlags | type of modification to query. |
def ClassName | ( | ) | [inherited] |
Python Docstring:
ClassName( (FBComponent)arg1) -> str
C++ Signature:
const char * ClassName()
Get the class name.
Reimplemented from FBPlug.
def DisableObjectFlags | ( | ) | [inherited] |
Python Docstring:
DisableObjectFlags( (FBComponent)arg1, (FBObjectFlag)arg2) -> None
C++ Signature:
void DisableObjectFlags(FBObjectFlag pFlags)
Disable a specific Object Flags.
pFlags | Flags to disable. |
def EnableObjectFlags | ( | ) | [inherited] |
Python Docstring:
EnableObjectFlags( (FBComponent)arg1, (FBObjectFlag)arg2) -> None
C++ Signature:
void EnableObjectFlags(FBObjectFlag pFlags)
Enable a specific Object Flags.
pFlags | Flags to enable. |
def FBCreate | ( | ) | [inherited] |
Python Docstring:
FBCreate( (FBComponent)arg1) -> bool
C++ Signature:
bool FBCreate()
Open Reality Creation function.
Reimplemented in FBAssetFile, FBAssetFolder, FBDevice, and FBDeviceOptical.
def FBDelete | ( | ) | [inherited] |
Python Docstring:
FBDelete( (FBComponent)arg1) -> None
C++ Signature:
void FBDelete()
Open Reality deletion function.
Reimplemented in FBActor, FBActorFace, FBAnimationLayer, FBAudioClip, FBCharacter, FBCharacterExtension, FBCharacterFace, FBFileReference, FBFilter, FBFolder, FBGenericMenu, FBGroup, FBImage, FBKeyingGroup, FBLayeredTexture, FBModel, FBMotionClip, FBNamespace, FBScene, FBSet, FBStoryClip, FBStoryFolder, FBStoryTrack, FBTake, FBTexture, and FBVideoClip.
def FBDestroy | ( | ) | [inherited] |
Python Docstring:
FBDestroy( (FBComponent)arg1) -> None
C++ Signature:
void FBDestroy()
Open Reality destruction function.
Reimplemented in FBAssetFile, FBAssetFolder, FBDevice, and FBDeviceOptical.
def GetObjectFlags | ( | ) | [inherited] |
Python Docstring:
GetObjectFlags( (FBComponent)arg1) -> FBObjectFlag
C++ Signature:
FBObjectFlag GetObjectFlags()
Get all Object Flags (concatenated).
def GetObjectStatus | ( | ) | [inherited] |
Python Docstring:
GetObjectStatus( (FBComponent)arg1, (FBObjectStatus)arg2) -> bool
C++ Signature:
bool GetObjectStatus(FBObjectStatus pStatus)
Check to see if an object status is enabled.
pStatus | Status to query. |
def HasObjectFlags | ( | ) | [inherited] |
Python Docstring:
HasObjectFlags( (FBComponent)arg1, (FBObjectFlag)arg2) -> bool
C++ Signature:
bool HasObjectFlags(FBObjectFlag pFlags)
Check whether a specific object flag is enabled.
pFlags | Flags to check if they are present. |
def Is | ( | ) | [inherited] |
Python Docstring:
Is( (FBComponent)arg1, (object)arg2) -> bool
C++ Signature:
bool Is(int pTypeId)
Returns true if object is of type TypeId.
pTypeId | TypeId to compare object to. |
Reimplemented from FBPlug.
def ProcessNamespaceHierarchy | ( | ) | [inherited] |
Python Docstring:
ProcessNamespaceHierarchy( (FBComponent)arg1, (FBNamespaceAction)arg2, (str)arg3 [, (str)arg4 [, (object)arg5]]) -> bool
C++ Signature:
bool ProcessNamespaceHierarchy(FBNamespaceAction pNamespaceAction, const char * pNamespaceName, const char * pReplaceTo = NULL, bool pAddRight = true)
ProcessNamespaceHierarchy. New Namespace name should only contains alphabet, digit and '_', Can't start with digit. This recursive function goes through the whole hierarchy (children) to add/replace the prefix. If you need to work on a single object, use the ProcessObjectPrefix function.
pNamespaceAction | Which operation to do on the hierarchy (children). |
pNamespaceName | The Namespace name on Add/Delete or the prefix to replace in case of replace. |
pReplaceTo | The new Namespace Name or NULL in case of add or delete. |
pAddRight | Whether to add the namespace on right-most or left-most side or other namespace. |
def ProcessObjectNamespace | ( | ) | [inherited] |
Python Docstring:
ProcessObjectNamespace( (FBComponent)arg1, (FBNamespaceAction)arg2, (str)arg3 [, (str)arg4 [, (object)arg5]]) -> bool
C++ Signature:
bool ProcessObjectNamespace(FBNamespaceAction pNamespaceAction, const char * pNamespaceName, const char * pReplaceTo = NULL, bool pAddRight = true)
ProcessObjectNamespace. New Namespace name should only contains alphabet, digit and '_', Can't start with digit. This function is the same as ProcessNamespaceHierarchy except that it applies only on the current object and not to the object's children.
pNamespaceAction | Which operation to do on the hierarchy (children). |
pNamespaceName | The Namespace name on Add/Delete or the prefix to replace in case of replace. |
pReplaceTo | The new Namespace Name or NULL in case of add or delete. |
pAddRight | Whether to add the namespace on right-most or left-most side or other namespace. |
def PropertyAdd | ( | ) | [inherited] |
Python Docstring:
PropertyAdd( (FBComponent)arg1, (FBProperty)arg2) -> int
C++ Signature:
int PropertyAdd(FBProperty * pProperty)
Add a property to the component's property manager.
pProperty | The property to add to the property manager. |
def PropertyAddReferenceProperty | ( | ) | [inherited] |
Python Docstring:
PropertyAddReferenceProperty( (FBComponent)arg1, (FBProperty)arg2) -> bool
C++ Signature:
bool PropertyAddReferenceProperty(FBProperty * pReferenceProperty)
Add a reference property to the component's property manager.
pReferenceProperty | The property to from an other object to add a reference to (property cannot be a custom ORSDK property). |
def PropertyCreate | ( | ) | [inherited] |
Python Docstring:
PropertyCreate( (FBComponent)arg1, (str)arg2, (FBPropertyType)arg3, (str)arg4, (object)arg5, (object)arg6, (FBProperty)arg7) -> object
C++ Signature:
FBProperty * PropertyCreate(const char * pName, FBPropertyType pType, const char * pDataType, bool pAnimatable, bool pIsUser = false, FBProperty * pReferenceSource = NULL)
Create user or dynamic property.
pName | The name of the property. |
pType | Type of the property. See enum FBPropertyType. |
pDataType | DataType of the property. |
pAnimatable | To specify if the property can be animated. |
pIsUser | To specify if the property is available as a custom property or dynamic and attached to the object. |
pReferenceSource | Specifies the property that a reference refers to. |
def PropertyRemove | ( | ) | [inherited] |
Python Docstring:
PropertyRemove( (FBComponent)arg1, (FBProperty)arg2) -> None
C++ Signature:
void PropertyRemove(FBProperty * pProperty)
Remove a Property from the component's Property manager. If the property was dynamically allocated, it is deleted.
pProperty | The property to remove from the property manager. |
def SetObjectFlags | ( | ) | [inherited] |
Python Docstring:
SetObjectFlags( (FBComponent)arg1, (FBObjectFlag)arg2) -> None
C++ Signature:
void SetObjectFlags(FBObjectFlag pFlags)
SetObjectFlags.
pFlags | Set flag values. Note: this function overwrites all flags with those passed in parameter. |
def SetObjectStatus | ( | ) | [inherited] |
Python Docstring:
SetObjectStatus( (FBComponent)arg1, (FBObjectStatus)arg2, (object)arg3) -> None
C++ Signature:
void SetObjectStatus(FBObjectStatus pStatus, bool pValue)
Enable/Disable a specific Object Status.
pStatus | Status to change. |
pValue | Value to change the status to. |
def HardSelect | ( | ) | [inherited] |
Python Docstring:
HardSelect( (FBComponent)arg1) -> None
C++ Signature:
void HardSelect()
HardSelect. Selects the object, and emits a hard select event for UI update notification.
def GetOwnerFileReference | ( | ) | [inherited] |
Python Docstring:
GetOwnerFileReference( (FBComponent)arg1) -> object
C++ Signature:
FBFileReference * GetOwnerFileReference(void )
Get the owner FileReference object.
def BeginChange | ( | ) | [inherited] |
Python Docstring:
BeginChange( (FBPlug)arg1) -> bool
C++ Signature:
bool BeginChange()
Begins a change on multiple plugs.
def ConnectDst | ( | ) | [inherited] |
Python Docstring:
ConnectDst( (FBPlug)arg1, (FBPlug)arg2 [, (FBConnectionType)arg3]) -> bool
C++ Signature:
bool ConnectDst(FBPlug * pDst, FBConnectionType pConnectionType = kFBConnectionTypeNone)
Add a destination connection.
pDst | Destination plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
def ConnectDstAt | ( | ) | [inherited] |
Python Docstring:
ConnectDstAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3 [, (FBConnectionType)arg4]) -> bool
C++ Signature:
bool ConnectDstAt(int pSrc_DstIndex, FBPlug * pDst, FBConnectionType pConnectionType = kFBConnectionTypeNone)
Add a destination connection.
pSrc_DstIndex | Index that tells where to add this destination connection in the source's connection list. if index is out of bound, and this destination connection will be appended at the end. |
pDst | Destination plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
def ConnectSrc | ( | ) | [inherited] |
Python Docstring:
ConnectSrc( (FBPlug)arg1, (FBPlug)arg2 [, (FBConnectionType)arg3]) -> bool
C++ Signature:
bool ConnectSrc(FBPlug * pSrc, FBConnectionType pConnectionType = kFBConnectionTypeNone)
Add a source connection.
pSrc | Source plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
def ConnectSrcAt | ( | ) | [inherited] |
Python Docstring:
ConnectSrcAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3 [, (FBConnectionType)arg4]) -> bool
C++ Signature:
bool ConnectSrcAt(int pDst_SrcIndex, FBPlug * pSrc, FBConnectionType pConnectionType = kFBConnectionTypeNone)
Add a source connection.
pDst_SrcIndex | Index that tells where to add this source connection in the destination's connection list. if index is out of bound, and this source connection will be appended at the end. |
pSrc | Source plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
def DisconnectAllDst | ( | ) | [inherited] |
Python Docstring:
DisconnectAllDst( (FBPlug)arg1) -> None
C++ Signature:
void DisconnectAllDst()
Remove all destination connections.
def DisconnectAllSrc | ( | ) | [inherited] |
Python Docstring:
DisconnectAllSrc( (FBPlug)arg1) -> None
C++ Signature:
void DisconnectAllSrc()
Remove all source connections.
def DisconnectDst | ( | ) | [inherited] |
Python Docstring:
DisconnectDst( (FBPlug)arg1, (FBPlug)arg2) -> bool
C++ Signature:
bool DisconnectDst(FBPlug * pDst)
Remove a destination connection.
pDst | Destination plug. |
def DisconnectDstAt | ( | ) | [inherited] |
Python Docstring:
DisconnectDstAt( (FBPlug)arg1, (object)arg2) -> bool
C++ Signature:
bool DisconnectDstAt(int pIndex)
Remove a destination connection at a specified index.
pIndex | Destination plug index. |
def DisconnectSrc | ( | ) | [inherited] |
Python Docstring:
DisconnectSrc( (FBPlug)arg1, (FBPlug)arg2) -> bool
C++ Signature:
bool DisconnectSrc(FBPlug * pSrc)
Remove a source connection.
pSrc | Source plug. |
def DisconnectSrcAt | ( | ) | [inherited] |
Python Docstring:
DisconnectSrcAt( (FBPlug)arg1, (object)arg2) -> bool
C++ Signature:
bool DisconnectSrcAt(int pIndex)
Remove a source connection at a specified index.
pIndex | Source plug index. |
def EndChange | ( | ) | [inherited] |
Python Docstring:
EndChange( (FBPlug)arg1) -> None
C++ Signature:
void EndChange()
Ends a change on multiple plugs.
def GetDst | ( | ) | [inherited] |
Python Docstring:
GetDst( (FBPlug)arg1, (object)arg2) -> object
C++ Signature:
FBPlug * GetDst(int pIndex)
Get a destination connection's plug at specified index.
pIndex | Index of the destination connection's plug. |
def GetDstCount | ( | ) | [inherited] |
Python Docstring:
GetDstCount( (FBPlug)arg1) -> int
C++ Signature:
int GetDstCount()
Get destination connection count.
def GetDstType | ( | ) | [inherited] |
Python Docstring:
GetDstType( (FBPlug)arg1, (object)arg2) -> FBConnectionType
C++ Signature:
FBConnectionType GetDstType(int pIndex)
Get a destination connection's type at specified index.
pIndex | Index of the destination connection's type. |
def GetOwned | ( | ) | [inherited] |
Python Docstring:
GetOwned( (FBPlug)arg1, (object)arg2) -> object
C++ Signature:
FBPlug * GetOwned(int pIndex)
Get the owned plug at specified index.
pIndex | Index of the owned plug to get. |
def GetOwnedCount | ( | ) | [inherited] |
Python Docstring:
GetOwnedCount( (FBPlug)arg1) -> int
C++ Signature:
int GetOwnedCount()
Get the owned plug count.
def GetOwner | ( | ) | [inherited] |
Python Docstring:
GetOwner( (FBPlug)arg1) -> object
C++ Signature:
FBPlug * GetOwner()
Get the owner of this plug. Very useful for properties since they are plugs too.
def GetSrc | ( | ) | [inherited] |
Python Docstring:
GetSrc( (FBPlug)arg1, (object)arg2) -> object
C++ Signature:
FBPlug * GetSrc(int pIndex)
Get a source connection's plug at specified index.
pIndex | Index of the source connection's plug. |
def GetSrcCount | ( | ) | [inherited] |
Python Docstring:
GetSrcCount( (FBPlug)arg1) -> int
C++ Signature:
int GetSrcCount()
Get source connection count.
def GetSrcType | ( | ) | [inherited] |
Python Docstring:
GetSrcType( (FBPlug)arg1, (object)arg2) -> FBConnectionType
C++ Signature:
FBConnectionType GetSrcType(int pIndex)
Get a source connection's type at specified index.
pIndex | Index of the source connection's type. |
def IsSDKComponent | ( | ) | [inherited] |
Python Docstring:
IsSDKComponent( (FBPlug)arg1) -> bool
C++ Signature:
bool IsSDKComponent()
Return whether or not item is an SDK component.
def MoveSrcAt | ( | ) | [inherited] |
Python Docstring:
MoveSrcAt( (FBPlug)arg1, (object)arg2, (object)arg3) -> bool MoveSrcAt( (FBPlug)arg1, (FBPlug)arg2, (FBPlug)arg3) -> bool
Related C++ documentation:
The reference documentation for the following C++ symbols may
contain additional relevant information.
def ReplaceDstAt | ( | ) | [inherited] |
Python Docstring:
ReplaceDstAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3) -> bool
C++ Signature:
bool ReplaceDstAt(int pIndex, FBPlug * pDst)
Replace a destination connection at a specified index.
pIndex | Destination plug index. |
pDst | Plug that will replace the other at index. |
def ReplaceSrcAt | ( | ) | [inherited] |
Python Docstring:
ReplaceSrcAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3) -> bool
C++ Signature:
bool ReplaceSrcAt(int pIndex, FBPlug * pSrc)
Replace a source connection at a specified index.
pIndex | Source plug index. |
pSrc | Plug that will replace the other at index. |
def SwapSrc | ( | ) | [inherited] |
Python Docstring:
SwapSrc( (FBPlug)arg1, (object)arg2, (object)arg3) -> bool
C++ Signature:
bool SwapSrc(int pIndexA, int pIndexB)
Swap source connection at index A with source connection at index B.
pIndexA | Plug index. |
pIndexB | Other plug index. |
def SetSelfModified | ( | ) | [inherited] |
Python Docstring:
SetSelfModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2, (object)arg3) -> None
C++ Signature:
void SetSelfModified(FBPlugModificationFlag pFlag, bool pBool)
Set the plug's self modification flag.
pFlag | bitwise AND of self modification flags. |
pBool | true if self changed. |
def GetSelfModified | ( | ) | [inherited] |
Python Docstring:
GetSelfModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2) -> bool
C++ Signature:
bool GetSelfModified(FBPlugModificationFlag pFlag)
Tell if the plug's self has changed.
pFlag | bitwise AND of self modification flags. |
def SetContentModified | ( | ) | [inherited] |
Python Docstring:
SetContentModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2, (object)arg3) -> None
C++ Signature:
void SetContentModified(FBPlugModificationFlag pFlag, bool pBool)
Set the plug's owned property/object's modification flag.
pFlag | bitwise AND of content modification flags. |
pBool | true if content has modification. |
def GetContentModified | ( | ) | [inherited] |
Python Docstring:
GetContentModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2) -> bool
C++ Signature:
bool GetContentModified(FBPlugModificationFlag pFlag)
Tell if the plug's content has changed.
pFlag | bitwise AND of content modification flags. |
def GetPlugConnectionModifiedList | ( | ) | [inherited] |
Python Docstring:
GetPlugConnectionModifiedList( (FBPlug)arg1, (FBPlugList)arg2, (FBPlugModificationFlag)arg3, (object)arg4) -> int
C++ Signature:
int GetPlugConnectionModifiedList(FBArrayTemplate & pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
Get plug's modified src/dst property/object connection added/removed List.
pPlugList | plug list to fill up. |
pConnectionModificatonFlag | Src/Dst Property/Object connection modification flag. |
pAddRemove | Ask for the added list if true, removed list if false. |
def RevertModification | ( | ) | [inherited] |
Python Docstring:
RevertModification( (FBPlug)arg1 [, (FBPlugModificationFlag)arg2]) -> bool
C++ Signature:
bool RevertModification(FBPlugModificationFlag pFlag = kFBAllModifiedMask)
Revert the plug's modification to original status.
pFlag | the type of modification to be reverted. |
def PrintClassDefinitions | ( | ) | [inherited] |
Python Docstring:
staticmethod(function) -> method Convert a function to be a static method. A static method does not receive an implicit first argument. To declare a static method, use this idiom: class C: def f(arg1, arg2, ...): ... f = staticmethod(f) It can be called either on the class (e.g. C.f()) or on an instance (e.g. C().f()). The instance is ignored except for its class. Static methods in Python are similar to those found in Java or C++. For a more advanced concept, see the classmethod builtin.
C++ Signature:
void PrintClassDefinitions()
Print out internal Class (ID) Definition table. For internal debug purpose only.
FBPropertyPoseType Type
[inherited] |
Read Only Property: Type of the pose (bind pose or rest pose)
object OwnerNamespace
[inherited] |
FBPropertyListComponent
Components
[inherited] |
List: List of components.
Reimplemented in FBScene.
FBPropertyString Name
[inherited] |
Read Write Property: Unique name of object.
Reimplemented in FBAssetMng.
FBPropertyString LongName
[inherited] |
Read Write Property: Name and namespace for object.
object FullName
[inherited] |
FBPropertyListComponent
Parents
[inherited] |
FBPropertyManager PropertyList
[inherited] |
Read Only Property: Manages all of the properties for the component.
FBPropertyBool Selected
[inherited] |
Read Write Property: Selected property.
Reimplemented in FBModel.
object OnUnbind
[inherited] |