Python Reference Guide
 
Loading...
Searching...
No Matches
FBCharacterExtension Class Reference

Objects Grouping class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBCharacterExtension:

Public Member Functions

 FBCharacterExtension (str pName)
 Constructor.
 
 AddObjectProperties (FBComponent pObj)
 Add TR Properties from Object.
 
 FBDelete ()
 Virtual FBDelete function.
 
FBCharacter GetCharacter ()
 Return the attached Character.
 
FBComponent GetExtensionObjectWithLabelName (str pLabelName)
 Find stored object based on label name.
 
 GetLabelNameWithExtensionObject (str pLabelName, FBComponent pObj, bool pReturnObjectNameIfNotFound=False)
 Find the label name that was used to store object pose.
 
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.
 
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).
 
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.
 
 RemoveObjectAndProperties (FBComponent pObj)
 Remove TR Properties from Object.
 
 RemoveRetargetSourceProperty (int pPropIndex)
 Remove the source property for retargeting.
 
 SetRetargetSourceProperty (int pPropIndex, FBProperty pSourceProp)
 Set the source property for retargeting.
 
 SetSourceExtension (FBCharacterExtension pSourceExtension)
 Set the character 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.
 
 UpdateStancePose ()
 Update the stance pose to the current position of the character extension element.
 
- Public Member Functions inherited from FBKeyingGroup
 FBKeyingGroup (str pName, FBKeyingGroupType pType)
 Constructor.
 
 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).
 
 AddProperty (FBProperty pProp)
 Add property to be keyed when current keying group is active.
 
 ClearAllItems ()
 ClearAllItems clear object dependency, properties and child keying group.
 
 DeselectAllAnimatableProperties ()
 FBDeselectAllAnimatableProperties, deselect all animatable properties in the scene.
 
 FBDelete ()
 Virtual FBDelete function.
 
int FindPropertyIndex (FBProperty pProp)
 FindPropertyIndex.
 
FBProperty GetCumulativeProperty (int pIndex, bool pStopAtVisible=False)
 GetCumulativeProperty Same as GetSubKeyingGroup but recursive in child keying group.
 
int GetCumulativePropertyCount (bool pStopAtVisible=False)
 GetCumulativePropertyCount Same as GetSubKeyingGroupCount but recursive in child keying group.
 
FBKeyingGroup GetParentKeyingGroup (int pIndex)
 GetParentKeyingGroup.
 
int GetParentKeyingGroupCount ()
 GetParentKeyingGroupCount.
 
FBProperty GetProperty (int pIndex)
 GetProperty from the keyinggroup list.
 
int GetPropertyCount ()
 GetPropertyCount.
 
FBKeyingGroup GetSubKeyingGroup (int pIndex)
 GetSubKeyingGroup.
 
int GetSubKeyingGroupCount ()
 GetSubKeyingGroupCount.
 
FBComponent GetSubObject (int pIndex)
 GetSubObject.
 
int GetSubObjectCount ()
 GetSubObjectCount.
 
bool IsObjectDependency (FBComponent pObj)
 IsObjectDependency determine if the pObj is a dependency.
 
bool IsObjectDependencySelected ()
 IsObjectDependencySelected.
 
 RemoveAllObjectDependency ()
 IsObjectDependencySelected empty the content list.
 
 RemoveAllProperties ()
 IsObjectDependencySelected empty the property list.
 
 RemoveAllSubKeyingGroup ()
 RemoveAllSubKeyingGroup empty the child keying group.
 
 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).
 
 RemoveProperty (FBProperty pProp)
 RemoveProperty from the keyinggroup list.
 
 SetActive (bool pActive)
 SetActive, activate the keying group, replacing the other keying group.
 
 SetActiveAppend (bool pActive)
 SetActiveAppend, activate and append the keying group to the other keying groups.
 
 SetEnabled (bool pEnable)
 SetEnabled, makes the keying group available in keying group list of the key control UI.
 
 SetObjectType (FBComponent pObject)
 Set the object type filter for and object type keying group.
 
- Public Member Functions inherited from FBComponent
 FBComponent ()
 Constructor.
 
str ClassName ()
 Get the class name.
 
 DisableObjectFlags (FBObjectFlag pFlags)
 Disable a specific Object Flags.
 
 EnableObjectFlags (FBObjectFlag pFlags)
 Enable a specific Object Flags.
 
bool FBCreate ()
 Open Reality Creation function.
 
 FBDelete ()
 Open Reality deletion function.
 
 FBDestroy ()
 Open Reality destruction function.
 
FBObjectFlag GetObjectFlags ()
 Get all Object Flags (concatenated).
 
bool GetObjectStatus (FBObjectStatus pStatus)
 Check to see if an object status is enabled.
 
FBFileReference GetOwnerFileReference (p0)
 Get the owner FileReference object.
 
 HardSelect ()
 HardSelect.
 
bool HasObjectFlags (FBObjectFlag pFlags)
 Check whether a specific object flag is enabled.
 
bool Is (int pTypeId)
 Returns true if object is of type TypeId.
 
bool ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessNamespaceHierarchy.
 
bool ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessObjectNamespace.
 
int PropertyAdd (FBProperty pProperty)
 Add a property to the component's property manager.
 
bool PropertyAddReferenceProperty (FBProperty pReferenceProperty)
 Add a reference property to the component's property manager.
 
FBProperty PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
 Create user or dynamic property.
 
 PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
 Get list of properties which have been modified since last loading.
 
 PropertyRemove (FBProperty pProperty)
 Remove a Property from the component's Property manager.
 
 SetObjectFlags (FBObjectFlag pFlags)
 SetObjectFlags.
 
 SetObjectStatus (FBObjectStatus pStatus, bool pValue)
 Enable/Disable a specific Object Status.
 

Public Attributes

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.

 
- Public Attributes inherited from FBComponent
FBListComponent Components
 List: List of components.

 
str LongName
 Read Write Property: Name and namespace for object.

 
str Name
 Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
 
FBListComponent Parents
 List: Parents.

 
FBManager PropertyList
 Read Only Property: Manages all of the properties for the component.

 
bool Selected
 Read Write Property: Selected property.

 
int TypeInfo
 Contains the Type information of the object.

 
- Public Attributes inherited from FBPlug
str ClassGroupName
 ClassGroupName of the object.

 
int TypeInfo
 TypeInfo.

 

Detailed Description

Objects Grouping class.


This class is an interface to manipulate object's grouping in the scene.

See sample: CreateCharacterExtensionOnSelectedObject.py.

Constructor & Destructor Documentation

◆ FBCharacterExtension()

Constructor.

Parameters
pNameGroup name.

Member Function Documentation

◆ AddObjectProperties()

AddObjectProperties ( FBComponent  pObj)

Add TR Properties from Object.

Parameters
pObjObject to add TR properties.

◆ FBDelete()

FBDelete ( )

Virtual FBDelete function.

See sample: DeleteHierarchy.py.

◆ GetCharacter()

FBCharacter GetCharacter ( )

Return the attached Character.

Returns
attached Character.

◆ GetExtensionObjectWithLabelName()

FBComponent GetExtensionObjectWithLabelName ( str  pLabelName)

Find stored object based on label name.

Parameters
pLabelNameThe label name.
Returns
The extension object.

◆ GetLabelNameWithExtensionObject()

GetLabelNameWithExtensionObject ( str  pLabelName,
FBComponent  pObj,
bool  pReturnObjectNameIfNotFound = False 
)

Find the label name that was used to store object pose.

Parameters
pLabelNameThe label name that was used to store object pose.
pObjThe extension object.
pReturnObjectNameIfNotFoundIf 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.

◆ GetMirrorExtension()

FBCharacterExtension GetMirrorExtension ( )

Return the character extension determined by MirrorLabel.

Returns
character extension determined by MirrorLabel.

◆ GetRetargetPropertyCount()

int GetRetargetPropertyCount ( )

Return the total number of retarget properties.

Returns
The total number of retarget properties.

◆ GetRetargetReferenceProperty()

FBProperty GetRetargetReferenceProperty ( int  pPropIndex)

Return the reference property of the given index.

Parameters
pPropIndexIndex to query.
Returns
Reference property of the given index.

◆ GetRetargetSourceProperty()

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).

Parameters
pPropIndexIndex to query.
Returns
Source property (the property that drives the reference property during retargeting) of the given index.

◆ GetSourceExtension()

FBCharacterExtension GetSourceExtension ( )

Return the character extension that is used to drive this extension during retargeting.

Returns
The character extension that is used to drive this extension during retargeting.

◆ GetSourceExtensionIndex()

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.

Returns
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.

◆ GetStancePose()

FBObjectPose GetStancePose ( )

Return stance pose.

Returns
stance pose.

◆ GoToStancePose()

GoToStancePose ( )

Reset object position to the stance.

◆ IsElementSelected()

bool IsElementSelected ( )

Return true if one object in object dependency list is selected.

Returns
true if one object in object dependency list is selected.

◆ IsPropertyIncluded()

bool IsPropertyIncluded ( FBProperty  pProp)

Return true if the property is in character extension.

Parameters
pPropProperty to check.
Returns
true if the property is in character extension.

◆ RemoveObjectAndProperties()

RemoveObjectAndProperties ( FBComponent  pObj)

Remove TR Properties from Object.

Parameters
pObjObject to remove TR properties.

◆ RemoveRetargetSourceProperty()

RemoveRetargetSourceProperty ( int  pPropIndex)

Remove the source property for retargeting.

Only applicable if RetargetMode is Manually Assign.

Parameters
pPropIndexIndex to remove.
Remarks
Only applicable if RetargetMode is Manually Assign.

◆ SetRetargetSourceProperty()

SetRetargetSourceProperty ( int  pPropIndex,
FBProperty  pSourceProp 
)

Set the source property for retargeting.

Only applicable if RetargetMode is Manually Assign.

Parameters
pPropIndexIndex to set.
pSourcePropSource property to set.
Remarks
Only applicable if RetargetMode is Manually Assign.

◆ SetSourceExtension()

SetSourceExtension ( FBCharacterExtension  pSourceExtension)

Set the character extension to drive this extension during retargeting.

Only applicable if RetargetMode is Assign.

Parameters
pSourceExtensionThe source extension to drive this extension during retargeting.
Remarks
Only applicable if RetargetMode is Assign.

◆ SetSourceExtensionIndex()

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.

Parameters
pSrcExtIndexEnum 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.
Remarks
Only applicable if RetargetMode is Manually Assign.

◆ UpdateStancePose()

UpdateStancePose ( )

Update the stance pose to the current position of the character extension element.

Member Data Documentation

◆ IncludePartInBodyPart

bool IncludePartInBodyPart

Read Write Property: Include or not this extension when the Body Part mode is active.

◆ IncludePartInFullBody

bool IncludePartInFullBody

Read Write Property: Include or not this extension when the Full Body mode is active.

◆ Label

str Label

Read Write Property: The logical name of the extension, use for mirroring.

◆ MirrorLabel

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.

◆ PlotAllowed

FBPlotAllowed PlotAllowed

Read Write Property: Controls if objects in the set are transformable.

◆ ReferenceModel

FBModel ReferenceModel

Read Write Property: Controls the referential of the extension.

◆ RetargetMode

Read Write Property: Character extension retarget mode.

◆ StancePoseMode

Read Write Property: Character extension stance pose mode.

◆ SyncActivationAndVisibilityMode

FBSyncActivationAndVisibilityMode SyncActivationAndVisibilityMode

Read Write Property: The "Sync Activation & Visibility" mode.