FBCharacterExtension Class Reference


Detailed Description

Objects Grouping class.

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

Examples
Tasks/CreateCharacterExtensionOnSelectedObject.py
Inheritance diagram for FBCharacterExtension:

List of all members.

Public Member Functions

 __init__ (str pName, object pObject=None)
 Constructor.
 FBDelete ()
 Virtual FBDelete function.
 UpdateStancePose ()
 GoToStancePose ()
 Update the stance pose to the current position of the character extension element.
FBCharacterExtension GetMirrorExtension ()
 Reset object position to the stance.
FBCharacter GetCharacter ()
 return the character extension determined by MirrorLabel.
 AddObjectProperties (FBComponent pObj)
 Return the attached Character.
 RemoveObjectAndProperties (FBComponent pObj)
 Add TR Properties from Object.
bool IsElementSelected ()
 Remove TR Properties from Object.
bool IsPropertyIncluded (FBProperty pProp)
 return true if one object in object dependency list is selected.
 GetLabelNameWithExtensionObject (str pLabelName, FBComponent pObj, bool pReturnObjectNameIfNotFound=False)
 return true if the property is in character extension.
FBComponent GetExtensionObjectWithLabelName (str pLabelName)
 Find the label name that was used to store object pose.

Public Attributes

FBPropertyBase IncludePartInFullBody
 Read Write Property: Include or not this extension when fullBody is active.
FBPropertyString Label
 Read Write Property: The logical name of the extension, use for mirroring.
FBPropertyBase 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.

Member Function Documentation

__init__ ( str  pName,
object  pObject = None 
)

Constructor.

Parameters:
pNameGroup name.
pObjectFor internal use only.
Examples
Tasks/CreateCharacterExtensionOnSelectedObject.py
FBDelete ( )

Virtual FBDelete function.

Examples
Tasks/DeleteHierarchy.py

Reimplemented from FBKeyingGroup.

UpdateStancePose ( )
GoToStancePose ( )

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

FBCharacterExtension GetMirrorExtension ( )

Reset object position to the stance.

FBCharacter GetCharacter ( )

return the character extension determined by MirrorLabel.

AddObjectProperties ( FBComponent  pObj)

Return the attached Character.

RemoveObjectAndProperties ( FBComponent  pObj)

Add TR Properties from Object.

bool IsElementSelected ( )

Remove TR Properties from Object.

bool IsPropertyIncluded ( FBProperty  pProp)

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

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

return true if the property is in character extension.

FBComponent GetExtensionObjectWithLabelName ( str  pLabelName)

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


Member Data Documentation

FBPropertyBase IncludePartInFullBody

Read Write Property: Include or not this extension when fullBody is active.

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

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


FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension
FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension