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.

Inheritance diagram for FBCharacterFace:

List of all members.

Public Member Functions
	__init__ (str pName, object pObject=None)
	Constructor.
	IObject_Declare (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?.

---

Member Function Documentation

__init__	(	str	pName,
		object	pObject = None
	)

Search for all occurrences

Constructor.

Parameters:

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

(

Implementation

)

Search for all occurrences

Reimplemented from FBConstraint.

bool PlotAnimation

(

)

Search for all occurrences

Plot the animation of the character face.

Returns:

True if the operation completed successfully.

FBDelete

(

)

Search for all occurrences

Actual Character Face destructor.

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

Examples

Tasks/DeleteHierarchy.py

Reimplemented from FBComponent.

GotoRest

(

)

Search for all occurrences

Set the character face back to its rest shape.

bool ShapeGroupAdd	(	tuple	pList,
		str	pName = None
	)

Search for all occurrences

Add a blendshape model group containing models.

Parameters:

pList	List of models to be associated with this blendshape group.
pName	Optional name for this model group.

Returns:

True if the operation completed successfully.

bool ShapeGroupRemove

(

int

pShapeGrpId

)

Search for all occurrences

Remove a blendshape model group.

Parameters:

pShapeGrpId

Index of the blendshape group to remove.

Returns:

True if the operation completed successfully.

int ShapeGroupFindByName

(

str

pName

)

Search for all occurrences

Find a blendshape group by name.

Parameters:

pName

Name to search for.

Returns:

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

int ShapeGroupGetCount

(

)

Search for all occurrences

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

Returns:

Number of blendshape groups on this character face.

str ShapeGroupGetName

(

int

pShapeGrpId

)

Search for all occurrences

Retrieve the name of a blendshape group.

Parameters:

pShapeGrpId

Index of the blendshape group to query.

Returns:

Name of the blendshape group.

bool ShapeGroupSetName	(	int	pShapeGrpId,
		str	pName
	)

Search for all occurrences

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.

int ShapeFindByName	(	int	pShapeGrpId,
		str	pName
	)

Search for all occurrences

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.

int ShapeGetCount

(

int

pShapeGrpId

)

Search for all occurrences

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.

str ShapeGetName	(	int	pShapeGrpId,
		int	pShapeId
	)

Search for all occurrences

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.

bool ShapeSetName	(	int	pShapeGrpId,
		int	pShapeId,
		str	pName
	)

Search for all occurrences

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.

int ClusterGroupAdd	(	tuple	pList,
		str	pName = None
	)

Search for all occurrences

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.

bool ClusterGroupRemove

(

int

pClusterGrpId

)

Search for all occurrences

Remove a cluster group from the character face.

Parameters:

pClusterGrpId

Index of the cluster group to remove.

Returns:

True if the operation completed successfully.

int ClusterGroupFindByName

(

str

pName

)

Search for all occurrences

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.

int ClusterGroupGetCount

(

)

Search for all occurrences

Retrieve the total number of cluster groups.

Returns:

Number of cluster groups on the face.

str ClusterGroupGetName

(

int

pClusterGrpId

)

Search for all occurrences

Retrieve the name of a cluster group.

Parameters:

pClusterGrpId

Index of the cluster group to query.

Returns:

Name of the specified cluster group.

bool ClusterGroupSetName	(	int	pClusterGrpId,
		str	pName
	)

Search for all occurrences

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.

bool ClusterGroupSnapRest

(

int

pClusterGrpId

)

Search for all occurrences

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.

int ClusterShapeAdd	(	int	pClusterGrpId,
		str	pName = None
	)

Search for all occurrences

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.

bool ClusterShapeRemove	(	int	pClusterGrpId,
		int	pClusterShapeId
	)

Search for all occurrences

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.

int ClusterShapeFindByName	(	int	pClusterGrpId,
		str	pName
	)

Search for all occurrences

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.

int ClusterShapeGetCount

(

int

pClusterGrpId

)

Search for all occurrences

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.

str ClusterShapeGetName	(	int	pClusterGrpId,
		int	pClusterShapeId
	)

Search for all occurrences

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.

bool ClusterShapeSetName	(	int	pClusterGrpId,
		int	pClusterShapeId,
		str	pName
	)

Search for all occurrences

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.

bool ClusterShapeSnap	(	int	pClusterGrpId,
		int	pClusterShapeId
	)

Search for all occurrences

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.

int ExpressionAdd

(

str

pName

)

Search for all occurrences

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.

bool ExpressionRemove

(

int

pExpressionId

)

Search for all occurrences

Remove an expression from the face.

Parameters:

pExpressionId

Index of the expression to remove.

Returns:

True if the operation completed successfully.

int ExpressionFindByName

(

str

pName

)

Search for all occurrences

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.

int ExpressionGetCount

(

)

Search for all occurrences

Retrieve the total number of expressions on the face.

Returns:

Number of expressions on the face.

str ExpressionGetName

(

int

pExpressionId

)

Search for all occurrences

Retrieve the name of an expression.

Parameters:

pExpressionId

Index of the expression to query.

Returns:

Name of the specified expression.

bool ExpressionSetName	(	int	pExpressionId,
		str	pName
	)

Search for all occurrences

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.

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

Search for all occurrences

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. Valid range of [0.0, 1.0].

Returns:

True if the operation completed successfully.

---

Member Data Documentation

FBPropertyActorFace InputActorFace

Search for all occurrences

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

FBPropertyBase ActiveInput

Search for all occurrences

Read Write Property: Is the character input active?.