Animates a character face using an actor as input.
These classes are under development and may change dramatically between versions.
Public Member Functions | |
__init__ (str pName, object pObject=None) | |
Constructor. | |
IObject_Declare (K_IMPLEMENTATION) | |
bool | PlotAnimation () |
Plot the animation of the character face. | |
FBDelete () | |
Actual Character Face destructor. | |
GotoRest () | |
Set the character face back to its rest shape. | |
bool | ShapeGroupAdd (tuple pList, str pName=None) |
Add a blendshape model group containing models. | |
bool | ShapeGroupRemove (int pShapeGrpId) |
Remove a blendshape model group. | |
int | ShapeGroupFindByName (str pName) |
Find a blendshape group by name. | |
int | ShapeGroupGetCount () |
Retrieve the total number of blendshape groups on this character face. | |
str | ShapeGroupGetName (int pShapeGrpId) |
Retrieve the name of a blendshape group. | |
bool | ShapeGroupSetName (int pShapeGrpId, str pName) |
Set the name of a blendshape group. | |
int | ShapeFindByName (int pShapeGrpId, str pName) |
Find a shape in a blendshape group by name. | |
int | ShapeGetCount (int pShapeGrpId) |
Retrieve the total number of shapes in a blendshape group. | |
str | ShapeGetName (int pShapeGrpId, int pShapeId) |
Retrieve the name of the shape in a blendshape group. | |
bool | ShapeSetName (int pShapeGrpId, int pShapeId, str pName) |
Set the name of the shape in a blendshape group. | |
int | ClusterGroupAdd (tuple pList, str pName=None) |
Add a cluster group to the character face. | |
bool | ClusterGroupRemove (int pClusterGrpId) |
Remove a cluster group from the character face. | |
int | ClusterGroupFindByName (str pName) |
Find a cluster group by name. | |
int | ClusterGroupGetCount () |
Retrieve the total number of cluster groups. | |
str | ClusterGroupGetName (int pClusterGrpId) |
Retrieve the name of a cluster group. | |
bool | ClusterGroupSetName (int pClusterGrpId, str 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, str pName=None) |
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, str 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. | |
str | ClusterShapeGetName (int pClusterGrpId, int pClusterShapeId) |
Retrieve the name of a shape in a cluster group. | |
bool | ClusterShapeSetName (int pClusterGrpId, int pClusterShapeId, str 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 (str pName) |
Add an expression to the face. | |
bool | ExpressionRemove (int pExpressionId) |
Remove an expression from the face. | |
int | ExpressionFindByName (str pName) |
Find an expression on the face by name. | |
int | ExpressionGetCount () |
Retrieve the total number of expressions on the face. | |
str | ExpressionGetName (int pExpressionId) |
Retrieve the name of an expression. | |
bool | ExpressionSetName (int pExpressionId, str 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. | |
FBPropertyBase | ActiveInput |
Read Write Property: Is the character input active?. |
Constructor.
pName | Name of new character. |
pObject | For internal use only. This parameter does not need to be specified by the developer. |
Reimplemented from FBConstraint.
IObject_Declare | ( | K_IMPLEMENTATION | ) |
Reimplemented from FBConstraint.
bool PlotAnimation | ( | ) |
Plot the animation of the character face.
FBDelete | ( | ) |
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 | ( | ) |
Set the character face back to its rest shape.
Add a blendshape model group containing models.
pList | List of models to be associated with this blendshape group. |
pName | Optional name for this model group. |
Remove a blendshape model group.
pShapeGrpId | Index of the blendshape group to remove. |
Find a blendshape group by name.
pName | Name to search for. |
int ShapeGroupGetCount | ( | ) |
Retrieve the total number of blendshape groups on this character face.
Retrieve the name of a blendshape group.
pShapeGrpId | Index of the blendshape group to query. |
Set the name of a blendshape group.
pShapeGrpId | Index of the blendshape group to modify. |
pName | Name to set on the blendshape group. |
Find a shape in a blendshape group by name.
pShapeGrpId | Index of the blendshape group to search. |
pName | Name to search for. |
Retrieve the total number of shapes in a blendshape group.
pShapeGrpId | Index of the blendshape group to query. |
Retrieve the name of the shape in a blendshape group.
pShapeGrpId | Index of the blendshape group to query. |
pShapeId | Index of the shape in the blendshape group to query. |
Set the name of the shape in a blendshape group.
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. |
Add a cluster group to the character face.
pList | List of clusters to add to this group. |
pName | Optional name to assign to this cluster group. |
Remove a cluster group from the character face.
pClusterGrpId | Index of the cluster group to remove. |
Find a cluster group by name.
pName | Name to search for on the face. |
int ClusterGroupGetCount | ( | ) |
Retrieve the total number of cluster groups.
Retrieve the name of a cluster group.
pClusterGrpId | Index of the cluster group to query. |
Set the name of a cluster group.
pClusterGrpId | Index of the cluster group to modify. |
pName | New name for the cluster group. |
Set a cluster group's rest pose to the current pose.
pClusterGrpId | Index of the cluster group to modify. |
Add a cluster shape to a cluster group.
pClusterGrpId | Index of the cluster group to modify. |
pName | Optional name to assign to the shape. |
Remove a cluster shape from a cluster group.
pClusterGrpId | Index of the cluster group to modify. |
pClusterShapeId | Index of the shape in the cluster group to remove. |
Find a cluster shape in a cluster group by name.
pClusterGrpId | Index of the cluster group to search. |
pName | Name to search for in the cluster group. |
Retrieve the total number of shapes in a cluster group.
pClusterGrpId | Index of the cluster group to query. |
Retrieve the name of a shape in a cluster group.
pClusterGrpId | Index of the cluster group to query. |
pClusterShapeId | Index of the cluster shape to query. |
Set the name of a shape in a cluster group.
pClusterGrpId | Index of the cluster group to modify. |
pClusterShapeId | Index of the cluster shape to modify. |
pName | Name to assign to the cluster shape. |
Record the current pose of the cluster group to a cluster shape.
pClusterGrpId | Index of the cluster group to record. |
pClusterShapeId | Index of the cluster shape to record the pose. |
Add an expression to the face.
pName | Optional name to assign to the new expression. |
Remove an expression from the face.
pExpressionId | Index of the expression to remove. |
Find an expression on the face by name.
pName | Name of the expression to search for. |
int ExpressionGetCount | ( | ) |
Retrieve the total number of expressions on the face.
Retrieve the name of an expression.
pExpressionId | Index of the expression to query. |
Set the name of an expression.
pExpressionId | Index of the expression to modify. |
pName | Name to assign to the expression. |
Assign the weight of a shape to an expression.
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. Valid range of [0.0, 1.0]. |
FBPropertyActorFace InputActorFace |
Read Write Property: The index of the actor used for the input.
FBPropertyBase ActiveInput |
Read Write Property: Is the character input active?.