Objects Grouping class. More...
#include <pyfbsdk_generated.h>
Public Member Functions | |
FBCharacterExtension (str pName) | |
Constructor. More... | |
AddObjectProperties (FBComponent pObj) | |
Add TR Properties from Object. More... | |
FBDelete () | |
Virtual FBDelete function. More... | |
FBCharacter | GetCharacter () |
Return the attached Character. More... | |
FBComponent | GetExtensionObjectWithLabelName (str pLabelName) |
Find stored object based on label name. More... | |
GetLabelNameWithExtensionObject (str pLabelName, FBComponent pObj, bool pReturnObjectNameIfNotFound=False) | |
Find the label name that was used to store object pose. More... | |
FBCharacterExtension | GetMirrorExtension () |
Return the character extension determined by MirrorLabel. More... | |
int | GetRetargetPropertyCount () |
Return the total number of retarget properties. More... | |
FBProperty | GetRetargetReferenceProperty (int pPropIndex) |
Return the reference property of the given index. More... | |
FBProperty | GetRetargetSourceProperty (int pPropIndex) |
Return the source property of the given index (the source property is the property that drives the reference property during retargeting). More... | |
FBCharacterExtension | GetSourceExtension () |
Return the character extension that is used to drive this extension during retargeting. More... | |
int | GetSourceExtensionIndex () |
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... | |
FBObjectPose | GetStancePose () |
Return stance pose. More... | |
GoToStancePose () | |
Reset object position to the stance. More... | |
bool | IsElementSelected () |
Return true if one object in object dependency list is selected. More... | |
bool | IsPropertyIncluded (FBProperty pProp) |
Return true if the property is in character extension. More... | |
RemoveObjectAndProperties (FBComponent pObj) | |
Remove TR Properties from Object. More... | |
RemoveRetargetSourceProperty (int pPropIndex) | |
Remove the source property for retargeting. More... | |
SetRetargetSourceProperty (int pPropIndex, FBProperty pSourceProp) | |
Set the source property for retargeting. More... | |
SetSourceExtension (FBCharacterExtension pSourceExtension) | |
Set the character extension to drive this extension during retargeting. More... | |
SetSourceExtensionIndex (int pSrcExtIndex) | |
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... | |
UpdateStancePose () | |
Update the stance pose to the current position of the character extension element. More... | |
![]() | |
FBKeyingGroup (str pName, FBKeyingGroupType pType) | |
Constructor. More... | |
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). More... | |
AddProperty (FBProperty pProp) | |
Add property to be keyed when current keying group is active. More... | |
ClearAllItems () | |
ClearAllItems clear object dependency, properties and child keying group. More... | |
DeselectAllAnimatableProperties () | |
FBDeselectAllAnimatableProperties, deselect all animatable properties in the scene. More... | |
FBDelete () | |
Virtual FBDelete function. More... | |
int | FindPropertyIndex (FBProperty pProp) |
FindPropertyIndex. More... | |
FBProperty | GetCumulativeProperty (int pIndex, bool pStopAtVisible=False) |
GetCumulativeProperty Same as GetSubKeyingGroup but recursive in child keying group. More... | |
int | GetCumulativePropertyCount (bool pStopAtVisible=False) |
GetCumulativePropertyCount Same as GetSubKeyingGroupCount but recursive in child keying group. More... | |
FBKeyingGroup | GetParentKeyingGroup (int pIndex) |
GetParentKeyingGroup. More... | |
int | GetParentKeyingGroupCount () |
GetParentKeyingGroupCount. More... | |
FBProperty | GetProperty (int pIndex) |
GetProperty from the keyinggroup list. More... | |
int | GetPropertyCount () |
GetPropertyCount. More... | |
FBKeyingGroup | GetSubKeyingGroup (int pIndex) |
GetSubKeyingGroup. More... | |
int | GetSubKeyingGroupCount () |
GetSubKeyingGroupCount. More... | |
FBComponent | GetSubObject (int pIndex) |
GetSubObject. More... | |
int | GetSubObjectCount () |
GetSubObjectCount. More... | |
bool | IsObjectDependency (FBComponent pObj) |
IsObjectDependency determine if the pObj is a dependency. More... | |
bool | IsObjectDependencySelected () |
IsObjectDependencySelected. More... | |
RemoveAllObjectDependency () | |
IsObjectDependencySelected empty the content list. More... | |
RemoveAllProperties () | |
IsObjectDependencySelected empty the property list. More... | |
RemoveAllSubKeyingGroup () | |
RemoveAllSubKeyingGroup empty the child keying group. More... | |
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). More... | |
RemoveProperty (FBProperty pProp) | |
RemoveProperty from the keyinggroup list. More... | |
SetActive (bool pActive) | |
SetActive, activate the keying group, replacing the other keying group. More... | |
SetActiveAppend (bool pActive) | |
SetActiveAppend, activate and append the keying group to the other keying groups. More... | |
SetEnabled (bool pEnable) | |
SetEnabled, makes the keying group available in keying group list of the key control UI. More... | |
SetObjectType (FBComponent pObject) | |
Set the object type filter for and object type keying group. More... | |
![]() | |
FBComponent () | |
Constructor. More... | |
str | ClassName () |
Get the class name. More... | |
DisableObjectFlags (FBObjectFlag pFlags) | |
Disable a specific Object Flags. More... | |
EnableObjectFlags (FBObjectFlag pFlags) | |
Enable a specific Object Flags. More... | |
bool | FBCreate () |
Open Reality Creation function. More... | |
FBDelete () | |
Open Reality deletion function. More... | |
FBDestroy () | |
Open Reality destruction function. More... | |
FBObjectFlag | GetObjectFlags () |
Get all Object Flags (concatenated). More... | |
bool | GetObjectStatus (FBObjectStatus pStatus) |
Check to see if an object status is enabled. More... | |
FBFileReference | GetOwnerFileReference (p0) |
Get the owner FileReference object. More... | |
HardSelect () | |
HardSelect. More... | |
bool | HasObjectFlags (FBObjectFlag pFlags) |
Check whether a specific object flag is enabled. More... | |
bool | Is (int pTypeId) |
Returns true if object is of type TypeId. More... | |
bool | ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True) |
ProcessNamespaceHierarchy. More... | |
bool | ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True) |
ProcessObjectNamespace. More... | |
int | PropertyAdd (FBProperty pProperty) |
Add a property to the component's property manager. More... | |
bool | PropertyAddReferenceProperty (FBProperty pReferenceProperty) |
Add a reference property to the component's property manager. More... | |
FBProperty | PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None) |
Create user or dynamic property. More... | |
PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags) | |
Get list of properties which have been modified since last loading. More... | |
PropertyRemove (FBProperty pProperty) | |
Remove a Property from the component's Property manager. More... | |
SetObjectFlags (FBObjectFlag pFlags) | |
SetObjectFlags. More... | |
SetObjectStatus (FBObjectStatus pStatus, bool pValue) | |
Enable/Disable a specific Object Status. More... | |
Public Attributes | |
bool | IncludePartInBodyPart |
Read Write Property: Include or not this extension when the Body Part mode is active. More... | |
bool | IncludePartInFullBody |
Read Write Property: Include or not this extension when the Full Body mode is active. More... | |
str | Label |
Read Write Property: The logical name of the extension, use for mirroring. More... | |
int | 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... | |
FBPlotAllowed | PlotAllowed |
Read Write Property: Controls if objects in the set are transformable. More... | |
FBModel | ReferenceModel |
Read Write Property: Controls the referential of the extension. More... | |
FBCharacterExtensionRetargetMode | RetargetMode |
Read Write Property: Character extension retarget mode. More... | |
FBCharacterExtensionStancePoseMode | StancePoseMode |
Read Write Property: Character extension stance pose mode. More... | |
FBSyncActivationAndVisibilityMode | SyncActivationAndVisibilityMode |
Read Write Property: The "Sync Activation & Visibility" mode. More... | |
![]() | |
FBListComponent | Components |
List: List of components. More... | |
str | LongName |
Read Write Property: Name and namespace for object. More... | |
str | Name |
Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py. More... | |
FBListComponent | Parents |
List: Parents. More... | |
FBManager | PropertyList |
Read Only Property: Manages all of the properties for the component. More... | |
bool | Selected |
Read Write Property: Selected property. More... | |
int | TypeInfo |
Contains the Type information of the object. More... | |
![]() | |
str | ClassGroupName |
ClassGroupName of the object. More... | |
int | TypeInfo |
TypeInfo. More... | |
Objects Grouping class.
This class is an interface to manipulate object's grouping in the scene.
FBCharacterExtension | ( | str | pName | ) |
Constructor.
pName | Group name. |
AddObjectProperties | ( | FBComponent | pObj | ) |
Add TR Properties from Object.
pObj | Object to add TR properties. |
FBDelete | ( | ) |
Virtual FBDelete function.
FBCharacter GetCharacter | ( | ) |
Return the attached Character.
FBComponent GetExtensionObjectWithLabelName | ( | str | pLabelName | ) |
Find stored object based on label name.
pLabelName | The label name. |
GetLabelNameWithExtensionObject | ( | str | pLabelName, |
FBComponent | pObj, | ||
bool | pReturnObjectNameIfNotFound = False |
||
) |
Find the label name that was used to store object pose.
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. |
FBCharacterExtension GetMirrorExtension | ( | ) |
Return the character extension determined by MirrorLabel.
int GetRetargetPropertyCount | ( | ) |
Return the total number of retarget properties.
FBProperty GetRetargetReferenceProperty | ( | int | pPropIndex | ) |
Return the reference property of the given index.
pPropIndex | Index to query. |
FBProperty GetRetargetSourceProperty | ( | int | pPropIndex | ) |
Return the source property of the given index (the source property is the property that drives the reference property during retargeting).
pPropIndex | Index to query. |
FBCharacterExtension GetSourceExtension | ( | ) |
Return the character extension that is used to drive this extension during retargeting.
int GetSourceExtensionIndex | ( | ) |
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.
FBObjectPose GetStancePose | ( | ) |
Return stance pose.
GoToStancePose | ( | ) |
Reset object position to the stance.
bool IsElementSelected | ( | ) |
Return true if one object in object dependency list is selected.
bool IsPropertyIncluded | ( | FBProperty | pProp | ) |
Return true if the property is in character extension.
pProp | Property to check. |
RemoveObjectAndProperties | ( | FBComponent | pObj | ) |
Remove TR Properties from Object.
pObj | Object to remove TR properties. |
RemoveRetargetSourceProperty | ( | int | pPropIndex | ) |
Remove the source property for retargeting.
Only applicable if RetargetMode is Manually Assign.
pPropIndex | Index to remove. |
SetRetargetSourceProperty | ( | int | pPropIndex, |
FBProperty | pSourceProp | ||
) |
Set the source property for retargeting.
Only applicable if RetargetMode is Manually Assign.
pPropIndex | Index to set. |
pSourceProp | Source property to set. |
SetSourceExtension | ( | FBCharacterExtension | pSourceExtension | ) |
Set the character extension to drive this extension during retargeting.
Only applicable if RetargetMode is Assign.
pSourceExtension | The source extension to drive this extension during retargeting. |
SetSourceExtensionIndex | ( | int | pSrcExtIndex | ) |
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.
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 | ( | ) |
Update the stance pose to the current position of the character extension element.
bool IncludePartInBodyPart |
Read Write Property: Include or not this extension when the Body Part mode is active.
bool IncludePartInFullBody |
Read Write Property: Include or not this extension when the Full Body mode is active.
str Label |
Read Write Property: The logical name of the extension, use for mirroring.
int 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.
FBPlotAllowed PlotAllowed |
Read Write Property: Controls if objects in the set are transformable.
FBModel ReferenceModel |
Read Write Property: Controls the referential of the extension.
FBCharacterExtensionRetargetMode RetargetMode |
Read Write Property: Character extension retarget mode.
FBCharacterExtensionStancePoseMode StancePoseMode |
Read Write Property: Character extension stance pose mode.
FBSyncActivationAndVisibilityMode SyncActivationAndVisibilityMode |
Read Write Property: The "Sync Activation & Visibility" mode.