#include <mobu-python-api.h>
Objects Grouping class. This class is an interface to manipulate object's grouping in the scene.
def __reduce__ | ( | ) |
Reimplemented from FBKeyingGroup.
def AddObjectProperties | ( | ) |
Python Docstring:
AddObjectProperties( (FBCharacterExtension)arg1, (FBComponent)arg2) -> None
C++ Signature:
void AddObjectProperties(FBComponent * pObj)
Return the attached Character.
def __init__ | ( | ) |
Python Docstring:
__init__( (object)arg1, (str)arg2) -> None
C++ Signature:
FBCharacterExtension(const char * pName, HIObject pObject = NULL)
Constructor.
pName | Group name. |
pObject | For internal use only. |
Reimplemented from FBKeyingGroup.
def FBDelete | ( | ) |
Python Docstring:
FBDelete( (FBCharacterExtension)arg1) -> None
C++ Signature:
void FBDelete()
Virtual FBDelete function.
Reimplemented from FBKeyingGroup.
def GetCharacter | ( | ) |
Python Docstring:
GetCharacter( (FBCharacterExtension)arg1) -> object
C++ Signature:
FBCharacter * GetCharacter()
return the character extension determined by MirrorLabel
def GetMirrorExtension | ( | ) |
Python Docstring:
GetMirrorExtension( (FBCharacterExtension)arg1) -> object
C++ Signature:
FBCharacterExtension * GetMirrorExtension()
Reset object position to the stance.
def GoToStancePose | ( | ) |
Python Docstring:
GoToStancePose( (FBCharacterExtension)arg1) -> None
C++ Signature:
void GoToStancePose()
Update the stance pose to the current position of the character extension element.
def IsElementSelected | ( | ) |
Python Docstring:
IsElementSelected( (FBCharacterExtension)arg1) -> bool
C++ Signature:
bool IsElementSelected()
Remove TR Properties from Object.
def IsPropertyIncluded | ( | ) |
Python Docstring:
IsPropertyIncluded( (FBCharacterExtension)arg1, (FBProperty)arg2) -> bool
C++ Signature:
bool IsPropertyIncluded(FBProperty * pProp)
return true if one object in object dependency list is selected.
def GetLabelNameWithExtensionObject | ( | ) |
Python Docstring:
GetLabelNameWithExtensionObject( (FBCharacterExtension)arg1, (FBComponent)arg2, (object)arg3) -> str
C++ Signature:
void GetLabelNameWithExtensionObject(FBString & pLabelName, FBComponent * pObj, bool pReturnObjectNameIfNotFound = false)
return true if the property is in character extension.
def GetExtensionObjectWithLabelName | ( | ) |
Python Docstring:
GetExtensionObjectWithLabelName( (FBCharacterExtension)arg1, (str)arg2) -> object
C++ Signature:
FBComponent * GetExtensionObjectWithLabelName(const FBString & pLabelName)
Find the label name that was used to store object pose.
def RemoveObjectAndProperties | ( | ) |
Python Docstring:
RemoveObjectAndProperties( (FBCharacterExtension)arg1, (FBComponent)arg2) -> None
C++ Signature:
void RemoveObjectAndProperties(FBComponent * pObj)
Add TR Properties from Object.
def UpdateStancePose | ( | ) |
Python Docstring:
UpdateStancePose( (FBCharacterExtension)arg1) -> None
C++ Signature:
void UpdateStancePose()
def AddObjectDependency | ( | ) | [inherited] |
Python Docstring:
AddObjectDependency( (FBKeyingGroup)arg1, (FBComponent)arg2) -> None
C++ Signature:
void AddObjectDependency(FBComponent * pObj)
AddObjectDependency An object dependency is the content of a keying group and will activate keying group when selected (activation only works if the keying group is a character extension).
pObj | a Dependency of the keying group. |
def AddProperty | ( | ) | [inherited] |
Python Docstring:
AddProperty( (FBKeyingGroup)arg1, (FBProperty)arg2) -> None
C++ Signature:
void AddProperty(FBProperty * pProp)
Add property to be keyed when current keying group is active.
pProp | Property to be added. |
def ClearAllItems | ( | ) | [inherited] |
Python Docstring:
ClearAllItems( (FBKeyingGroup)arg1) -> None
C++ Signature:
void ClearAllItems()
ClearAllItems clear object dependency, properties and child keying group.
def FindPropertyIndex | ( | ) | [inherited] |
Python Docstring:
FindPropertyIndex( (FBKeyingGroup)arg1, (FBProperty)arg2) -> int
C++ Signature:
int FindPropertyIndex(FBProperty * pProp)
FindPropertyIndex.
pProp | must be in the list (return -1 if not). |
def GetCumulativeProperty | ( | ) | [inherited] |
Python Docstring:
GetCumulativeProperty( (FBKeyingGroup)arg1, (object)arg2, (object)arg3) -> object
C++ Signature:
FBProperty * GetCumulativeProperty(int pIndex, bool pStopAtVisible = false)
GetCumulativeProperty Same as GetSubKeyingGroup but recursive in child keying group.
pIndex | index in the content Object Dependency list |
pStopAtVisible | consider all keying group and stop to the first visible keying group. |
def GetCumulativePropertyCount | ( | ) | [inherited] |
Python Docstring:
GetCumulativePropertyCount( (FBKeyingGroup)arg1 [, (object)arg2]) -> int
C++ Signature:
int GetCumulativePropertyCount(bool pStopAtVisible = false)
GetCumulativePropertyCount Same as GetSubKeyingGroupCount but recursive in child keying group.
pStopAtVisible | consider all keying group and stop to the first visible keying group. |
def GetParentKeyingGroup | ( | ) | [inherited] |
Python Docstring:
GetParentKeyingGroup( (FBKeyingGroup)arg1, (object)arg2) -> object
C++ Signature:
FBKeyingGroup * GetParentKeyingGroup(int pIndex)
GetParentKeyingGroup.
pIndex | is the index of the parent list of the current keying group. |
def GetParentKeyingGroupCount | ( | ) | [inherited] |
Python Docstring:
GetParentKeyingGroupCount( (FBKeyingGroup)arg1) -> int
C++ Signature:
int GetParentKeyingGroupCount()
GetParentKeyingGroupCount.
def GetProperty | ( | ) | [inherited] |
Python Docstring:
GetProperty( (FBKeyingGroup)arg1, (object)arg2) -> object
C++ Signature:
FBProperty * GetProperty(int pIndex)
GetProperty from the keyinggroup list.
pIndex | index of the desired property. |
def GetPropertyCount | ( | ) | [inherited] |
Python Docstring:
GetPropertyCount( (FBKeyingGroup)arg1) -> int
C++ Signature:
int GetPropertyCount()
GetPropertyCount.
def GetSubKeyingGroup | ( | ) | [inherited] |
Python Docstring:
GetSubKeyingGroup( (FBKeyingGroup)arg1, (object)arg2) -> object
C++ Signature:
FBKeyingGroup * GetSubKeyingGroup(int pIndex)
GetSubKeyingGroup.
pIndex | index of the desired keying group child. |
def GetSubKeyingGroupCount | ( | ) | [inherited] |
Python Docstring:
GetSubKeyingGroupCount( (FBKeyingGroup)arg1) -> int
C++ Signature:
int GetSubKeyingGroupCount()
GetSubKeyingGroupCount.
def GetSubObject | ( | ) | [inherited] |
Python Docstring:
GetSubObject( (FBKeyingGroup)arg1, (object)arg2) -> object
C++ Signature:
FBComponent * GetSubObject(int pIndex)
GetSubObject.
pIndex | index in the content Object Dependency list |
pIndex
.def GetSubObjectCount | ( | ) | [inherited] |
Python Docstring:
GetSubObjectCount( (FBKeyingGroup)arg1) -> int
C++ Signature:
int GetSubObjectCount()
GetSubObjectCount.
def IsObjectDependency | ( | ) | [inherited] |
Python Docstring:
IsObjectDependency( (FBKeyingGroup)arg1, (FBComponent)arg2) -> bool
C++ Signature:
bool IsObjectDependency(FBComponent * pObj)
IsObjectDependency determine if the pObj
is a
dependency.
pObj | an object to test the Dependency. |
def IsObjectDependencySelected | ( | ) | [inherited] |
Python Docstring:
IsObjectDependencySelected( (FBKeyingGroup)arg1) -> bool
C++ Signature:
bool IsObjectDependencySelected()
IsObjectDependencySelected.
def RemoveAllObjectDependency | ( | ) | [inherited] |
Python Docstring:
RemoveAllObjectDependency( (FBKeyingGroup)arg1) -> None
C++ Signature:
void RemoveAllObjectDependency()
IsObjectDependencySelected empty the content list.
def RemoveAllProperties | ( | ) | [inherited] |
Python Docstring:
RemoveAllProperties( (FBKeyingGroup)arg1) -> None
C++ Signature:
void RemoveAllProperties()
IsObjectDependencySelected empty the property list.
def RemoveAllSubKeyingGroup | ( | ) | [inherited] |
Python Docstring:
RemoveAllSubKeyingGroup( (FBKeyingGroup)arg1) -> None
C++ Signature:
void RemoveAllSubKeyingGroup()
RemoveAllSubKeyingGroup empty the child keying group.
def RemoveObjectDependency | ( | ) | [inherited] |
Python Docstring:
RemoveObjectDependency( (FBKeyingGroup)arg1, (FBComponent)arg2) -> None
C++ Signature:
void RemoveObjectDependency(FBComponent * pObj)
RemoveObjectDependency An object dependency is the content of a keying group and will activate keying group when selected (activation only works if the keying group is a character extension).
pObj | a Dependency of the keying group. |
def RemoveProperty | ( | ) | [inherited] |
Python Docstring:
RemoveProperty( (FBKeyingGroup)arg1, (FBProperty)arg2) -> None
C++ Signature:
void RemoveProperty(FBProperty * pProp)
RemoveProperty from the keyinggroup list.
pProp | Property to be removed. |
def SetActive | ( | ) | [inherited] |
Python Docstring:
SetActive( (FBKeyingGroup)arg1, (object)arg2) -> None
C++ Signature:
void SetActive(bool pActive)
SetActive, activate the keying group, replacing the other keying group.
def SetActiveAppend | ( | ) | [inherited] |
Python Docstring:
SetActiveAppend( (FBKeyingGroup)arg1, (object)arg2) -> None
C++ Signature:
void SetActiveAppend(bool pActive)
SetActiveAppend, activate and append the keying group to the other keying groups.
def SetEnabled | ( | ) | [inherited] |
Python Docstring:
SetEnabled( (FBKeyingGroup)arg1, (object)arg2) -> None
C++ Signature:
void SetEnabled(bool pEnable)
SetEnabled, makes the keying group available in keying group list of the key control UI.
def SetObjectType | ( | ) | [inherited] |
Python Docstring:
SetObjectType( (FBKeyingGroup)arg1, (FBComponent)arg2) -> None
C++ Signature:
void SetObjectType(FBComponent * pObject)
Set the object type filter for and object type keying group.
pObject | Object that will be used to set the keying group object type. Use NULL to remove the filter. |
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 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.
Read Write Property: Include or not this extension when fullBody is active.
Read Write Property: The logical name of the extension, use for mirroring.
Read Write Property: Enum that indicate which extension is used as mirror, 0 is none, 1 is self, 2-n represent the (ith - 2)character extension in the attached character excluding self.
FBPropertyPlotAllowed PlotAllowed |
Read Write Property: Controls if objects in the set are transformable.
FBPropertyModel ReferenceModel |
Read Write Property: Controls the referential of the extension.
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] |