Objects Grouping class. More...
#include <fbcharacterextension.h>
Public Member Functions | |
FBCharacterExtension (const char *pName, HIObject pObject=NULL) | |
Constructor. More... | |
virtual void | FBDelete () override |
Virtual FBDelete function. More... | |
void | UpdateStancePose () |
Update the stance pose to the current position of the character extension element. More... | |
void | GoToStancePose () |
Reset object position to the stance. More... | |
FBObjectPose * | GetStancePose () |
Return stance pose. More... | |
FBCharacterExtension * | GetMirrorExtension () |
Return the character extension determined by MirrorLabel. More... | |
FBCharacter * | GetCharacter () |
Return the attached Character. More... | |
void | AddObjectProperties (FBComponent *pObj) |
Add TR Properties from Object. More... | |
void | RemoveObjectAndProperties (FBComponent *pObj) |
Remove TR Properties from Object. 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... | |
void | GetLabelNameWithExtensionObject (FBString &pLabelName, FBComponent *pObj, bool pReturnObjectNameIfNotFound=false) |
Find the label name that was used to store object pose. More... | |
FBComponent * | GetExtensionObjectWithLabelName (const FBString &pLabelName) |
Find stored object based on label name. More... | |
FBCharacterExtension * | GetSourceExtension () |
Return the character extension that is used to drive this extension during retargeting. More... | |
void | SetSourceExtension (FBCharacterExtension *pSourceExtension) |
Set the character extension 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... | |
void | 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... | |
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... | |
void | SetRetargetSourceProperty (int pPropIndex, FBProperty *pSourceProp) |
Set the source property for retargeting. More... | |
void | RemoveRetargetSourceProperty (int pPropIndex) |
Remove the source property for retargeting. More... | |
void | RetargetAnimation (FBEvaluateInfo *pEvalInfo) |
RetargetAnimation. More... | |
![]() | |
FBKeyingGroup (const char *pName, FBKeyingGroupType pType, HIObject pObject=NULL) | |
Constructor. More... | |
void | SetObjectType (FBComponent *pObject) |
Set the object type filter for and object type keying group. More... | |
void | AddProperty (FBProperty *pProp) |
Add property to be keyed when current keying group is active. More... | |
void | RemoveProperty (FBProperty *pProp) |
RemoveProperty from the keyinggroup list. More... | |
FBProperty * | GetProperty (int pIndex) |
GetProperty from the keyinggroup list. More... | |
int | GetPropertyCount () |
GetPropertyCount. More... | |
int | FindPropertyIndex (FBProperty *pProp) |
FindPropertyIndex. More... | |
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). More... | |
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). More... | |
bool | IsObjectDependency (FBComponent *pObj) |
IsObjectDependency determine if the pObj is a dependency. More... | |
bool | IsObjectDependencySelected () |
IsObjectDependencySelected. More... | |
void | RemoveAllProperties () |
IsObjectDependencySelected empty the property list. More... | |
void | RemoveAllObjectDependency () |
IsObjectDependencySelected empty the content list. More... | |
void | RemoveAllSubKeyingGroup () |
RemoveAllSubKeyingGroup empty the child keying group. More... | |
int | GetParentKeyingGroupCount () |
GetParentKeyingGroupCount. More... | |
FBKeyingGroup * | GetParentKeyingGroup (int pIndex) |
GetParentKeyingGroup. More... | |
int | GetSubKeyingGroupCount () |
GetSubKeyingGroupCount. More... | |
FBKeyingGroup * | GetSubKeyingGroup (int pIndex) |
GetSubKeyingGroup. More... | |
int | GetSubObjectCount () |
GetSubObjectCount. More... | |
FBComponent * | GetSubObject (int pIndex) |
GetSubObject. More... | |
int | GetCumulativePropertyCount (bool pStopAtVisible=false) |
GetCumulativePropertyCount Same as GetSubKeyingGroupCount but recursive in child keying group. More... | |
FBProperty * | GetCumulativeProperty (int pIndex, bool pStopAtVisible=false) |
GetCumulativeProperty Same as GetSubKeyingGroup but recursive in child keying group. More... | |
void | ClearAllItems () |
ClearAllItems clear object dependency, properties and child keying group. More... | |
void | SetEnabled (bool pEnable) |
SetEnabled, makes the keying group available in keying group list of the key control UI. More... | |
void | SetActive (bool pActive) |
SetActive, activate the keying group, replacing the other keying group. More... | |
void | SetActiveAppend (bool pActive) |
SetActiveAppend, activate and append the keying group to the other keying groups. More... | |
![]() | |
FBComponent (HIObject pObject) | |
Constructor. More... | |
virtual | ~FBComponent () |
Destructor. More... | |
virtual bool | FBCreate () |
Open Reality Creation function. More... | |
virtual void | FBDestroy () |
Open Reality destruction function. More... | |
virtual bool | SetHIObject (HIObject pObject, bool pSDKComponent) override |
Assign component to an internal pointer. More... | |
virtual 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... | |
void | PropertyRemove (FBProperty *pProperty) |
Remove a Property from the component's Property manager. More... | |
void | PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags) |
Get list of properties which have been modified since last loading. More... | |
FBProperty * | PropertyCreate (const char *pName, FBPropertyType pType, const char *pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL) |
Create user or dynamic property. More... | |
FBObjectFlag | GetObjectFlags () |
Get all Object Flags (concatenated). More... | |
void | SetObjectFlags (FBObjectFlag pFlags) |
SetObjectFlags. More... | |
bool | HasObjectFlags (FBObjectFlag pFlags) |
Check whether a specific object flag is enabled. More... | |
void | EnableObjectFlags (FBObjectFlag pFlags) |
Enable a specific Object Flags. More... | |
void | DisableObjectFlags (FBObjectFlag pFlags) |
Disable a specific Object Flags. More... | |
void | SetObjectStatus (FBObjectStatus pStatus, bool pValue) |
Enable/Disable a specific Object Status. More... | |
bool | GetObjectStatus (FBObjectStatus pStatus) |
Check to see if an object status is enabled. More... | |
bool | ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true) |
ProcessNamespaceHierarchy. More... | |
bool | ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char *pNamespaceName, const char *pReplaceTo=NULL, bool pAddRight=true) |
ProcessObjectNamespace. More... | |
virtual const char * | ClassName () override |
Get the class name. More... | |
virtual bool | UseCustomPropertyViewSet () const |
Use the custom property viewSet or not. More... | |
const char * | GetFullName (void) |
Get the full name. More... | |
void | SetOwnerNamespace (FBNamespace *pOwnerNSObj) |
Set the owner Namespace object. More... | |
FBNamespace * | GetOwnerNamespace (void) |
Get the owner Namespace object. More... | |
FBFileReference * | GetOwnerFileReference (void) |
Get the owner FileReference object. More... | |
void | HardSelect () |
HardSelect. More... | |
virtual bool | Is (int pTypeId) override |
Returns true if object is of type TypeId. More... | |
virtual int | GetTypeId () override |
GetTypeId( int pTypeId ) More... | |
![]() | |
FBScriptWrapper * | GetWrapper () |
Return the wrapper interface of this FBObject. More... | |
void | AddWrapper (FBScriptWrapper *) |
void | RemoveWrapper (FBScriptWrapper *) |
Public Attributes | |
FBPropertyBool | IncludePartInFullBody |
Read Write Property: Include or not this extension when the Full Body mode is active. More... | |
FBPropertyBool | IncludePartInBodyPart |
Read Write Property: Include or not this extension when the Body Part mode is active. More... | |
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... | |
FBPropertySyncActivationAndVisibilityMode | SyncActivationAndVisibilityMode |
Read Write Property: The "Sync Activation & Visibility" mode. More... | |
FBPropertyCharacterExtensionStancePoseMode | StancePoseMode |
Read Write Property: Character extension stance pose mode. More... | |
![]() | |
FBPropertyManager | PropertyList |
Read Only Property: Manages all of the properties for the component. More... | |
FBPropertyListComponent | Components |
List: List of components. More... | |
FBPropertyListComponent | Parents |
List: Parents. More... | |
FBPropertyBool | Selected |
Read Write Property: Selected property. More... | |
FBPropertyString | Name |
Read Write Property: Unique name of object. More... | |
FBPropertyString | LongName |
Read Write Property: Name and namespace for object. More... | |
FBPropertyFolder | Folder |
Read Write Property: The folder that contain this component. More... | |
Additional Inherited Members | |
![]() | |
static void | DeselectAllAnimatableProperties () |
FBDeselectAllAnimatableProperties, deselect all animatable properties in the scene. More... | |
![]() | |
static int | GetInternalClassId () |
static void | FBComponentSetName (FBComponent *pObject, const char *pName) |
static const char * | FBComponentGetName (FBComponent *pObject) |
static void | FBComponentSetLongName (FBComponent *pObject, const char *pName) |
static const char * | FBComponentGetLongName (FBComponent *pObject) |
![]() | |
static int | TypeInfo |
Contains the Type information of the object. More... | |
![]() | |
bool | IsSDKComponent () |
Return whether or not item is an SDK component. More... | |
bool | ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
Add a source connection. More... | |
bool | ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
Add a destination connection. More... | |
bool | ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
Add a source connection. More... | |
bool | ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone) |
Add a destination connection. More... | |
bool | DisconnectDst (FBPlug *pDst) |
Remove a destination connection. More... | |
bool | DisconnectSrc (FBPlug *pSrc) |
Remove a source connection. More... | |
void | DisconnectAllSrc () |
Remove all source connections. More... | |
void | DisconnectAllDst () |
Remove all destination connections. More... | |
bool | DisconnectDstAt (int pIndex) |
Remove a destination connection at a specified index. More... | |
bool | DisconnectSrcAt (int pIndex) |
Remove a source connection at a specified index. More... | |
bool | ReplaceDstAt (int pIndex, FBPlug *pDst) |
Replace a destination connection at a specified index. More... | |
bool | ReplaceSrcAt (int pIndex, FBPlug *pSrc) |
Replace a source connection at a specified index. More... | |
bool | SwapSrc (int pIndexA, int pIndexB) |
Swap source connection at index A with source connection at index B. More... | |
bool | MoveSrcAt (int pIndex, int pAtIndex) |
Move source connection at pIndex to pAtIndex. More... | |
bool | MoveSrcAt (FBPlug *pSrc, FBPlug *pAtSrc) |
Move source connection pSrc to the position of pAtSrc. More... | |
int | GetSrcCount () |
Get source connection count. More... | |
FBPlug * | GetSrc (int pIndex) |
Get a source connection's plug at specified index. More... | |
FBConnectionType | GetSrcType (int pIndex) |
Get a source connection's type at specified index. More... | |
int | GetDstCount () |
Get destination connection count. More... | |
FBPlug * | GetDst (int pIndex) |
Get a destination connection's plug at specified index. More... | |
FBConnectionType | GetDstType (int pIndex) |
Get a destination connection's type at specified index. More... | |
bool | BeginChange () |
Begins a change on multiple plugs. More... | |
void | EndChange () |
Ends a change on multiple plugs. More... | |
void | SetSelfModified (FBPlugModificationFlag pFlag, bool pBool) |
Set the plug's self modification flag. More... | |
bool | GetSelfModified (FBPlugModificationFlag pFlag) |
Tell if the plug's self has changed. More... | |
void | SetContentModified (FBPlugModificationFlag pFlag, bool pBool) |
Set the plug's owned property/object's modification flag. More... | |
bool | GetContentModified (FBPlugModificationFlag pFlag) |
Tell if the plug's content has changed. More... | |
int | GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove) |
Get plug's modified src/dst property/object connection added/removed List. More... | |
bool | RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask) |
Revert the plug's modification to original status. More... | |
void | SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue) |
Set the plug's status flag. More... | |
bool | GetStatusFlag (FBPlugStatusFlag pStatus) const |
Tell if the plug's status has changed. More... | |
FBPlug * | GetOwner () |
Get the owner of this plug. More... | |
FBPlug * | GetOwned (int pIndex) |
Get the owned plug at specified index. More... | |
int | GetOwnedCount () |
Get the owned plug count. More... | |
virtual bool | PlugDataNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0) |
PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More... | |
virtual bool | PlugStateNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0) |
PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More... | |
virtual bool | PlugNotify (FBConnectionAction pAction, FBPlug *pThis, int pIndex, FBPlug *pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL) |
PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More... | |
![]() | |
static int | GetInternalClassId () |
Internal class Id. More... | |
![]() | |
bool | mAllocated |
Contain the Allocation State of the Component. More... | |
HIObject | mObject |
Handle on the Plug. More... | |
bool | mSDKComponent |
bool Plug is an SDK component. More... | |
![]() | |
static const char * | ClassGroupName |
ClassGroupName of the object. More... | |
static int | TypeInfo |
TypeInfo. More... | |
static int | mGlobalTypeInfo |
Represente the Type Index. More... | |
Objects Grouping class.
This class is an interface to manipulate object's grouping in the scene.
Definition at line 127 of file fbcharacterextension.h.
FBCharacterExtension | ( | const char * | pName, |
HIObject | pObject = NULL |
||
) |
Constructor.
pName | Group name. |
pObject | For internal use only. |
void AddObjectProperties | ( | FBComponent * | pObj | ) |
Add TR Properties from Object.
pObj | Object to add TR properties. |
|
overridevirtual |
Virtual FBDelete function.
Reimplemented from FBKeyingGroup.
FBCharacter* GetCharacter | ( | ) |
Return the attached Character.
FBComponent* GetExtensionObjectWithLabelName | ( | const FBString & | pLabelName | ) |
Find stored object based on label name.
pLabelName | The label name. |
void GetLabelNameWithExtensionObject | ( | FBString & | 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.
void 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. |
void RemoveObjectAndProperties | ( | FBComponent * | pObj | ) |
Remove TR Properties from Object.
pObj | Object to remove TR properties. |
void RemoveRetargetSourceProperty | ( | int | pPropIndex | ) |
Remove the source property for retargeting.
Only applicable if RetargetMode is Manually Assign.
pPropIndex | Index to remove. |
void RetargetAnimation | ( | FBEvaluateInfo * | pEvalInfo | ) |
RetargetAnimation.
pEvalInfo | Evaluate info. |
void 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. |
void 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. |
void 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. |
void UpdateStancePose | ( | ) |
Update the stance pose to the current position of the character extension element.
FBPropertyBool IncludePartInBodyPart |
Read Write Property: Include or not this extension when the Body Part mode is active.
Definition at line 147 of file fbcharacterextension.h.
FBPropertyBool IncludePartInFullBody |
Read Write Property: Include or not this extension when the Full Body mode is active.
Definition at line 146 of file fbcharacterextension.h.
FBPropertyString Label |
Read Write Property: The logical name of the extension, use for mirroring.
Definition at line 148 of file fbcharacterextension.h.
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.
Definition at line 149 of file fbcharacterextension.h.
FBPropertyPlotAllowed PlotAllowed |
Read Write Property: Controls if objects in the set are transformable.
Definition at line 150 of file fbcharacterextension.h.
FBPropertyModel ReferenceModel |
Read Write Property: Controls the referential of the extension.
Definition at line 151 of file fbcharacterextension.h.
FBPropertyCharacterExtensionRetargetMode RetargetMode |
Read Write Property: Character extension retarget mode.
Definition at line 152 of file fbcharacterextension.h.
FBPropertyCharacterExtensionStancePoseMode StancePoseMode |
Read Write Property: Character extension stance pose mode.
Definition at line 154 of file fbcharacterextension.h.
FBPropertySyncActivationAndVisibilityMode SyncActivationAndVisibilityMode |
Read Write Property: The "Sync Activation & Visibility" mode.
Definition at line 153 of file fbcharacterextension.h.