Class FaceActor
A component used to apply face poses to a character in a scene.
Inherited Members
Namespace: Unity.LiveCapture.ARKitFaceCapture
Syntax
[DisallowMultipleComponent]
[ExcludeFromPreset]
[AddComponentMenu("Live Capture/ARKit Face Capture/ARKit Face Actor")]
[ExecuteAlways]
[RequireComponent(typeof(Animator))]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.live-capture@4.0/manual/ref-component-arkit-face-actor.html")]
public sealed class FaceActor : MonoBehaviour, IPreviewableProperties
Animator
The Animator component used by the device for playing takes on this actor.
Declaration
public Animator Animator { get; }Property Value
| Type | Description |
|---|---|
| Animator |
Mapper
The asset that configures how face pose data is mapped to this character's face rig.
Declaration
public FaceMapper Mapper { get; }Property Value
| Type | Description |
|---|---|
| FaceMapper |
Methods
ClearCache()
Clears the mapper state cache for the actor, causing it to rebuild the next time the face rig updates.
Declaration
public void ClearCache()Register(IPropertyPreviewer)
The preview system calls this method before playing animations. Use the specified IPropertyPreviewer to register animated properties.
Declaration
public void Register(IPropertyPreviewer previewer)Parameters
| Type | Name | Description |
|---|---|---|
| IPropertyPreviewer | previewer | The IPropertyPreviewer to register animated properties to. |
Implements
SetMapper(FaceMapper)
Sets the face mapper used by this face rig.
Declaration
public void SetMapper(FaceMapper mapper)Parameters
| Type | Name | Description |
|---|---|---|
| FaceMapper | mapper | The mapper to use, or null to clear the current mapper. |
UpdateRig(Boolean)
Updates the face rig from the current pose.
Declaration
public void UpdateRig(bool continuous)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | 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. |