Class ARFaceManager

Creates, updates, and removes GameObjects with ARFace components under the ARSessionOrigin's trackablesParent.

Inheritance
Object
SubsystemLifecycleManager<XRFaceSubsystem, XRFaceSubsystemDescriptor>
ARTrackableManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFace, ARFace>
ARFaceManager
Inherited Members
Namespace: UnityEngine.XR.ARFoundation
Syntax
public sealed class ARFaceManager : ARTrackableManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFace, ARFace>
Remarks

When enabled, this component subscribes to , , and . If this component is disabled, and there are no other subscribers to those events, face detection will be disabled on the device.

Properties

facePrefab

Getter/setter for the Face Prefab.

Declaration
public GameObject facePrefab { get; set; }
Property Value
Type Description
GameObject

gameObjectName

Declaration
protected override string gameObjectName { get; }
Property Value
Type Description
String
Overrides
UnityEngine.XR.ARFoundation.ARTrackableManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFace, UnityEngine.XR.ARFoundation.ARFace>.gameObjectName

maximumFaceCount

Get or set the maximum number of faces to track simultaneously

Declaration
public int maximumFaceCount { get; set; }
Property Value
Type Description
Int32

supported

Not all devices support face tracking, even if the target platform generally does. Use this to check whether face tracking is supported at runtime.

Declaration
public bool supported { get; }
Property Value
Type Description
Boolean

supportedFaceCount

Get the supported number of faces that can be tracked simultaneously.

Declaration
public int supportedFaceCount { get; }
Property Value
Type Description
Int32

Methods

GetPrefab()

Declaration
protected override GameObject GetPrefab()
Returns
Type Description
GameObject
Overrides
UnityEngine.XR.ARFoundation.ARTrackableManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFace, UnityEngine.XR.ARFoundation.ARFace>.GetPrefab()

OnAfterSetSessionRelativeData(ARFace, XRFace)

Declaration
protected override void OnAfterSetSessionRelativeData(ARFace face, XRFace sessionRelativeData)
Parameters
Type Name Description
ARFace face
XRFace sessionRelativeData
Overrides
UnityEngine.XR.ARFoundation.ARTrackableManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFace, UnityEngine.XR.ARFoundation.ARFace>.OnAfterSetSessionRelativeData(UnityEngine.XR.ARFoundation.ARFace, XRFace)

OnBeforeStart()

Declaration
protected override void OnBeforeStart()
Overrides
UnityEngine.XR.ARFoundation.SubsystemLifecycleManager<XRFaceSubsystem, XRFaceSubsystemDescriptor>.OnBeforeStart()

OnEnable()

Declaration
protected override void OnEnable()
Overrides
UnityEngine.XR.ARFoundation.SubsystemLifecycleManager<XRFaceSubsystem, XRFaceSubsystemDescriptor>.OnEnable()

OnTrackablesChanged(List<ARFace>, List<ARFace>, List<ARFace>)

Declaration
protected override void OnTrackablesChanged(List<ARFace> added, List<ARFace> updated, List<ARFace> removed)
Parameters
Type Name Description
List<ARFace> added
List<ARFace> updated
List<ARFace> removed
Overrides
UnityEngine.XR.ARFoundation.ARTrackableManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFace, UnityEngine.XR.ARFoundation.ARFace>.OnTrackablesChanged(System.Collections.Generic.List<UnityEngine.XR.ARFoundation.ARFace>, System.Collections.Generic.List<UnityEngine.XR.ARFoundation.ARFace>, System.Collections.Generic.List<UnityEngine.XR.ARFoundation.ARFace>)

TryGetFace(TrackableId)

Attempts to retrieve an ARFace.

Declaration
public ARFace TryGetFace(TrackableId faceId)
Parameters
Type Name Description
TrackableId faceId

The TrackableId associated with the ARFace.
Returns
Type Description
ARFace

The ARFaceif found. null otherwise.

Events

facesChanged

Raised for each new ARFace detected in the environment.

Declaration
public event Action<ARFacesChangedEventArgs> facesChanged
Event Type
Type Description
Action<ARFacesChangedEventArgs>