Class FaceMapper

An asset used to apply a face pose to a character rig.

Inheritance

FaceMapper

Inherited Members

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(string)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, bool)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectsByType<T>(FindObjectsSortMode)

Object.FindObjectsOfType<T>(bool)

Object.FindObjectsByType<T>(FindObjectsInactive, FindObjectsSortMode)

Object.FindObjectOfType<T>()

Object.FindObjectOfType<T>(bool)

Object.FindFirstObjectByType<T>()

Object.FindAnyObjectByType<T>()

Object.FindFirstObjectByType<T>(FindObjectsInactive)

Object.FindAnyObjectByType<T>(FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, bool)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

Namespace: Unity.LiveCapture.ARKitFaceCapture

Assembly: Unity.LiveCapture.ARKitFaceCapture.dll

Syntax

public abstract class FaceMapper : ScriptableObject

Remarks

To use a mapper, it must be assigned to a FaceActor component. DefaultFaceMapper is the default mapper implementation, designed to work for rigs that can have their bone transforms and renderer blend shapes modified directly. For complex rigs that need more advanced re-targeting of the captured face animation, inherit from this class to implement custom mapper.

Methods

ApplyBlendShapesToRig(FaceActor, FaceMapperCache, ref FaceBlendShapePose, bool)

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

Declaration

public abstract 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.

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

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

Declaration

public abstract 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.

ApplyHeadPositionToRig(FaceActor, FaceMapperCache, ref Vector3, bool)

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

Declaration

public abstract 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.

ApplyHeadRotationToRig(FaceActor, FaceMapperCache, ref Quaternion, bool)

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

Declaration

public abstract 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.

CreateCache(FaceActor)

Creates a mapper state cache for the specified actor.

Declaration

public virtual 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.

RegisterPreviewableProperties(FaceActor, FaceMapperCache, IPropertyPreviewer)

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

Declaration

public virtual 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.