Objects Grouping class. More...

#include <fbcharacterextension.h>

Inheritance diagram for FBCharacterExtension:

[legend]

Public Member Functions
	FBCharacterExtension (const char *pName, HIObject pObject=NULL)
	Constructor.

virtual void	FBDelete () override
	Virtual FBDelete function.

void	UpdateStancePose ()
	Update the stance pose to the current position of the character extension element.

void	GoToStancePose ()
	Reset object position to the stance.

FBObjectPose *	GetStancePose ()
	Return stance pose.

FBCharacterExtension *	GetMirrorExtension ()
	Return the character extension determined by MirrorLabel.

FBCharacter *	GetCharacter ()
	Return the attached Character.

void	AddObjectProperties (FBComponent *pObj)
	Add TR Properties from Object.

void	RemoveObjectAndProperties (FBComponent *pObj)
	Remove TR Properties from Object.

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.

void	GetLabelNameWithExtensionObject (FBString &pLabelName, FBComponent *pObj, bool pReturnObjectNameIfNotFound=false)
	Find the label name that was used to store object pose.

FBComponent *	GetExtensionObjectWithLabelName (const FBString &pLabelName)
	Find stored object based on label name.

FBCharacterExtension *	GetSourceExtension ()
	Return the character extension that is used to drive this extension during retargeting.

void	SetSourceExtension (FBCharacterExtension *pSourceExtension)
	Set the character extension 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.

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.

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

void	SetRetargetSourceProperty (int pPropIndex, FBProperty *pSourceProp)
	Set the source property for retargeting.

void	RemoveRetargetSourceProperty (int pPropIndex)
	Remove the source property for retargeting.

void	RetargetAnimation (FBEvaluateInfo *pEvalInfo)
	RetargetAnimation.

Public Member Functions inherited from FBKeyingGroup
	FBKeyingGroup (const char *pName, FBKeyingGroupType pType, HIObject pObject=NULL)
	Constructor.

virtual void	FBDelete () override
	Virtual FBDelete function.

void	SetObjectType (FBComponent *pObject)
	Set the object type filter for and object type keying group.

void	AddProperty (FBProperty *pProp)
	Add property to be keyed when current keying group is active.

void	RemoveProperty (FBProperty *pProp)
	RemoveProperty from the keyinggroup list.

FBProperty *	GetProperty (int pIndex)
	GetProperty from the keyinggroup list.

int	GetPropertyCount ()
	GetPropertyCount.

int	FindPropertyIndex (FBProperty *pProp)
	FindPropertyIndex.

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

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

bool	IsObjectDependency (FBComponent *pObj)
	IsObjectDependency determine if the `pObj` is a dependency.

bool	IsObjectDependencySelected ()
	IsObjectDependencySelected.

void	RemoveAllProperties ()
	IsObjectDependencySelected empty the property list.

void	RemoveAllObjectDependency ()
	IsObjectDependencySelected empty the content list.

void	RemoveAllSubKeyingGroup ()
	RemoveAllSubKeyingGroup empty the child keying group.

int	GetParentKeyingGroupCount ()
	GetParentKeyingGroupCount.

FBKeyingGroup *	GetParentKeyingGroup (int pIndex)
	GetParentKeyingGroup.

int	GetSubKeyingGroupCount ()
	GetSubKeyingGroupCount.

FBKeyingGroup *	GetSubKeyingGroup (int pIndex)
	GetSubKeyingGroup.

int	GetSubObjectCount ()
	GetSubObjectCount.

FBComponent *	GetSubObject (int pIndex)
	GetSubObject.

int	GetCumulativePropertyCount (bool pStopAtVisible=false)
	GetCumulativePropertyCount Same as GetSubKeyingGroupCount but recursive in child keying group.

FBProperty *	GetCumulativeProperty (int pIndex, bool pStopAtVisible=false)
	GetCumulativeProperty Same as GetSubKeyingGroup but recursive in child keying group.

void	ClearAllItems ()
	ClearAllItems clear object dependency, properties and child keying group.

void	SetEnabled (bool pEnable)
	SetEnabled, makes the keying group available in keying group list of the key control UI.

void	SetActive (bool pActive)
	SetActive, activate the keying group, replacing the other keying group.

void	SetActiveAppend (bool pActive)
	SetActiveAppend, activate and append the keying group to the other keying groups.

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor.

virtual	~FBComponent ()
	Destructor.

virtual bool	FBCreate ()
	Open Reality Creation function.

virtual void	FBDestroy ()
	Open Reality destruction function.

virtual void	FBDelete () override
	Open Reality deletion function.

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer.

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

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager.

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace.

virtual const char *	ClassName () override
	Get the class name.

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not.

const char *	GetFullName (void)
	Get the full name.

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object.

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object.

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object.

void	HardSelect ()
	HardSelect.

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId.

virtual int	GetTypeId () override
	GetTypeId( int pTypeId )

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject.

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.

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

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.

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

FBPropertyCharacterExtensionStancePoseMode	StancePoseMode
	Read Write Property: Character extension stance pose mode.

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

FBPropertyListComponent	Components
	List: List of components.

FBPropertyListComponent	Parents
	List: Parents.

FBPropertyBool	Selected
	Read Write Property: Selected property.

FBPropertyString	Name
	Read Write Property: Unique name of object.

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

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component.

Additional Inherited Members
Static Public Member Functions inherited from FBKeyingGroup
static void	DeselectAllAnimatableProperties ()
	FBDeselectAllAnimatableProperties, deselect all animatable properties in the scene.

Static Public Member Functions inherited from FBComponent
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 Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object.

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component.

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection.

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection.

void	DisconnectAllSrc ()
	Remove all source connections.

void	DisconnectAllDst ()
	Remove all destination connections.

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index.

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index.

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index.

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index.

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B.

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex.

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc.

int	GetSrcCount ()
	Get source connection count.

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index.

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index.

int	GetDstCount ()
	Get destination connection count.

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index.

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index.

bool	BeginChange ()
	Begins a change on multiple plugs.

void	EndChange ()
	Ends a change on multiple plugs.

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag.

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed.

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag.

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed.

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List.

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status.

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag.

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed.

FBPlug *	GetOwner ()
	Get the owner of this plug.

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index.

int	GetOwnedCount ()
	Get the owned plug count.

virtual const char *	ClassName ()
	internal System vars.

virtual bool	Is (int pTypeId)
	Is( int pTypeId )

virtual int	GetTypeId ()
	GetTypeId( int pTypeId )

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.

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.

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.

virtual void	FBDelete ()
	Actual destructor for a FBPlug.

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id.

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component.

HIObject	mObject
	Handle on the Plug.

bool	mSDKComponent
	bool Plug is an SDK component.

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object.

static int	TypeInfo
	TypeInfo.

static int	mGlobalTypeInfo
	Represente the Type Index.

Detailed Description

Objects Grouping class.

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

Definition at line 127 of file fbcharacterextension.h.

Constructor & Destructor Documentation

◆ FBCharacterExtension()

FBCharacterExtension	(	const char *	pName,
		HIObject	pObject = `NULL`
	)

Constructor.

Parameters

pName	Group name.
pObject	For internal use only.

Member Function Documentation

◆ AddObjectProperties()

void AddObjectProperties ( FBComponent * pObj )

Add TR Properties from Object.

Parameters

pObj	Object to add TR properties.

◆ FBDelete()

virtual void FBDelete ( )

overridevirtual

Virtual FBDelete function.

Reimplemented from FBKeyingGroup.

◆ GetCharacter()

FBCharacter * GetCharacter ( )

Return the attached Character.

Returns: attached Character.

◆ GetExtensionObjectWithLabelName()

FBComponent * GetExtensionObjectWithLabelName ( const FBString & pLabelName )

Find stored object based on label name.

Parameters

pLabelName The label name.

Returns: The extension object.

◆ GetLabelNameWithExtensionObject()

void GetLabelNameWithExtensionObject	(	FBString &	pLabelName,
		FBComponent *	pObj,
		bool	pReturnObjectNameIfNotFound = `false`
	)

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

Parameters

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.

◆ 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

pPropIndex Index 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

pPropIndex Index 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()

void 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

pProp Property to check.

Returns: true if the property is in character extension.

◆ RemoveObjectAndProperties()

void RemoveObjectAndProperties ( FBComponent * pObj )

Remove TR Properties from Object.

Parameters

pObj	Object to remove TR properties.

◆ RemoveRetargetSourceProperty()

void RemoveRetargetSourceProperty ( int pPropIndex )

Remove the source property for retargeting.

Only applicable if RetargetMode is Manually Assign.

Remarks: Only applicable if RetargetMode is Manually Assign.

Parameters

pPropIndex Index to remove.

◆ RetargetAnimation()

void RetargetAnimation ( FBEvaluateInfo * pEvalInfo )

RetargetAnimation.

Parameters

pEvalInfo Evaluate info.

◆ SetRetargetSourceProperty()

void SetRetargetSourceProperty	(	int	pPropIndex,
		FBProperty *	pSourceProp
	)

Set the source property for retargeting.

Only applicable if RetargetMode is Manually Assign.

Remarks: Only applicable if RetargetMode is Manually Assign.

Parameters

pPropIndex	Index to set.
pSourceProp	Source property to set.

◆ SetSourceExtension()

void SetSourceExtension ( FBCharacterExtension * pSourceExtension )

Set the character extension to drive this extension during retargeting.

Only applicable if RetargetMode is Assign.

Remarks: Only applicable if RetargetMode is Assign.

Parameters

pSourceExtension The source extension to drive this extension during retargeting.

◆ SetSourceExtensionIndex()

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.

Remarks: Only applicable if RetargetMode is Manually Assign.

Parameters

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

void UpdateStancePose ( )

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

Member Data Documentation

◆ IncludePartInBodyPart

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.

◆ IncludePartInFullBody

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.

◆ Label

FBPropertyString Label

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

Definition at line 148 of file fbcharacterextension.h.

◆ MirrorLabel

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.

◆ PlotAllowed

FBPropertyPlotAllowed PlotAllowed

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

Definition at line 150 of file fbcharacterextension.h.

◆ ReferenceModel

FBPropertyModel ReferenceModel

Read Write Property: Controls the referential of the extension.

Definition at line 151 of file fbcharacterextension.h.

◆ RetargetMode

FBPropertyCharacterExtensionRetargetMode RetargetMode

Read Write Property: Character extension retarget mode.

Definition at line 152 of file fbcharacterextension.h.

◆ StancePoseMode

FBPropertyCharacterExtensionStancePoseMode StancePoseMode

Read Write Property: Character extension stance pose mode.

Definition at line 154 of file fbcharacterextension.h.

◆ SyncActivationAndVisibilityMode

FBPropertySyncActivationAndVisibilityMode SyncActivationAndVisibilityMode

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

Definition at line 153 of file fbcharacterextension.h.

The documentation for this class was generated from the following file:

fbcharacterextension.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBCharacterExtension()

Member Function Documentation

◆ AddObjectProperties()

◆ FBDelete()

◆ GetCharacter()

◆ GetExtensionObjectWithLabelName()

◆ GetLabelNameWithExtensionObject()

◆ GetMirrorExtension()

◆ GetRetargetPropertyCount()

◆ GetRetargetReferenceProperty()

◆ GetRetargetSourceProperty()

◆ GetSourceExtension()

◆ GetSourceExtensionIndex()

◆ GetStancePose()

◆ GoToStancePose()

◆ IsElementSelected()

◆ IsPropertyIncluded()

◆ RemoveObjectAndProperties()

◆ RemoveRetargetSourceProperty()

◆ RetargetAnimation()

◆ SetRetargetSourceProperty()

◆ SetSourceExtension()

◆ SetSourceExtensionIndex()

◆ UpdateStancePose()

Member Data Documentation

◆ IncludePartInBodyPart

◆ IncludePartInFullBody

◆ Label

◆ MirrorLabel

◆ PlotAllowed

◆ ReferenceModel

◆ RetargetMode

◆ StancePoseMode

◆ SyncActivationAndVisibilityMode