Animates a character face using an actor as input. More...

#include <fbcharacterface.h>

Inheritance diagram for FBCharacterFace:

[legend]

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

	IObject_Declare (override)

virtual bool	PlotAnimation ()
	Plot the animation of the character face.

virtual void	FBDelete () override
	Actual Character Face destructor.

void	GotoRest ()
	Set the character face back to its rest shape.

bool	ShapeGroupAdd (FBModelList pList, const char pName=NULL)
	Add a blendshape model group for each input model.

bool	ShapeGroupRemove (int pShapeGrpId)
	Remove a blendshape model group.

int	ShapeGroupFindByName (const char *pName)
	Find a blendshape group by name.

int	ShapeGroupGetCount ()
	Retrieve the total number of blendshape groups on this character face.

const char *	ShapeGroupGetName (int pShapeGrpId)
	Retrieve the name of a blendshape group.

bool	ShapeGroupSetName (int pShapeGrpId, const char *pName)
	Set the name of a blendshape group.

int	ShapeFindByName (int pShapeGrpId, const char *pName)
	Find a shape in a blendshape group by name.

int	ShapeGetCount (int pShapeGrpId)
	Retrieve the total number of shapes in a blendshape group.

const char *	ShapeGetName (int pShapeGrpId, int pShapeId)
	Retrieve the name of the shape in a blendshape group.

bool	ShapeSetName (int pShapeGrpId, int pShapeId, const char *pName)
	Set the name of the shape in a blendshape group.

int	ClusterGroupAdd (FBModelList pList, const char pName=NULL)
	Add a cluster group to the character face.

bool	ClusterGroupRemove (int pClusterGrpId)
	Remove a cluster group from the character face.

int	ClusterGroupFindByName (const char *pName)
	Find a cluster group by name.

int	ClusterGroupGetCount ()
	Retrieve the total number of cluster groups.

const char *	ClusterGroupGetName (int pClusterGrpId)
	Retrieve the name of a cluster group.

bool	ClusterGroupSetName (int pClusterGrpId, const char *pName)
	Set the name of a cluster group.

bool	ClusterGroupSnapRest (int pClusterGrpId)
	Set a cluster group's rest pose to the current pose.

int	ClusterShapeAdd (int pClusterGrpId, const char *pName=NULL)
	Add a cluster shape to a cluster group.

bool	ClusterShapeRemove (int pClusterGrpId, int pClusterShapeId)
	Remove a cluster shape from a cluster group.

int	ClusterShapeFindByName (int pClusterGrpId, const char *pName)
	Find a cluster shape in a cluster group by name.

int	ClusterShapeGetCount (int pClusterGrpId)
	Retrieve the total number of shapes in a cluster group.

const char *	ClusterShapeGetName (int pClusterGrpId, int pClusterShapeId)
	Retrieve the name of a shape in a cluster group.

bool	ClusterShapeSetName (int pClusterGrpId, int pClusterShapeId, const char *pName)
	Set the name of a shape in a cluster group.

bool	ClusterShapeSnap (int pClusterGrpId, int pClusterShapeId)
	Record the current pose of the cluster group to a cluster shape.

int	ExpressionAdd (const char *pName)
	Add an expression to the face.

bool	ExpressionRemove (int pExpressionId)
	Remove an expression from the face.

int	ExpressionFindByName (const char *pName)
	Find an expression on the face by name.

int	ExpressionGetCount ()
	Retrieve the total number of expressions on the face.

const char *	ExpressionGetName (int pExpressionId)
	Retrieve the name of an expression.

bool	ExpressionSetName (int pExpressionId, const char *pName)
	Set the name of an expression.

bool	ExpressionSetShapeWeight (int pExpressionId, int pGrpId, int pShapeId, float pValue=0.0f)
	Assign the weight of a shape to an expression.

double	ExpressionGetShapeWeight (int pExpressionId, int pGrpId, int pShapeId)
	Retrieve the weight of a shape to an expression.

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

	IObject_Declare (override)

virtual void	ActiveChanged ()
	Notification for Activation Status Change.

virtual void	RemoveAllAnimationNodes ()
	Remove animation nodes.

virtual void	SetupAllAnimationNodes ()
	Setup animation nodes.

virtual void	SnapSuggested ()
	Suggest 'snap'.

virtual void	FreezeSuggested ()
	Suggest 'freeze'.

virtual bool	Disable (FBModel *pModel)
	Disable constraint on pModel.

virtual bool	Enable (FBModel *pModel)
	Enable constraint on pModel.

virtual bool	AnimationNodeNotify (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo, FBConstraintInfo *pConstraintInfo)
	Notification callback for connectors.

FBAnimationNode *	AnimationNodeOutCreate (kReference pUserId, FBModel pModel, const char pAttribute)
	Animation Node Creations (IN/OUT).

FBAnimationNode *	AnimationNodeInCreate (kReference pUserId, FBModel pModel, const char pAttribute)

FBAnimationNode *	AnimationNodeInCreate (kReference pUserId, FBProperty *pProperty)
	Animation Node Creations (IN).

virtual void	SaveModelState (FBModel *pModel, bool pS, bool pR, bool pT)
	Save current state of pModel.

virtual void	RestoreModelState (FBModel *pModel)
	Restore the saved model state onto pModel.

virtual void	FreezeSRT (FBModel *pModel, bool pS, bool pR, bool pT)
	Freeze current model state.

virtual FBConstraint *	Clone ()
	Clone the constraint.

int	ReferenceGroupGetCount ()
	Return the number of reference groups.

int	ReferenceGroupAdd (const char *pGroupName, int pMaxItemCount)
	Add a group of references.

const char *	ReferenceGroupGetName (int pGroupIndex)
	Get the name of the reference group.

int	ReferenceGroupGetMaxCount (int pGroupIndex)
	Get the maximum number of items that can exist in the reference group in question.

FBModel *	ReferenceGet (int pGroupIndex, int pItemIndex=0)
	Get a reference.

int	ReferenceGetCount (int pGroupIndex)
	Get number of references in a specified group.

bool	ReferenceAdd (int pGroupIndex, FBModel *pModel)
	Add a reference to a specified group.

bool	ReferenceRemove (int pGroupIndex, FBModel *pModel)
	Remove a reference to pModel from the group at pGroupIndex.

void	ReferenceRemoveAll ()
	Remove All References.

virtual bool	ReferenceAddNotify (int pGroupIndex, FBModel *pModel)
	Notification callbacks for when a reference is added or removed.

virtual bool	ReferenceRemoveNotify (int pGroupIndex, FBModel *pModel)

virtual bool	DeformerPreNotify (FBModel pModel, FBEvaluateInfo pEvaluateInfo, FBVertex pBBoxMin, FBVertex pBBoxMax)
	Deformation pre-notification function This function pass the evaluation information for deformation (if timing is required).

virtual bool	DeformerNotify (FBModel pModel, const FBVertex pSrcVertex, const FBVertex pSrcNormal, int pCount, FBVertex pDstVertex, FBVertex *pDstNormal)
	Deformation notification function.

virtual bool	DeformerBind (FBModel *pModel)
	Bind/Unbind pModel to deformation constraint.

virtual bool	DeformerUnBind (FBModel *pModel)

virtual bool	FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) override
	Store/Retrieve data to/from FBX files.

virtual bool	FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) override

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

virtual FBAnimationNode *	AnimationNodeInCreate (kReference pUserId, const char pName, const char pDataType, bool pIsPublic=false, double pMin=NULL, double pMax=NULL, bool pUserData=false)
	Creation of IN/OUT Animation Nodes.

virtual FBAnimationNode *	AnimationNodeOutCreate (kReference pUserId, const char pName, const char pDataType, bool pIsPublic=false, double pMin=NULL, double pMax=NULL, bool pUserData=false)

virtual bool	EvaluateAnimationNodes (FBEvaluateInfo *pEvaluateInfo)
	Evaluation of non TRS nodes that needs to be evaluated.

virtual bool	AnimationNodeNotify (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo)
	Notification function for animation thread.

virtual bool	ResolveCandidate (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo)
	Function is call when candidate needs to be resolved (like global to local).

virtual ECandidateAction	SetGlobalCandidate (FBAnimationNode pAnimationNode, double pData, FBEvaluateInfo *pEvaluateInfo)
	Function is call when a global candidate is set on an animation node.

virtual ECandidateAction	SetStdCandidate (FBAnimationNode pAnimationNode, double pData, FBEvaluateInfo *pEvaluateInfo)
	Function is call when a non-global candidate is set on an animation node.

virtual bool	FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)
	Storage/Retrieval of information into the FBX file format.

virtual bool	FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)

virtual bool	AnimationNodeDestroy (FBAnimationNode *pAnimationNode)
	Destroy an animation node.

virtual bool	AnimationNodeIsUserData (FBAnimationNode *pAnimationNode)
	Is the animation node user data?

virtual void	AnimationNodesOutDisableIfNotWritten (FBEvaluateInfo *pEvaluateInfo)
	This call will disable all out animation nodes from being pull by system (animation thread) for given pEvaluateInfo.

virtual FBAnimationNode *	AnimationNodeInGet ()
	Get the (IN/OUT) animation node for this box.

virtual FBAnimationNode *	AnimationNodeOutGet ()

virtual const char *	FbxGetObjectType ()
	Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'.

virtual const char *	FbxGetObjectSubType ()
	Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'.

	IObject_Declare (override)

virtual int	GetOutConnectorCount () const
	Get the number of animation node outputs for this box.

virtual int	GetInConnectorCount () const
	Get the number of animation node inputs for this box.

virtual FBAnimationNode *	GetOutConnector (int pIndex) const
	Get the animation node output associated with the given index.

virtual FBAnimationNode *	GetInConnector (int pIndex) const
	Get the animation node input associated with the given index.

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
FBPropertyActorFace	InputActorFace
	Read Write Property: The index of the actor used for the input.

FBPropertyBool	ActiveInput
	Read Write Property: Is the character input active?

Public Attributes inherited from FBConstraint
FBPropertyBool	Deformer
	Read Write Property: Is a deformer constraint?

FBPropertyBool	HasLayout
	Read Write Property: Does the constraint have a layout?

FBPropertyString	Description
	Read Write Property: Long description of constraint.

FBPropertyBool	Active
	Read Write Property: Active state.

FBPropertyBool	Lock
	Read Write Property: Lock state.

FBPropertyAction	Snap
	Function Property: Snap constraint.

FBPropertyAnimatableDouble	Weight
	Read Write Property: Weight of constraint.

Public Attributes inherited from FBBox
const char *	UniqueName
	internal Unique name.

FBPropertyBool	Animatable
	Read Write Property: Is the box animatable.

FBPropertyBool	Live
	Read Write Property: Is live?

FBPropertyBool	RecordMode
	Read Write Property: Is recording?

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
Public Types inherited from FBBox
enum	ECandidateAction { eCandidateAccept , eCandidateIntercept , eCandidateInterceptAfterEvaluation }
	Resolving action for candidates. More...

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

Animates a character face using an actor as input.

These classes are under development and may change dramatically between versions.

Definition at line 109 of file fbcharacterface.h.

Constructor & Destructor Documentation

◆ FBCharacterFace()

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

Constructor.

Parameters

pName	Name of new character.
pObject	For internal use only. This parameter does not need to be specified by the developer.

Member Function Documentation

◆ ClusterGroupAdd()

int ClusterGroupAdd	(	FBModelList *	pList,
		const char *	pName = `NULL`
	)

Add a cluster group to the character face.

Parameters

pList	List of clusters to add to this group.
pName	Optional name to assign to this cluster group.

Returns: Index of the new cluster group -1 if the operation failed to complete.

◆ ClusterGroupFindByName()

int ClusterGroupFindByName ( const char * pName )

Find a cluster group by name.

Parameters

pName Name to search for on the face.

Returns: Index of the matching cluster group. -1 if not found.

◆ ClusterGroupGetCount()

int ClusterGroupGetCount ( )

Retrieve the total number of cluster groups.

Returns: Number of cluster groups on the face.

◆ ClusterGroupGetName()

const char * ClusterGroupGetName ( int pClusterGrpId )

Retrieve the name of a cluster group.

Parameters

pClusterGrpId Index of the cluster group to query.

Returns: Name of the specified cluster group.

◆ ClusterGroupRemove()

bool ClusterGroupRemove ( int pClusterGrpId )

Remove a cluster group from the character face.

Parameters

pClusterGrpId Index of the cluster group to remove.

Returns: True if the operation completed successfully.

◆ ClusterGroupSetName()

bool ClusterGroupSetName	(	int	pClusterGrpId,
		const char *	pName
	)

Set the name of a cluster group.

Parameters

pClusterGrpId	Index of the cluster group to modify.
pName	New name for the cluster group.

Returns: True of the operation completed successfully.

◆ ClusterGroupSnapRest()

bool ClusterGroupSnapRest ( int pClusterGrpId )

Set a cluster group's rest pose to the current pose.

Parameters

pClusterGrpId Index of the cluster group to modify.

Returns: True if the operation completed succesfully.

◆ ClusterShapeAdd()

int ClusterShapeAdd	(	int	pClusterGrpId,
		const char *	pName = `NULL`
	)

Add a cluster shape to a cluster group.

Parameters

pClusterGrpId	Index of the cluster group to modify.
pName	Optional name to assign to the shape.

Returns: Index of the new shape. -1 if the operation failed to complete.

◆ ClusterShapeFindByName()

int ClusterShapeFindByName	(	int	pClusterGrpId,
		const char *	pName
	)

Find a cluster shape in a cluster group by name.

Parameters

pClusterGrpId	Index of the cluster group to search.
pName	Name to search for in the cluster group.

Returns: Index of the matching shape. -1 if not found.

◆ ClusterShapeGetCount()

int ClusterShapeGetCount ( int pClusterGrpId )

Retrieve the total number of shapes in a cluster group.

Parameters

pClusterGrpId Index of the cluster group to query.

Returns: Number of shapes in the specified cluster group.

◆ ClusterShapeGetName()

const char * ClusterShapeGetName	(	int	pClusterGrpId,
		int	pClusterShapeId
	)

Retrieve the name of a shape in a cluster group.

Parameters

pClusterGrpId	Index of the cluster group to query.
pClusterShapeId	Index of the cluster shape to query.

Returns: Name of the specified shape.

◆ ClusterShapeRemove()

bool ClusterShapeRemove	(	int	pClusterGrpId,
		int	pClusterShapeId
	)

Remove a cluster shape from a cluster group.

Parameters

pClusterGrpId	Index of the cluster group to modify.
pClusterShapeId	Index of the shape in the cluster group to remove.

Returns: True of the operation completed succesfully.

◆ ClusterShapeSetName()

bool ClusterShapeSetName	(	int	pClusterGrpId,
		int	pClusterShapeId,
		const char *	pName
	)

Set the name of a shape in a cluster group.

Parameters

pClusterGrpId	Index of the cluster group to modify.
pClusterShapeId	Index of the cluster shape to modify.
pName	Name to assign to the cluster shape.

Returns: True if the operation completed successfully.

◆ ClusterShapeSnap()

bool ClusterShapeSnap	(	int	pClusterGrpId,
		int	pClusterShapeId
	)

Record the current pose of the cluster group to a cluster shape.

Parameters

pClusterGrpId	Index of the cluster group to record.
pClusterShapeId	Index of the cluster shape to record the pose.

Returns: True if the operation completed successfully.

◆ ExpressionAdd()

int ExpressionAdd ( const char * pName )

Add an expression to the face.

Parameters

pName Optional name to assign to the new expression.

Returns: Index of the new expression. -1 if the operation failed to complete.

◆ ExpressionFindByName()

int ExpressionFindByName ( const char * pName )

Find an expression on the face by name.

Parameters

pName Name of the expression to search for.

Returns: Index of the matching expression. -1 if not found.

◆ ExpressionGetCount()

int ExpressionGetCount ( )

Retrieve the total number of expressions on the face.

Returns: Number of expressions on the face.

◆ ExpressionGetName()

const char * ExpressionGetName ( int pExpressionId )

Retrieve the name of an expression.

Parameters

pExpressionId Index of the expression to query.

Returns: Name of the specified expression.

◆ ExpressionGetShapeWeight()

double ExpressionGetShapeWeight	(	int	pExpressionId,
		int	pGrpId,
		int	pShapeId
	)

Retrieve the weight of a shape to an expression.

Parameters

pExpressionId	Index of the expression.
pGrpId	Index of the blendshape or cluster group containing the shape of interest.
pShapeId	Index of the blendshape or cluster shape.

Returns: Weight of the desired shape to an expression. A weight of 0.0 represents 0%, while a weight of 1.0 represents 100%. Returns 0.0 if the weight cannot be found.

◆ ExpressionRemove()

bool ExpressionRemove ( int pExpressionId )

Remove an expression from the face.

Parameters

pExpressionId Index of the expression to remove.

Returns: True if the operation completed successfully.

◆ ExpressionSetName()

bool ExpressionSetName	(	int	pExpressionId,
		const char *	pName
	)

Set the name of an expression.

Parameters

pExpressionId	Index of the expression to modify.
pName	Name to assign to the expression.

Returns: True if the operation completed successfully.

◆ ExpressionSetShapeWeight()

bool ExpressionSetShapeWeight	(	int	pExpressionId,
		int	pGrpId,
		int	pShapeId,
		float	pValue = `0.0f`
	)

Assign the weight of a shape to an expression.

Parameters

pExpressionId	Index of the expression to modify.
pGrpId	Index of the blendshape or cluster group containing the shape of interest.
pShapeId	Index of the blendshape or cluster shape to weight.
pValue	Weight of the shape to assign to this expression. A weight of 0.0 represents 0%, while a weight of 1.5 represents 150%. The weight cannot be less than 0.0; if so, the weight will be clamped to 0.0.

Returns: True if the operation completed successfully.

◆ FBDelete()

virtual void FBDelete ( )

overridevirtual

Actual Character Face destructor.

This method is used to delete the actual character face object represented by an instance of FBCharacterFace.

Reimplemented from FBComponent.

◆ GotoRest()

void GotoRest ( )

Set the character face back to its rest shape.

◆ PlotAnimation()

virtual bool PlotAnimation ( )

virtual

Plot the animation of the character face.

Returns: True if the operation completed successfully.

◆ ShapeFindByName()

int ShapeFindByName	(	int	pShapeGrpId,
		const char *	pName
	)

Find a shape in a blendshape group by name.

Parameters

pShapeGrpId	Index of the blendshape group to search.
pName	Name to search for.

Returns: Index of the shape, -1 if not found.

◆ ShapeGetCount()

int ShapeGetCount ( int pShapeGrpId )

Retrieve the total number of shapes in a blendshape group.

Parameters

pShapeGrpId Index of the blendshape group to query.

Returns: Number of shapes in the specified blendshape group.

◆ ShapeGetName()

const char * ShapeGetName	(	int	pShapeGrpId,
		int	pShapeId
	)

Retrieve the name of the shape in a blendshape group.

Parameters

pShapeGrpId	Index of the blendshape group to query.
pShapeId	Index of the shape in the blendshape group to query.

Returns: Name of the specified shape.

◆ ShapeGroupAdd()

bool ShapeGroupAdd	(	FBModelList *	pList,
		const char *	pName = `NULL`
	)

Add a blendshape model group for each input model.

Parameters

pList	List of models to create a blendshape model group.
pName	Unused. Instead, use the ShapeGroupGetName member function to set the name of each added blendshape model group individually.

Returns: True if the operation completed successfully, false otherwise.

◆ ShapeGroupFindByName()

int ShapeGroupFindByName ( const char * pName )

Find a blendshape group by name.

Parameters

pName Name to search for.

Returns: Index of the blendshape group, -1 if not found.

◆ ShapeGroupGetCount()

int ShapeGroupGetCount ( )

Retrieve the total number of blendshape groups on this character face.

Returns: Number of blendshape groups on this character face.

◆ ShapeGroupGetName()

const char * ShapeGroupGetName ( int pShapeGrpId )

Retrieve the name of a blendshape group.

Parameters

pShapeGrpId Index of the blendshape group to query.

Returns: Name of the blendshape group.

◆ ShapeGroupRemove()

bool ShapeGroupRemove ( int pShapeGrpId )

Remove a blendshape model group.

Parameters

pShapeGrpId Index of the blendshape group to remove.

Returns: True if the operation completed successfully.

◆ ShapeGroupSetName()

bool ShapeGroupSetName	(	int	pShapeGrpId,
		const char *	pName
	)

Set the name of a blendshape group.

Parameters

pShapeGrpId	Index of the blendshape group to modify.
pName	Name to set on the blendshape group.

Returns: True if the operation completed successfully.

◆ ShapeSetName()

bool ShapeSetName	(	int	pShapeGrpId,
		int	pShapeId,
		const char *	pName
	)

Set the name of the shape in a blendshape group.

Parameters

pShapeGrpId	Index of the blendshape group to query.
pShapeId	Index of the shape in the blendshape group to set.
pName	Name to set on the shape.

Returns: True if the operation completed successfully.

Member Data Documentation

◆ ActiveInput

FBPropertyBool ActiveInput

Read Write Property: Is the character input active?

Definition at line 124 of file fbcharacterface.h.

◆ InputActorFace

FBPropertyActorFace InputActorFace

Read Write Property: The index of the actor used for the input.

Definition at line 123 of file fbcharacterface.h.

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

fbcharacterface.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBCharacterFace()

Member Function Documentation

◆ ClusterGroupAdd()

◆ ClusterGroupFindByName()

◆ ClusterGroupGetCount()

◆ ClusterGroupGetName()

◆ ClusterGroupRemove()

◆ ClusterGroupSetName()

◆ ClusterGroupSnapRest()

◆ ClusterShapeAdd()

◆ ClusterShapeFindByName()

◆ ClusterShapeGetCount()

◆ ClusterShapeGetName()

◆ ClusterShapeRemove()

◆ ClusterShapeSetName()

◆ ClusterShapeSnap()

◆ ExpressionAdd()

◆ ExpressionFindByName()

◆ ExpressionGetCount()

◆ ExpressionGetName()

◆ ExpressionGetShapeWeight()

◆ ExpressionRemove()

◆ ExpressionSetName()

◆ ExpressionSetShapeWeight()

◆ FBDelete()

◆ GotoRest()

◆ PlotAnimation()

◆ ShapeFindByName()

◆ ShapeGetCount()

◆ ShapeGetName()

◆ ShapeGroupAdd()

◆ ShapeGroupFindByName()

◆ ShapeGroupGetCount()

◆ ShapeGroupGetName()

◆ ShapeGroupRemove()

◆ ShapeGroupSetName()

◆ ShapeSetName()

Member Data Documentation

◆ ActiveInput

◆ InputActorFace