[CreateAssetMenu(fileName = "NewFaceMapper", menuName = "Live Capture/ARKit Face Capture/Mapper")]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.live-capture@4.0/manual/ref-component-arkit-default-face-mapper.html")]
public class DefaultFaceMapper : FaceMapper

Remarks

The inspector is used to assign a prefab containing a face rig and configure the mapping for the rig. On assignment, all relevant skinned mesh renderers in the rig are detected and a best guess for the mapping is automatically generated. The mapping may be shared by different rigs, as long as the transform paths of all skinned meshes relative to the FaceActor components are consistent between the rigs.

Methods

ApplyBlendShapesToRig(FaceActor, FaceMapperCache, ref FaceBlendShapePose, bool)

Called by FaceActor to update a face rig to show a face pose.

Declaration

public override void ApplyBlendShapesToRig(FaceActor actor, FaceMapperCache cache, ref FaceBlendShapePose pose, bool continuous)

Parameters

Type	Name	Description
FaceActor	actor	The face rig the pose is applied to.
FaceMapperCache	cache	The mapper state cache for the specified actor.
FaceBlendShapePose	pose	The face pose to map from.
bool	continuous	When true, the new pose follows the current pose and they can be smoothed between, while false corresponds to a seek in the animation where the previous pose is invalidated and should not influence the new pose.

Overrides

FaceMapper.ApplyBlendShapesToRig(FaceActor, FaceMapperCache, ref FaceBlendShapePose, bool)

ApplyEyeRotationToRig(FaceActor, FaceMapperCache, ref FaceBlendShapePose, ref Quaternion, ref Quaternion, bool)

Called by FaceActor to update the eye rotations of the face rig.

Declaration

public override void ApplyEyeRotationToRig(FaceActor actor, FaceMapperCache cache, ref FaceBlendShapePose pose, ref Quaternion leftEyeRotation, ref Quaternion rightEyeRotation, bool continuous)

Parameters

Type	Name	Description
FaceActor	actor	The face rig the pose is applied to.
FaceMapperCache	cache	The mapper state cache for the specified actor.
FaceBlendShapePose	pose	The face blend shapes to map from.
Quaternion	leftEyeRotation	The left eye rotation to map from.
Quaternion	rightEyeRotation	The right eye rotation to map from.
bool	continuous	When true, the new pose follows the current pose and they can be smoothed between, while false corresponds to a seek in the animation where the previous pose is invalidated and should not influence the new pose.

Overrides

FaceMapper.ApplyEyeRotationToRig(FaceActor, FaceMapperCache, ref FaceBlendShapePose, ref Quaternion, ref Quaternion, bool)

ApplyHeadPositionToRig(FaceActor, FaceMapperCache, ref Vector3, bool)

Called by FaceActor to update the head position of the character rig.

Declaration

public override void ApplyHeadPositionToRig(FaceActor actor, FaceMapperCache cache, ref Vector3 headPosition, bool continuous)

Parameters

Type	Name	Description
FaceActor	actor	The face rig the pose is applied to.
FaceMapperCache	cache	The mapper state cache for the specified actor.
Vector3	headPosition	The head position to map from.
bool	continuous	When true, the new pose follows the current pose and they can be smoothed between, while false corresponds to a seek in the animation where the previous pose is invalidated and should not influence the new pose.

Overrides

FaceMapper.ApplyHeadPositionToRig(FaceActor, FaceMapperCache, ref Vector3, bool)

ApplyHeadRotationToRig(FaceActor, FaceMapperCache, ref Quaternion, bool)

Called by FaceActor to update the head rotation of the character rig.

Declaration

public override void ApplyHeadRotationToRig(FaceActor actor, FaceMapperCache cache, ref Quaternion headOrientation, bool continuous)

Parameters

Type	Name	Description
FaceActor	actor	The face rig the pose is applied to.
FaceMapperCache	cache	The mapper state cache for the specified actor.
Quaternion	headOrientation	The head pose to map from.
bool	continuous	When true, the new pose follows the current pose and they can be smoothed between, while false corresponds to a seek in the animation where the previous pose is invalidated and should not influence the new pose.

Overrides

FaceMapper.ApplyHeadRotationToRig(FaceActor, FaceMapperCache, ref Quaternion, bool)

CreateCache(FaceActor)

Creates a mapper state cache for the specified actor.

Declaration

public override FaceMapperCache CreateCache(FaceActor actor)

Parameters

Type	Name	Description
FaceActor	actor	The face rig to create the cache for.

Returns

Type	Description
FaceMapperCache	The new cache instance, or null if no cache is needed by the mapper.

Overrides

FaceMapper.CreateCache(FaceActor)

OnValidate()

Editor-only function that Unity calls when the script is loaded or a value changes in the Inspector.

Declaration

protected virtual void OnValidate()

RegisterPreviewableProperties(FaceActor, FaceMapperCache, IPropertyPreviewer)

The preview system calls this method before playing animations. Use the specified IPropertyPreviewer to register animated properties.

Declaration

public override void RegisterPreviewableProperties(FaceActor actor, FaceMapperCache cache, IPropertyPreviewer previewer)

Parameters

Type	Name	Description
FaceActor	actor	The face rig the pose is applied to.
FaceMapperCache	cache	The mapper state cache for the specified actor.
IPropertyPreviewer	previewer	The IPropertyPreviewer to register animated properties to.

Overrides

FaceMapper.RegisterPreviewableProperties(FaceActor, FaceMapperCache, IPropertyPreviewer)