#include <mobu-python-api.h>

Class 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:

Public Member Functions
	__reduce__ ()

	__init__ (object arg1, str arg2)
	Constructor. More...

	FBDelete (FBCharacterFace arg1)
	Actual Character Face destructor. More...

bool	PlotAnimation (FBCharacterFace arg1)
	Plot the animation of the character face. More...

	GotoRest (FBCharacterFace arg1)
	Set the character face back to its rest shape. More...

bool	ShapeGroupAdd (FBCharacterFace arg1, FBModelList arg2, str arg3)
	Add a blendshape model group containing models. More...

bool	ShapeGroupRemove (FBCharacterFace arg1, object arg2)
	Remove a blendshape model group. More...

int	ShapeGroupFindByName (FBCharacterFace arg1, str arg2)
	Find a blendshape group by name. More...

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

str	ShapeGroupGetName (FBCharacterFace arg1, object arg2)
	Retrieve the name of a blendshape group. More...

bool	ShapeGroupSetName (FBCharacterFace arg1, object arg2, str arg3)
	Set the name of a blendshape group. More...

int	ShapeFindByName (FBCharacterFace arg1, object arg2, str arg3)
	Find a shape in a blendshape group by name. More...

int	ShapeGetCount (FBCharacterFace arg1, object arg2)
	Retrieve the total number of shapes in a blendshape group. More...

str	ShapeGetName (FBCharacterFace arg1, object arg2, object arg3)
	Retrieve the name of the shape in a blendshape group. More...

bool	ShapeSetName (FBCharacterFace arg1, object arg2, object arg3, str arg4)
	Set the name of the shape in a blendshape group. More...

int	ClusterGroupAdd (FBCharacterFace arg1, FBModelList arg2, str arg3)
	Add a cluster group to the character face. More...

bool	ClusterGroupRemove (FBCharacterFace arg1, object arg2)
	Remove a cluster group from the character face. More...

int	ClusterGroupFindByName (FBCharacterFace arg1, str arg2)
	Find a cluster group by name. More...

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

str	ClusterGroupGetName (FBCharacterFace arg1, object arg2)
	Retrieve the name of a cluster group. More...

bool	ClusterGroupSetName (FBCharacterFace arg1, object arg2, str arg3)
	Set the name of a cluster group. More...

bool	ClusterGroupSnapRest (FBCharacterFace arg1, object arg2)
	Set a cluster group's rest pose to the current pose. More...

int	ClusterShapeAdd (FBCharacterFace arg1, object arg2, str arg3)
	Add a cluster shape to a cluster group. More...

bool	ClusterShapeRemove (FBCharacterFace arg1, object arg2, object arg3)
	Remove a cluster shape from a cluster group. More...

int	ClusterShapeFindByName (FBCharacterFace arg1, object arg2, str arg3)
	Find a cluster shape in a cluster group by name. More...

int	ClusterShapeGetCount (FBCharacterFace arg1, object arg2)
	Retrieve the total number of shapes in a cluster group. More...

str	ClusterShapeGetName (FBCharacterFace arg1, object arg2, object arg3)
	Retrieve the name of a shape in a cluster group. More...

bool	ClusterShapeSetName (FBCharacterFace arg1, object arg2, object arg3, str arg4)
	Set the name of a shape in a cluster group. More...

bool	ClusterShapeSnap (FBCharacterFace arg1, object arg2, object arg3)
	Record the current pose of the cluster group to a cluster shape. More...

int	ExpressionAdd (FBCharacterFace arg1, str arg2)
	Add an expression to the face. More...

bool	ExpressionRemove (FBCharacterFace arg1, object arg2)
	Remove an expression from the face. More...

int	ExpressionFindByName (FBCharacterFace arg1, str arg2)
	Find an expression on the face by name. More...

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

str	ExpressionGetName (FBCharacterFace arg1, object arg2)
	Retrieve the name of an expression. More...

bool	ExpressionSetName (FBCharacterFace arg1, object arg2, str arg3)
	Set the name of an expression. More...

bool	ExpressionSetShapeWeight (FBCharacterFace arg1, object arg2, object arg3, object arg4, float arg5)
	Assign the weight of a shape to an expression. More...

float	ExpressionGetShapeWeight (FBCharacterFace arg1, object arg2, object arg3, object arg4)
	Retrieve the weight of a shape to an expression. More...

Public Member Functions inherited from FBConstraint
	__reduce__ ()

object	AnimationNodeInCreate (FBConstraint arg1, object arg2, FBModel arg3, str arg4)

object	__copy__ (FBConstraint arg1)

object	AnimationNodeOutCreate (FBConstraint arg1, object arg2, FBModel arg3, str arg4)
	Animation Node Creations (IN/OUT). More...

object	Clone (FBConstraint arg1)
	Clone the constraint. More...

bool	DeformerBind (FBConstraint arg1, FBModel arg2)
	Bind/Unbind pModel to deformation constraint. More...

bool	DeformerUnBind (FBConstraint arg1, FBModel arg2)

bool	Disable (FBConstraint arg1, FBModel arg2)
	Disable constraint on pModel. More...

	FreezeSRT (FBConstraint arg1, FBModel arg2, object arg3, object arg4, object arg5)
	Freeze current model state. More...

	FreezeSuggested (FBConstraint arg1)
	Suggest 'freeze'. More...

bool	ReferenceAdd (FBConstraint arg1, object arg2, FBModel arg3)
	Add a reference to a specified group. More...

object	ReferenceGet (FBConstraint arg1, object arg2, object arg3)
	Get a reference. More...

int	ReferenceGetCount (FBConstraint arg1, object arg2)
	Get number of references in a specified group. More...

int	ReferenceGroupAdd (FBConstraint arg1, str arg2, object arg3)
	Add a group of references. More...

int	ReferenceGroupGetCount (FBConstraint arg1)
	Return the number of reference groups. More...

int	ReferenceGroupGetMaxCount (FBConstraint arg1, object arg2)
	Get the maximum number of items that can exist in the reference group in question. More...

str	ReferenceGroupGetName (FBConstraint arg1, object arg2)
	Get the name of the reference group. More...

bool	ReferenceRemove (FBConstraint arg1, object arg2, FBModel arg3)
	Remove a reference to pModel from the group at pGroupIndex. More...

	RemoveAllAnimationNodes (FBConstraint arg1)
	Remove animation nodes. More...

	RestoreModelState (FBConstraint arg1, FBModel arg2)
	Restore the saved model state onto pModel. More...

	SaveModelState (FBConstraint arg1, FBModel arg2, object arg3, object arg4, object arg5)
	Save current state of pModel. More...

	SetupAllAnimationNodes (FBConstraint arg1)
	Setup animation nodes. More...

	Snap (FBConstraint arg1)
	Function Property: Snap constraint. More...

	SnapSuggested (FBConstraint arg1)
	Suggest 'snap'. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBBox
	__reduce__ ()

bool	AnimationNodeDestroy (FBBox arg1, FBAnimationNode arg2)
	Destroy an animation node. More...

	__init__ (object arg1, str arg2)
	Constructor. More...

object	AnimationNodeInGet (FBBox arg1)
	Get the (IN/OUT) animation node for this box. More...

bool	AnimationNodeIsUserData (FBBox arg1, FBAnimationNode arg2)
	Is the animation node user data? More...

object	AnimationNodeOutGet (FBBox arg1)

int	GetOutConnectorCount (FBBox arg1)
	Get the number of animation node outputs for this box. More...

int	GetInConnectorCount (FBBox arg1)
	Get the number of animation node inputs for this box. More...

object	GetOutConnector (FBBox arg1, object arg2)
	Get the animation node output associated with the given index. More...

object	GetInConnector (FBBox arg1, object arg2)
	Get the animation node input associated with the given index. More...

Public Member Functions inherited from FBComponent
	__reduce__ ()

FBPropertyList	PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
	Get list of properties which have been modified since last loading. More...

str	ClassName (FBComponent arg1)
	Get the class name. More...

	DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Disable a specific Object Flags. More...

	EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Enable a specific Object Flags. More...

bool	FBCreate (FBComponent arg1)
	Open Reality Creation function. More...

	FBDelete (FBComponent arg1)
	Open Reality deletion function. More...

	FBDestroy (FBComponent arg1)
	Open Reality destruction function. More...

FBObjectFlag	GetObjectFlags (FBComponent arg1)
	Get all Object Flags (concatenated). More...

bool	GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
	Check to see if an object status is enabled. More...

bool	HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Check whether a specific object flag is enabled. More...

bool	Is (FBComponent arg1, object arg2)
	Returns true if object is of type TypeId. More...

bool	ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessObjectNamespace. More...

int	PropertyAdd (FBComponent arg1, FBProperty arg2)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
	Add a reference property to the component's property manager. More...

object	PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
	Create user or dynamic property. More...

	PropertyRemove (FBComponent arg1, FBProperty arg2)
	Remove a Property from the component's Property manager. More...

	SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	SetObjectFlags. More...

	SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
	Enable/Disable a specific Object Status. More...

	HardSelect (FBComponent arg1)
	HardSelect. More...

object	GetOwnerFileReference (FBComponent arg1)
	Get the owner FileReference object. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBPlug
	__reduce__ ()

bool	BeginChange (FBPlug arg1)
	Begins a change on multiple plugs. More...

str	ClassName (FBPlug arg1)
	internal System vars. More...

bool	ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a destination connection. More...

bool	ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a destination connection. More...

bool	ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a source connection. More...

bool	ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a source connection. More...

	DisconnectAllDst (FBPlug arg1)
	Remove all destination connections. More...

	DisconnectAllSrc (FBPlug arg1)
	Remove all source connections. More...

bool	DisconnectDst (FBPlug arg1, FBPlug arg2)
	Remove a destination connection. More...

bool	DisconnectDstAt (FBPlug arg1, object arg2)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrc (FBPlug arg1, FBPlug arg2)
	Remove a source connection. More...

bool	DisconnectSrcAt (FBPlug arg1, object arg2)
	Remove a source connection at a specified index. More...

	EndChange (FBPlug arg1)
	Ends a change on multiple plugs. More...

object	GetDst (FBPlug arg1, object arg2)
	Get a destination connection's plug at specified index. More...

int	GetDstCount (FBPlug arg1)
	Get destination connection count. More...

FBConnectionType	GetDstType (FBPlug arg1, object arg2)
	Get a destination connection's type at specified index. More...

object	GetOwned (FBPlug arg1, object arg2)
	Get the owned plug at specified index. More...

int	GetOwnedCount (FBPlug arg1)
	Get the owned plug count. More...

object	GetOwner (FBPlug arg1)
	Get the owner of this plug. More...

object	GetSrc (FBPlug arg1, object arg2)
	Get a source connection's plug at specified index. More...

int	GetSrcCount (FBPlug arg1)
	Get source connection count. More...

FBConnectionType	GetSrcType (FBPlug arg1, object arg2)
	Get a source connection's type at specified index. More...

bool	Is (FBPlug arg1, object arg2)
	Is( int pTypeId ) More...

bool	IsSDKComponent (FBPlug arg1)
	Return whether or not item is an SDK component. More...

	MoveSrcAt (...)

bool	ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a source connection at a specified index. More...

bool	SwapSrc (FBPlug arg1, object arg2, object arg3)
	Swap source connection at index A with source connection at index B. More...

	SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's self has changed. More...

	SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
	Revert the plug's modification to original status. More...

	__init__ (...)

method	staticmethod (function)

Public Member Functions inherited from FBPythonWrapper
	__reduce__ ()

	__init__ (...)

Public Attributes
FBPropertyBool	ActiveInput
	Read Write Property: Is the character input active? More...

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

Public Attributes inherited from FBConstraint
FBPropertyBool	Active
	Read Write Property: Active state. More...

FBPropertyBool	Deformer
	Read Write Property: Is a deformer constraint? More...

ORSDK2018::FBPropertyString	Description
	Read Write Property: Long description of constraint. More...

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

FBPropertyBool	Lock
	Read Write Property: Lock state. More...

FBPropertyAnimatableDouble	Weight
	Read Write Property: Weight of constraint. More...

Public Attributes inherited from FBBox
FBPropertyBool	Animatable
	Read Write Property: Is the box animatable. More...

FBPropertyBool	Live
	Read Write Property: Is live? More...

FBPropertyBool	RecordMode
	Read Write Property: Is recording? More...

const char *	UniqueName
	internal Unique name. More...

Public Attributes inherited from FBComponent
object	OwnerNamespace

ORSDK2018::FBPropertyListComponent	Components
	List: List of components. More...

ORSDK2018::FBPropertyString	Name
	Read Write Property: Unique name of object. More...

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

object	FullName

ORSDK2018::FBPropertyListComponent	Parents
	List: Parents. More...

ORSDK2018::FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

Public Attributes inherited from FBPythonWrapper
object	OnUnbind

Member Function Documentation

__init__	(	object	arg1,
		str	arg2
	)

Constructor.

Python Docstring:

__init__( (object)arg1, (str)arg2) -> None

C++ Signature:

 FBCharacterFace(const char * pName, HIObject pObject = ((void *) 0))

Parameters

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

See the C++ reference

__reduce__ ( )

int ClusterGroupAdd	(	FBCharacterFace	arg1,
		FBModelList	arg2,
		str	arg3
	)

Add a cluster group to the character face.

Python Docstring:

ClusterGroupAdd( (FBCharacterFace)arg1, (FBModelList)arg2, (str)arg3) -> int

C++ Signature:

int ClusterGroupAdd(FBModelList * pList, const char * pName = ((void *) 0))

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.

See the C++ reference

int ClusterGroupFindByName	(	FBCharacterFace	arg1,
		str	arg2
	)

Find a cluster group by name.

Python Docstring:

ClusterGroupFindByName( (FBCharacterFace)arg1, (str)arg2) -> int

C++ Signature:

int ClusterGroupFindByName(const char * pName)

Parameters

pName Name to search for on the face.

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

See the C++ reference

int ClusterGroupGetCount ( FBCharacterFace arg1 )

Retrieve the total number of cluster groups.

Python Docstring:

ClusterGroupGetCount( (FBCharacterFace)arg1) -> int

C++ Signature:

int ClusterGroupGetCount()

Returns: Number of cluster groups on the face.

See the C++ reference

str ClusterGroupGetName	(	FBCharacterFace	arg1,
		object	arg2
	)

Retrieve the name of a cluster group.

Python Docstring:

ClusterGroupGetName( (FBCharacterFace)arg1, (object)arg2) -> str

C++ Signature:

const char * ClusterGroupGetName(int pClusterGrpId)

Parameters

pClusterGrpId Index of the cluster group to query.

Returns: Name of the specified cluster group.

See the C++ reference

bool ClusterGroupRemove	(	FBCharacterFace	arg1,
		object	arg2
	)

Remove a cluster group from the character face.

Python Docstring:

ClusterGroupRemove( (FBCharacterFace)arg1, (object)arg2) -> bool

C++ Signature:

bool ClusterGroupRemove(int pClusterGrpId)

Parameters

pClusterGrpId Index of the cluster group to remove.

Returns: True if the operation completed successfully.

See the C++ reference

bool ClusterGroupSetName	(	FBCharacterFace	arg1,
		object	arg2,
		str	arg3
	)

Set the name of a cluster group.

Python Docstring:

ClusterGroupSetName( (FBCharacterFace)arg1, (object)arg2, (str)arg3) -> bool

C++ Signature:

bool ClusterGroupSetName(int pClusterGrpId, const char * pName)

Parameters

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

Returns: True of the operation completed successfully.

See the C++ reference

bool ClusterGroupSnapRest	(	FBCharacterFace	arg1,
		object	arg2
	)

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

Python Docstring:

ClusterGroupSnapRest( (FBCharacterFace)arg1, (object)arg2) -> bool

C++ Signature:

bool ClusterGroupSnapRest(int pClusterGrpId)

Parameters

pClusterGrpId Index of the cluster group to modify.

Returns: True if the operation completed succesfully.

See the C++ reference

int ClusterShapeAdd	(	FBCharacterFace	arg1,
		object	arg2,
		str	arg3
	)

Add a cluster shape to a cluster group.

Python Docstring:

ClusterShapeAdd( (FBCharacterFace)arg1, (object)arg2, (str)arg3) -> int

C++ Signature:

int ClusterShapeAdd(int pClusterGrpId, const char * pName = ((void *) 0))

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.

See the C++ reference

int ClusterShapeFindByName	(	FBCharacterFace	arg1,
		object	arg2,
		str	arg3
	)

Find a cluster shape in a cluster group by name.

Python Docstring:

ClusterShapeFindByName( (FBCharacterFace)arg1, (object)arg2, (str)arg3) -> int

C++ Signature:

int ClusterShapeFindByName(int pClusterGrpId, const char * pName)

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.

See the C++ reference

int ClusterShapeGetCount	(	FBCharacterFace	arg1,
		object	arg2
	)

Retrieve the total number of shapes in a cluster group.

Python Docstring:

ClusterShapeGetCount( (FBCharacterFace)arg1, (object)arg2) -> int

C++ Signature:

int ClusterShapeGetCount(int pClusterGrpId)

Parameters

pClusterGrpId Index of the cluster group to query.

Returns: Number of shapes in the specified cluster group.

See the C++ reference

str ClusterShapeGetName	(	FBCharacterFace	arg1,
		object	arg2,
		object	arg3
	)

Retrieve the name of a shape in a cluster group.

Python Docstring:

ClusterShapeGetName( (FBCharacterFace)arg1, (object)arg2, (object)arg3) -> str

C++ Signature:

const char * ClusterShapeGetName(int pClusterGrpId, int pClusterShapeId)

Parameters

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

Returns: Name of the specified shape.

See the C++ reference

bool ClusterShapeRemove	(	FBCharacterFace	arg1,
		object	arg2,
		object	arg3
	)

Remove a cluster shape from a cluster group.

Python Docstring:

ClusterShapeRemove( (FBCharacterFace)arg1, (object)arg2, (object)arg3) -> bool

C++ Signature:

bool ClusterShapeRemove(int pClusterGrpId, int pClusterShapeId)

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.

See the C++ reference

bool ClusterShapeSetName	(	FBCharacterFace	arg1,
		object	arg2,
		object	arg3,
		str	arg4
	)

Set the name of a shape in a cluster group.

Python Docstring:

ClusterShapeSetName( (FBCharacterFace)arg1, (object)arg2, (object)arg3, (str)arg4) -> bool

C++ Signature:

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

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.

See the C++ reference

bool ClusterShapeSnap	(	FBCharacterFace	arg1,
		object	arg2,
		object	arg3
	)

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

Python Docstring:

ClusterShapeSnap( (FBCharacterFace)arg1, (object)arg2, (object)arg3) -> bool

C++ Signature:

bool ClusterShapeSnap(int pClusterGrpId, int pClusterShapeId)

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.

See the C++ reference

int ExpressionAdd	(	FBCharacterFace	arg1,
		str	arg2
	)

Add an expression to the face.

Python Docstring:

ExpressionAdd( (FBCharacterFace)arg1, (str)arg2) -> int

C++ Signature:

int ExpressionAdd(const char * pName)

Parameters

pName Optional name to assign to the new expression.

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

See the C++ reference

int ExpressionFindByName	(	FBCharacterFace	arg1,
		str	arg2
	)

Find an expression on the face by name.

Python Docstring:

ExpressionFindByName( (FBCharacterFace)arg1, (str)arg2) -> int

C++ Signature:

int ExpressionFindByName(const char * pName)

Parameters

pName Name of the expression to search for.

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

See the C++ reference

int ExpressionGetCount ( FBCharacterFace arg1 )

Retrieve the total number of expressions on the face.

Python Docstring:

ExpressionGetCount( (FBCharacterFace)arg1) -> int

C++ Signature:

int ExpressionGetCount()

Returns: Number of expressions on the face.

See the C++ reference

str ExpressionGetName	(	FBCharacterFace	arg1,
		object	arg2
	)

Retrieve the name of an expression.

Python Docstring:

ExpressionGetName( (FBCharacterFace)arg1, (object)arg2) -> str

C++ Signature:

const char * ExpressionGetName(int pExpressionId)

Parameters

pExpressionId Index of the expression to query.

Returns: Name of the specified expression.

See the C++ reference

float ExpressionGetShapeWeight	(	FBCharacterFace	arg1,
		object	arg2,
		object	arg3,
		object	arg4
	)

Retrieve the weight of a shape to an expression.

Python Docstring:

ExpressionGetShapeWeight( (FBCharacterFace)arg1, (object)arg2, (object)arg3, (object)arg4) -> float

C++ Signature:

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

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.

See the C++ reference

bool ExpressionRemove	(	FBCharacterFace	arg1,
		object	arg2
	)

Remove an expression from the face.

Python Docstring:

ExpressionRemove( (FBCharacterFace)arg1, (object)arg2) -> bool

C++ Signature:

bool ExpressionRemove(int pExpressionId)

Parameters

pExpressionId Index of the expression to remove.

Returns: True if the operation completed successfully.

See the C++ reference

bool ExpressionSetName	(	FBCharacterFace	arg1,
		object	arg2,
		str	arg3
	)

Set the name of an expression.

Python Docstring:

ExpressionSetName( (FBCharacterFace)arg1, (object)arg2, (str)arg3) -> bool

C++ Signature:

bool ExpressionSetName(int pExpressionId, const char * pName)

Parameters

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

Returns: True if the operation completed successfully.

See the C++ reference

bool ExpressionSetShapeWeight	(	FBCharacterFace	arg1,
		object	arg2,
		object	arg3,
		object	arg4,
		float	arg5
	)

Assign the weight of a shape to an expression.

Python Docstring:

ExpressionSetShapeWeight( (FBCharacterFace)arg1, (object)arg2, (object)arg3, (object)arg4, (float)arg5) -> bool

C++ Signature:

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

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.

See the C++ reference

FBDelete ( FBCharacterFace arg1 )

Actual Character Face destructor.

Python Docstring:

FBDelete( (FBCharacterFace)arg1) -> None

C++ Signature:

void FBDelete()

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

See the C++ reference

GotoRest ( FBCharacterFace arg1 )

Set the character face back to its rest shape.

Python Docstring:

GotoRest( (FBCharacterFace)arg1) -> None

C++ Signature:

void GotoRest()

See the C++ reference

bool PlotAnimation ( FBCharacterFace arg1 )

Plot the animation of the character face.

Python Docstring:

PlotAnimation( (FBCharacterFace)arg1) -> bool

C++ Signature:

bool PlotAnimation()

Returns: True if the operation completed successfully.

See the C++ reference

int ShapeFindByName	(	FBCharacterFace	arg1,
		object	arg2,
		str	arg3
	)

Find a shape in a blendshape group by name.

Python Docstring:

ShapeFindByName( (FBCharacterFace)arg1, (object)arg2, (str)arg3) -> int

C++ Signature:

int ShapeFindByName(int pShapeGrpId, const char * pName)

Parameters

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

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

See the C++ reference

int ShapeGetCount	(	FBCharacterFace	arg1,
		object	arg2
	)

Retrieve the total number of shapes in a blendshape group.

Python Docstring:

ShapeGetCount( (FBCharacterFace)arg1, (object)arg2) -> int

C++ Signature:

int ShapeGetCount(int pShapeGrpId)

Parameters

pShapeGrpId Index of the blendshape group to query.

Returns: Number of shapes in the specified blendshape group.

See the C++ reference

str ShapeGetName	(	FBCharacterFace	arg1,
		object	arg2,
		object	arg3
	)

Retrieve the name of the shape in a blendshape group.

Python Docstring:

ShapeGetName( (FBCharacterFace)arg1, (object)arg2, (object)arg3) -> str

C++ Signature:

const char * ShapeGetName(int pShapeGrpId, int pShapeId)

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.

See the C++ reference

bool ShapeGroupAdd	(	FBCharacterFace	arg1,
		FBModelList	arg2,
		str	arg3
	)

Add a blendshape model group containing models.

Python Docstring:

ShapeGroupAdd( (FBCharacterFace)arg1, (FBModelList)arg2, (str)arg3) -> bool

C++ Signature:

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

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.

See the C++ reference

int ShapeGroupFindByName	(	FBCharacterFace	arg1,
		str	arg2
	)

Find a blendshape group by name.

Python Docstring:

ShapeGroupFindByName( (FBCharacterFace)arg1, (str)arg2) -> int

C++ Signature:

int ShapeGroupFindByName(const char * pName)

Parameters

pName Name to search for.

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

See the C++ reference

int ShapeGroupGetCount ( FBCharacterFace arg1 )

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

Python Docstring:

ShapeGroupGetCount( (FBCharacterFace)arg1) -> int

C++ Signature:

int ShapeGroupGetCount()

Returns: Number of blendshape groups on this character face.

See the C++ reference

str ShapeGroupGetName	(	FBCharacterFace	arg1,
		object	arg2
	)

Retrieve the name of a blendshape group.

Python Docstring:

ShapeGroupGetName( (FBCharacterFace)arg1, (object)arg2) -> str

C++ Signature:

const char * ShapeGroupGetName(int pShapeGrpId)

Parameters

pShapeGrpId Index of the blendshape group to query.

Returns: Name of the blendshape group.

See the C++ reference

bool ShapeGroupRemove	(	FBCharacterFace	arg1,
		object	arg2
	)

Remove a blendshape model group.

Python Docstring:

ShapeGroupRemove( (FBCharacterFace)arg1, (object)arg2) -> bool

C++ Signature:

bool ShapeGroupRemove(int pShapeGrpId)

Parameters

pShapeGrpId Index of the blendshape group to remove.

Returns: True if the operation completed successfully.

See the C++ reference

bool ShapeGroupSetName	(	FBCharacterFace	arg1,
		object	arg2,
		str	arg3
	)

Set the name of a blendshape group.

Python Docstring:

ShapeGroupSetName( (FBCharacterFace)arg1, (object)arg2, (str)arg3) -> bool

C++ Signature:

bool ShapeGroupSetName(int pShapeGrpId, const char * pName)

Parameters

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

Returns: True if the operation completed successfully.

See the C++ reference

bool ShapeSetName	(	FBCharacterFace	arg1,
		object	arg2,
		object	arg3,
		str	arg4
	)

Set the name of the shape in a blendshape group.

Python Docstring:

ShapeSetName( (FBCharacterFace)arg1, (object)arg2, (object)arg3, (str)arg4) -> bool

C++ Signature:

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

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.

See the C++ reference

Member Data Documentation

FBPropertyBool ActiveInput

Read Write Property: Is the character input active?

See the C++ reference

FBPropertyActorFace InputActorFace

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

See the C++ reference

FBCharacterFace Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation