Public Member Functions | Public Attributes

FBCharacterFace Class Reference

Search for all occurrences

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.

#include <fbcharacterface.h>

Inheritance diagram for FBCharacterFace:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBCharacterFace (const char *pName, HIObject pObject=NULL)
 Constructor.
 IObject_Declare (K_IMPLEMENTATION)
virtual bool PlotAnimation ()
 Plot the animation of the character face.
virtual void FBDelete ()
 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 containing models.
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.

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?

Constructor & Destructor Documentation

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

Constructor.

Parameters:
pNameName of new character.
pObjectFor internal use only. This parameter does not need to be specified by the developer.

Member Function Documentation

IObject_Declare ( K_IMPLEMENTATION  )
virtual bool PlotAnimation ( ) [virtual]

Plot the animation of the character face.

Returns:
True if the operation completed successfully.
virtual void FBDelete ( ) [virtual]

Actual Character Face destructor.

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

Reimplemented from FBComponent.

void GotoRest ( )

Set the character face back to its rest shape.

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

Add a blendshape model group containing models.

Parameters:
pListList of models to be associated with this blendshape group.
pNameOptional name for this model group.
Returns:
True if the operation completed successfully.
bool ShapeGroupRemove ( int  pShapeGrpId)

Remove a blendshape model group.

Parameters:
pShapeGrpIdIndex of the blendshape group to remove.
Returns:
True if the operation completed successfully.
int ShapeGroupFindByName ( const char *  pName)

Find a blendshape group by name.

Parameters:
pNameName to search for.
Returns:
Index of the blendshape group, -1 if not found.
int ShapeGroupGetCount ( )

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

Returns:
Number of blendshape groups on this character face.
const char* ShapeGroupGetName ( int  pShapeGrpId)

Retrieve the name of a blendshape group.

Parameters:
pShapeGrpIdIndex of the blendshape group to query.
Returns:
Name of the blendshape group.
bool ShapeGroupSetName ( int  pShapeGrpId,
const char *  pName 
)

Set the name of a blendshape group.

Parameters:
pShapeGrpIdIndex of the blendshape group to modify.
pNameName to set on the blendshape group.
Returns:
True if the operation completed successfully.
int ShapeFindByName ( int  pShapeGrpId,
const char *  pName 
)

Find a shape in a blendshape group by name.

Parameters:
pShapeGrpIdIndex of the blendshape group to search.
pNameName to search for.
Returns:
Index of the shape, -1 if not found.
int ShapeGetCount ( int  pShapeGrpId)

Retrieve the total number of shapes in a blendshape group.

Parameters:
pShapeGrpIdIndex of the blendshape group to query.
Returns:
Number of shapes in the specified blendshape group.
const char* ShapeGetName ( int  pShapeGrpId,
int  pShapeId 
)

Retrieve the name of the shape in a blendshape group.

Parameters:
pShapeGrpIdIndex of the blendshape group to query.
pShapeIdIndex of the shape in the blendshape group to query.
Returns:
Name of the specified shape.
bool ShapeSetName ( int  pShapeGrpId,
int  pShapeId,
const char *  pName 
)

Set the name of the shape in a blendshape group.

Parameters:
pShapeGrpIdIndex of the blendshape group to query.
pShapeIdIndex of the shape in the blendshape group to set.
pNameName to set on the shape.
Returns:
True if the operation completed successfully.
int ClusterGroupAdd ( FBModelList pList,
const char *  pName = NULL 
)

Add a cluster group to the character face.

Parameters:
pListList of clusters to add to this group.
pNameOptional name to assign to this cluster group.
Returns:
Index of the new cluster group -1 if the operation failed to complete.
bool ClusterGroupRemove ( int  pClusterGrpId)

Remove a cluster group from the character face.

Parameters:
pClusterGrpIdIndex of the cluster group to remove.
Returns:
True if the operation completed successfully.
int ClusterGroupFindByName ( const char *  pName)

Find a cluster group by name.

Parameters:
pNameName to search for on the face.
Returns:
Index of the matching cluster group. -1 if not found.
int ClusterGroupGetCount ( )

Retrieve the total number of cluster groups.

Returns:
Number of cluster groups on the face.
const char* ClusterGroupGetName ( int  pClusterGrpId)

Retrieve the name of a cluster group.

Parameters:
pClusterGrpIdIndex of the cluster group to query.
Returns:
Name of the specified cluster group.
bool ClusterGroupSetName ( int  pClusterGrpId,
const char *  pName 
)

Set the name of a cluster group.

Parameters:
pClusterGrpIdIndex of the cluster group to modify.
pNameNew name for the cluster group.
Returns:
True of the operation completed successfully.
bool ClusterGroupSnapRest ( int  pClusterGrpId)

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

Parameters:
pClusterGrpIdIndex of the cluster group to modify.
Returns:
True if the operation completed succesfully.
int ClusterShapeAdd ( int  pClusterGrpId,
const char *  pName = NULL 
)

Add a cluster shape to a cluster group.

Parameters:
pClusterGrpIdIndex of the cluster group to modify.
pNameOptional name to assign to the shape.
Returns:
Index of the new shape. -1 if the operation failed to complete.
bool ClusterShapeRemove ( int  pClusterGrpId,
int  pClusterShapeId 
)

Remove a cluster shape from a cluster group.

Parameters:
pClusterGrpIdIndex of the cluster group to modify.
pClusterShapeIdIndex of the shape in the cluster group to remove.
Returns:
True of the operation completed succesfully.
int ClusterShapeFindByName ( int  pClusterGrpId,
const char *  pName 
)

Find a cluster shape in a cluster group by name.

Parameters:
pClusterGrpIdIndex of the cluster group to search.
pNameName to search for in the cluster group.
Returns:
Index of the matching shape. -1 if not found.
int ClusterShapeGetCount ( int  pClusterGrpId)

Retrieve the total number of shapes in a cluster group.

Parameters:
pClusterGrpIdIndex of the cluster group to query.
Returns:
Number of shapes in the specified cluster group.
const char* ClusterShapeGetName ( int  pClusterGrpId,
int  pClusterShapeId 
)

Retrieve the name of a shape in a cluster group.

Parameters:
pClusterGrpIdIndex of the cluster group to query.
pClusterShapeIdIndex of the cluster shape to query.
Returns:
Name of the specified shape.
bool ClusterShapeSetName ( int  pClusterGrpId,
int  pClusterShapeId,
const char *  pName 
)

Set the name of a shape in a cluster group.

Parameters:
pClusterGrpIdIndex of the cluster group to modify.
pClusterShapeIdIndex of the cluster shape to modify.
pNameName to assign to the cluster shape.
Returns:
True if the operation completed successfully.
bool ClusterShapeSnap ( int  pClusterGrpId,
int  pClusterShapeId 
)

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

Parameters:
pClusterGrpIdIndex of the cluster group to record.
pClusterShapeIdIndex of the cluster shape to record the pose.
Returns:
True if the operation completed successfully.
int ExpressionAdd ( const char *  pName)

Add an expression to the face.

Parameters:
pNameOptional name to assign to the new expression.
Returns:
Index of the new expression. -1 if the operation failed to complete.
bool ExpressionRemove ( int  pExpressionId)

Remove an expression from the face.

Parameters:
pExpressionIdIndex of the expression to remove.
Returns:
True if the operation completed successfully.
int ExpressionFindByName ( const char *  pName)

Find an expression on the face by name.

Parameters:
pNameName of the expression to search for.
Returns:
Index of the matching expression. -1 if not found.
int ExpressionGetCount ( )

Retrieve the total number of expressions on the face.

Returns:
Number of expressions on the face.
const char* ExpressionGetName ( int  pExpressionId)

Retrieve the name of an expression.

Parameters:
pExpressionIdIndex of the expression to query.
Returns:
Name of the specified expression.
bool ExpressionSetName ( int  pExpressionId,
const char *  pName 
)

Set the name of an expression.

Parameters:
pExpressionIdIndex of the expression to modify.
pNameName to assign to the expression.
Returns:
True if the operation completed successfully.
bool ExpressionSetShapeWeight ( int  pExpressionId,
int  pGrpId,
int  pShapeId,
float  pValue = 0.0f 
)

Assign the weight of a shape to an expression.

Parameters:
pExpressionIdIndex of the expression to modify.
pGrpIdIndex of the blendshape or cluster group containing the shape of interest.
pShapeIdIndex of the blendshape or cluster shape to weight.
pValueWeight of the shape to assign to this expression. Valid range of [0.0, 1.0].
Returns:
True if the operation completed successfully.

Member Data Documentation

FBPropertyActorFace InputActorFace

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

Definition at line 123 of file fbcharacterface.h.

Read Write Property: Is the character input active?

Definition at line 124 of file fbcharacterface.h.


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

FBCharacterFace FBCharacterFace FBCharacterFace FBCharacterFace FBCharacterFace FBCharacterFace FBCharacterFace FBCharacterFace FBCharacterFace FBCharacterFace
FBCharacterFace FBCharacterFace FBCharacterFace FBCharacterFace FBCharacterFace FBCharacterFace FBCharacterFace FBCharacterFace FBCharacterFace FBCharacterFace