#include <mobu-python-api.h>
Objects Grouping class.
This class is an interface to manipulate object's grouping in the scene.
Public Member Functions | |
__reduce__ () | |
AddObjectProperties (FBCharacterExtension arg1, FBComponent arg2) | |
Add TR Properties from Object. More... | |
__init__ (object arg1, str arg2) | |
Constructor. More... | |
FBDelete (FBCharacterExtension arg1) | |
Virtual FBDelete function. More... | |
object | GetCharacter (FBCharacterExtension arg1) |
Return the attached Character. More... | |
object | GetMirrorExtension (FBCharacterExtension arg1) |
Return the character extension determined by MirrorLabel. More... | |
GoToStancePose (FBCharacterExtension arg1) | |
Reset object position to the stance. More... | |
bool | IsElementSelected (FBCharacterExtension arg1) |
Return true if one object in object dependency list is selected. More... | |
bool | IsPropertyIncluded (FBCharacterExtension arg1, FBProperty arg2) |
Return true if the property is in character extension. More... | |
str | GetLabelNameWithExtensionObject (FBCharacterExtension arg1, FBComponent arg2, object arg3) |
Find the label name that was used to store object pose. More... | |
object | GetExtensionObjectWithLabelName (FBCharacterExtension arg1, str arg2) |
Find stored object based on label name. More... | |
RemoveObjectAndProperties (FBCharacterExtension arg1, FBComponent arg2) | |
Remove TR Properties from Object. More... | |
UpdateStancePose (FBCharacterExtension arg1) | |
Update the stance pose to the current position of the character extension element. More... | |
object | GetSourceExtension (FBCharacterExtension arg1) |
Return the character extension that is used to drive this extension during retargeting. More... | |
SetSourceExtension (FBCharacterExtension arg1, FBCharacterExtension arg2) | |
Set the character extension to drive this extension during retargeting. More... | |
int | GetSourceExtensionIndex (FBCharacterExtension arg1) |
Return the enum that indicate which extension is used as a source during retargeting, 0 is none, 1-n represent the (ith - 1)character extension in the source character. More... | |
SetSourceExtensionIndex (FBCharacterExtension arg1, object arg2) | |
Set the enum that indicate which extension is used as a source during retargeting, 0 is none, 1-n represent the (ith - 1)character extension in the source character. More... | |
int | GetRetargetPropertyCount (FBCharacterExtension arg1) |
Return the total number of retarget properties. More... | |
object | GetRetargetReferenceProperty (FBCharacterExtension arg1, object arg2) |
Return the reference property of the given index. More... | |
object | GetRetargetSourceProperty (FBCharacterExtension arg1, object arg2) |
Return the source property of the given index (the source property is the property that drives the reference property during retargeting). More... | |
SetRetargetSourceProperty (FBCharacterExtension arg1, object arg2, FBProperty arg3) | |
Set the source property for retargeting. More... | |
RemoveRetargetSourceProperty (FBCharacterExtension arg1, object arg2) | |
Remove the source property for retargeting. More... | |
object | GetStancePose (FBCharacterExtension arg1) |
Return stance pose. More... | |
![]() | |
__reduce__ () | |
AddObjectDependency (FBKeyingGroup arg1, FBComponent arg2) | |
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). More... | |
__init__ (object arg1, str arg2, FBKeyingGroupType arg3) | |
Constructor. More... | |
AddProperty (FBKeyingGroup arg1, FBProperty arg2) | |
Add property to be keyed when current keying group is active. More... | |
ClearAllItems (FBKeyingGroup arg1) | |
ClearAllItems clear object dependency, properties and child keying group. More... | |
FBDelete (FBKeyingGroup arg1) | |
Virtual FBDelete function. More... | |
int | FindPropertyIndex (FBKeyingGroup arg1, FBProperty arg2) |
FindPropertyIndex. More... | |
object | GetCumulativeProperty (FBKeyingGroup arg1, object arg2, object arg3) |
GetCumulativeProperty Same as GetSubKeyingGroup but recursive in child keying group. More... | |
int | GetCumulativePropertyCount (FBKeyingGroup arg1, object arg2) |
GetCumulativePropertyCount Same as GetSubKeyingGroupCount but recursive in child keying group. More... | |
object | GetParentKeyingGroup (FBKeyingGroup arg1, object arg2) |
GetParentKeyingGroup. More... | |
int | GetParentKeyingGroupCount (FBKeyingGroup arg1) |
GetParentKeyingGroupCount. More... | |
object | GetProperty (FBKeyingGroup arg1, object arg2) |
GetProperty from the keyinggroup list. More... | |
int | GetPropertyCount (FBKeyingGroup arg1) |
GetPropertyCount. More... | |
object | GetSubKeyingGroup (FBKeyingGroup arg1, object arg2) |
GetSubKeyingGroup. More... | |
int | GetSubKeyingGroupCount (FBKeyingGroup arg1) |
GetSubKeyingGroupCount. More... | |
object | GetSubObject (FBKeyingGroup arg1, object arg2) |
GetSubObject. More... | |
int | GetSubObjectCount (FBKeyingGroup arg1) |
GetSubObjectCount. More... | |
bool | IsObjectDependency (FBKeyingGroup arg1, FBComponent arg2) |
IsObjectDependency determine if the pObj is a dependency. More... | |
bool | IsObjectDependencySelected (FBKeyingGroup arg1) |
IsObjectDependencySelected. More... | |
RemoveAllObjectDependency (FBKeyingGroup arg1) | |
IsObjectDependencySelected empty the content list. More... | |
RemoveAllProperties (FBKeyingGroup arg1) | |
IsObjectDependencySelected empty the property list. More... | |
RemoveAllSubKeyingGroup (FBKeyingGroup arg1) | |
RemoveAllSubKeyingGroup empty the child keying group. More... | |
RemoveObjectDependency (FBKeyingGroup arg1, FBComponent arg2) | |
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). More... | |
RemoveProperty (FBKeyingGroup arg1, FBProperty arg2) | |
RemoveProperty from the keyinggroup list. More... | |
SetActive (FBKeyingGroup arg1, object arg2) | |
SetActive, activate the keying group, replacing the other keying group. More... | |
SetActiveAppend (FBKeyingGroup arg1, object arg2) | |
SetActiveAppend, activate and append the keying group to the other keying groups. More... | |
SetEnabled (FBKeyingGroup arg1, object arg2) | |
SetEnabled, makes the keying group available in keying group list of the key control UI. More... | |
SetObjectType (FBKeyingGroup arg1, FBComponent arg2) | |
Set the object type filter for and object type keying group. More... | |
method | staticmethod (function) |
FBDeselectAllAnimatableProperties, deselect all animatable properties in the scene. More... | |
![]() | |
__reduce__ () | |
FBPropertyList | PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2) |
Get list of properties which have been modified since last loading. More... | |
str | ClassName (FBComponent arg1) |
Get the class name. More... | |
DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2) | |
Disable a specific Object Flags. More... | |
EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2) | |
Enable a specific Object Flags. More... | |
bool | FBCreate (FBComponent arg1) |
Open Reality Creation function. More... | |
FBDelete (FBComponent arg1) | |
Open Reality deletion function. More... | |
FBDestroy (FBComponent arg1) | |
Open Reality destruction function. More... | |
FBObjectFlag | GetObjectFlags (FBComponent arg1) |
Get all Object Flags (concatenated). More... | |
bool | GetObjectStatus (FBComponent arg1, FBObjectStatus arg2) |
Check to see if an object status is enabled. More... | |
bool | HasObjectFlags (FBComponent arg1, FBObjectFlag arg2) |
Check whether a specific object flag is enabled. More... | |
bool | Is (FBComponent arg1, object arg2) |
Returns true if object is of type TypeId. More... | |
bool | ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5) |
ProcessNamespaceHierarchy. More... | |
bool | ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5) |
ProcessObjectNamespace. More... | |
int | PropertyAdd (FBComponent arg1, FBProperty arg2) |
Add a property to the component's property manager. More... | |
bool | PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2) |
Add a reference property to the component's property manager. More... | |
object | PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7) |
Create user or dynamic property. More... | |
PropertyRemove (FBComponent arg1, FBProperty arg2) | |
Remove a Property from the component's Property manager. More... | |
SetObjectFlags (FBComponent arg1, FBObjectFlag arg2) | |
SetObjectFlags. More... | |
SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3) | |
Enable/Disable a specific Object Status. More... | |
HardSelect (FBComponent arg1) | |
HardSelect. More... | |
object | GetOwnerFileReference (FBComponent arg1) |
Get the owner FileReference object. More... | |
__init__ (...) | |
Constructor. More... | |
![]() | |
__reduce__ () | |
bool | BeginChange (FBPlug arg1) |
Begins a change on multiple plugs. More... | |
str | ClassName (FBPlug arg1) |
internal System vars. More... | |
bool | ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3) |
Add a destination connection. More... | |
bool | ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4) |
Add a destination connection. More... | |
bool | ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3) |
Add a source connection. More... | |
bool | ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4) |
Add a source connection. More... | |
DisconnectAllDst (FBPlug arg1) | |
Remove all destination connections. More... | |
DisconnectAllSrc (FBPlug arg1) | |
Remove all source connections. More... | |
bool | DisconnectDst (FBPlug arg1, FBPlug arg2) |
Remove a destination connection. More... | |
bool | DisconnectDstAt (FBPlug arg1, object arg2) |
Remove a destination connection at a specified index. More... | |
bool | DisconnectSrc (FBPlug arg1, FBPlug arg2) |
Remove a source connection. More... | |
bool | DisconnectSrcAt (FBPlug arg1, object arg2) |
Remove a source connection at a specified index. More... | |
EndChange (FBPlug arg1) | |
Ends a change on multiple plugs. More... | |
object | GetDst (FBPlug arg1, object arg2) |
Get a destination connection's plug at specified index. More... | |
int | GetDstCount (FBPlug arg1) |
Get destination connection count. More... | |
FBConnectionType | GetDstType (FBPlug arg1, object arg2) |
Get a destination connection's type at specified index. More... | |
object | GetOwned (FBPlug arg1, object arg2) |
Get the owned plug at specified index. More... | |
int | GetOwnedCount (FBPlug arg1) |
Get the owned plug count. More... | |
object | GetOwner (FBPlug arg1) |
Get the owner of this plug. More... | |
object | GetSrc (FBPlug arg1, object arg2) |
Get a source connection's plug at specified index. More... | |
int | GetSrcCount (FBPlug arg1) |
Get source connection count. More... | |
FBConnectionType | GetSrcType (FBPlug arg1, object arg2) |
Get a source connection's type at specified index. More... | |
bool | Is (FBPlug arg1, object arg2) |
Is( int pTypeId ) More... | |
bool | IsSDKComponent (FBPlug arg1) |
Return whether or not item is an SDK component. More... | |
MoveSrcAt (...) | |
bool | ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3) |
Replace a destination connection at a specified index. More... | |
bool | ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3) |
Replace a source connection at a specified index. More... | |
bool | SwapSrc (FBPlug arg1, object arg2, object arg3) |
Swap source connection at index A with source connection at index B. More... | |
SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3) | |
Set the plug's self modification flag. More... | |
bool | GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2) |
Tell if the plug's self has changed. More... | |
SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3) | |
Set the plug's owned property/object's modification flag. More... | |
bool | GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2) |
Tell if the plug's content has changed. More... | |
int | GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4) |
Get plug's modified src/dst property/object connection added/removed List. More... | |
bool | RevertModification (FBPlug arg1, FBPlugModificationFlag arg2) |
Revert the plug's modification to original status. More... | |
__init__ (...) | |
method | staticmethod (function) |
![]() | |
__reduce__ () | |
__init__ (...) | |
Public Attributes | |
FBPropertyBool | IncludePartInFullBody |
Read Write Property: Include or not this extension when fullBody is active. More... | |
ORSDK2018::FBPropertyString | Label |
Read Write Property: The logical name of the extension, use for mirroring. More... | |
FBPropertyInt | MirrorLabel |
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. More... | |
FBPropertyPlotAllowed | PlotAllowed |
Read Write Property: Controls if objects in the set are transformable. More... | |
FBPropertyModel | ReferenceModel |
Read Write Property: Controls the referential of the extension. More... | |
FBPropertyCharacterExtensionRetargetMode | RetargetMode |
Read Write Property: Character extension retarget mode. More... | |
object | SyncActivationAndVisibilityMode |
![]() | |
object | OwnerNamespace |
ORSDK2018::FBPropertyListComponent | Components |
List: List of components. More... | |
ORSDK2018::FBPropertyString | Name |
Read Write Property: Unique name of object. More... | |
ORSDK2018::FBPropertyString | LongName |
Read Write Property: Name and namespace for object. More... | |
object | FullName |
ORSDK2018::FBPropertyListComponent | Parents |
List: Parents. More... | |
ORSDK2018::FBPropertyManager | PropertyList |
Read Only Property: Manages all of the properties for the component. More... | |
FBPropertyBool | Selected |
Read Write Property: Selected property. More... | |
![]() | |
object | OnUnbind |
__init__ | ( | object | arg1, |
str | arg2 | ||
) |
Constructor.
Python Docstring:
__init__( (object)arg1, (str)arg2) -> None
C++ Signature:
FBCharacterExtension(const char * pName, HIObject pObject = ((void *) 0))
pName | Group name. |
pObject | For internal use only. |
__reduce__ | ( | ) |
AddObjectProperties | ( | FBCharacterExtension | arg1, |
FBComponent | arg2 | ||
) |
Add TR Properties from Object.
Python Docstring:
AddObjectProperties( (FBCharacterExtension)arg1, (FBComponent)arg2) -> None
C++ Signature:
void AddObjectProperties(ORSDK2018::FBComponent * pObj)
pObj | Object to add TR properties. |
FBDelete | ( | FBCharacterExtension | arg1 | ) |
Virtual FBDelete function.
Python Docstring:
FBDelete( (FBCharacterExtension)arg1) -> None
C++ Signature:
void FBDelete()
object GetCharacter | ( | FBCharacterExtension | arg1 | ) |
Return the attached Character.
Python Docstring:
GetCharacter( (FBCharacterExtension)arg1) -> object
C++ Signature:
ORSDK2018::FBCharacter * GetCharacter()
object GetExtensionObjectWithLabelName | ( | FBCharacterExtension | arg1, |
str | arg2 | ||
) |
Find stored object based on label name.
Python Docstring:
GetExtensionObjectWithLabelName( (FBCharacterExtension)arg1, (str)arg2) -> object
C++ Signature:
ORSDK2018::FBComponent * GetExtensionObjectWithLabelName(const ORSDK2018::FBString & pLabelName)
pLabelName | The label name. |
str GetLabelNameWithExtensionObject | ( | FBCharacterExtension | arg1, |
FBComponent | arg2, | ||
object | arg3 | ||
) |
Find the label name that was used to store object pose.
Python Docstring:
GetLabelNameWithExtensionObject( (FBCharacterExtension)arg1, (FBComponent)arg2, (object)arg3) -> str
C++ Signature:
void GetLabelNameWithExtensionObject(ORSDK2018::FBString & pLabelName, ORSDK2018::FBComponent * pObj, bool pReturnObjectNameIfNotFound = false)
pLabelName | The label name that was used to store object pose. |
pObj | The extension object. |
pReturnObjectNameIfNotFound | If the value is true, if the object is not found, pLabelName will be set to the object name; otherwise pLabelName will be set to empty string. By default the value is false. |
object GetMirrorExtension | ( | FBCharacterExtension | arg1 | ) |
Return the character extension determined by MirrorLabel.
Python Docstring:
GetMirrorExtension( (FBCharacterExtension)arg1) -> object
C++ Signature:
ORSDK2018::FBCharacterExtension * GetMirrorExtension()
int GetRetargetPropertyCount | ( | FBCharacterExtension | arg1 | ) |
Return the total number of retarget properties.
Python Docstring:
GetRetargetPropertyCount( (FBCharacterExtension)arg1) -> int
C++ Signature:
int GetRetargetPropertyCount()
object GetRetargetReferenceProperty | ( | FBCharacterExtension | arg1, |
object | arg2 | ||
) |
Return the reference property of the given index.
Python Docstring:
GetRetargetReferenceProperty( (FBCharacterExtension)arg1, (object)arg2) -> object
C++ Signature:
ORSDK2018::FBProperty * GetRetargetReferenceProperty(int pPropIndex)
pPropIndex | Index to query. |
object GetRetargetSourceProperty | ( | FBCharacterExtension | arg1, |
object | arg2 | ||
) |
Return the source property of the given index (the source property is the property that drives the reference property during retargeting).
Python Docstring:
GetRetargetSourceProperty( (FBCharacterExtension)arg1, (object)arg2) -> object
C++ Signature:
ORSDK2018::FBProperty * GetRetargetSourceProperty(int pPropIndex)
pPropIndex | Index to query. |
object GetSourceExtension | ( | FBCharacterExtension | arg1 | ) |
Return the character extension that is used to drive this extension during retargeting.
Python Docstring:
GetSourceExtension( (FBCharacterExtension)arg1) -> object
C++ Signature:
ORSDK2018::FBCharacterExtension * GetSourceExtension()
int GetSourceExtensionIndex | ( | FBCharacterExtension | arg1 | ) |
Return the enum that indicate which extension is used as a source during retargeting, 0 is none, 1-n represent the (ith - 1)character extension in the source character.
Python Docstring:
GetSourceExtensionIndex( (FBCharacterExtension)arg1) -> int
C++ Signature:
int GetSourceExtensionIndex()
object GetStancePose | ( | FBCharacterExtension | arg1 | ) |
Return stance pose.
Python Docstring:
GetStancePose( (FBCharacterExtension)arg1) -> object
C++ Signature:
ORSDK2018::FBObjectPose * GetStancePose()
GoToStancePose | ( | FBCharacterExtension | arg1 | ) |
Reset object position to the stance.
Python Docstring:
GoToStancePose( (FBCharacterExtension)arg1) -> None
C++ Signature:
void GoToStancePose()
bool IsElementSelected | ( | FBCharacterExtension | arg1 | ) |
Return true if one object in object dependency list is selected.
Python Docstring:
IsElementSelected( (FBCharacterExtension)arg1) -> bool
C++ Signature:
bool IsElementSelected()
bool IsPropertyIncluded | ( | FBCharacterExtension | arg1, |
FBProperty | arg2 | ||
) |
Return true if the property is in character extension.
Python Docstring:
IsPropertyIncluded( (FBCharacterExtension)arg1, (FBProperty)arg2) -> bool
C++ Signature:
bool IsPropertyIncluded(ORSDK2018::FBProperty * pProp)
pProp | Property to check. |
RemoveObjectAndProperties | ( | FBCharacterExtension | arg1, |
FBComponent | arg2 | ||
) |
Remove TR Properties from Object.
Python Docstring:
RemoveObjectAndProperties( (FBCharacterExtension)arg1, (FBComponent)arg2) -> None
C++ Signature:
void RemoveObjectAndProperties(ORSDK2018::FBComponent * pObj)
pObj | Object to remove TR properties. |
RemoveRetargetSourceProperty | ( | FBCharacterExtension | arg1, |
object | arg2 | ||
) |
Remove the source property for retargeting.
Python Docstring:
RemoveRetargetSourceProperty( (FBCharacterExtension)arg1, (object)arg2) -> None
C++ Signature:
void RemoveRetargetSourceProperty(int pPropIndex)
Only applicable if RetargetMode is Manually Assign.
pPropIndex | Index to remove. |
SetRetargetSourceProperty | ( | FBCharacterExtension | arg1, |
object | arg2, | ||
FBProperty | arg3 | ||
) |
Set the source property for retargeting.
Python Docstring:
SetRetargetSourceProperty( (FBCharacterExtension)arg1, (object)arg2, (FBProperty)arg3) -> None
C++ Signature:
void SetRetargetSourceProperty(int pPropIndex, ORSDK2018::FBProperty * pSourceProp)
Only applicable if RetargetMode is Manually Assign.
pPropIndex | Index to set. |
pSourceProp | Source property to set. |
SetSourceExtension | ( | FBCharacterExtension | arg1, |
FBCharacterExtension | arg2 | ||
) |
Set the character extension to drive this extension during retargeting.
Python Docstring:
SetSourceExtension( (FBCharacterExtension)arg1, (FBCharacterExtension)arg2) -> None
C++ Signature:
void SetSourceExtension(ORSDK2018::FBCharacterExtension * pSourceExtension)
Only applicable if RetargetMode is Assign.
pSourceExtension | The source extension to drive this extension during retargeting. |
SetSourceExtensionIndex | ( | FBCharacterExtension | arg1, |
object | arg2 | ||
) |
Set the enum that indicate which extension is used as a source during retargeting, 0 is none, 1-n represent the (ith - 1)character extension in the source character.
Python Docstring:
SetSourceExtensionIndex( (FBCharacterExtension)arg1, (object)arg2) -> None
C++ Signature:
void SetSourceExtensionIndex(int pSrcExtIndex)
Only applicable if RetargetMode is Manually Assign.
pSrcExtIndex | Enum that indicate which extension is used as a source during retargeting, 0 is none, 1-n represent the (ith - 1)character extension in the source character. |
UpdateStancePose | ( | FBCharacterExtension | arg1 | ) |
Update the stance pose to the current position of the character extension element.
Python Docstring:
UpdateStancePose( (FBCharacterExtension)arg1) -> None
C++ Signature:
void UpdateStancePose()
FBPropertyBool IncludePartInFullBody |
Read Write Property: Include or not this extension when fullBody is active.
ORSDK2018::FBPropertyString Label |
Read Write Property: The logical name of the extension, use for mirroring.
FBPropertyInt MirrorLabel |
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.
FBPropertyCharacterExtensionRetargetMode RetargetMode |
Read Write Property: Character extension retarget mode.
object SyncActivationAndVisibilityMode |