Class ARFaceManager

Creates, updates, and removes GameObjects with ARFace components under the Unity.XR.CoreUtils.XROrigin's Unity.XR.CoreUtils.XROrigin.TrackablesParent.

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

SubsystemLifecycleManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>

ARTrackableManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider, XRFace, ARFace>

ARFaceManager

Implements

ITrackablesChanged<ARFace>

Inherited Members

ARTrackableManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider, XRFace, ARFace>.trackablesChanged

ARTrackableManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider, XRFace, ARFace>.trackables

ARTrackableManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider, XRFace, ARFace>.SetTrackablesActive(bool)

SubsystemLifecycleManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>.subsystem

SubsystemLifecycleManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>.descriptor

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.destroyCancellationToken

MonoBehaviour.useGUILayout

MonoBehaviour.didStart

MonoBehaviour.didAwake

MonoBehaviour.runInEditMode

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type, bool)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>(bool)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.GetComponentIndex()

Component.CompareTag(string)

Component.CompareTag(TagHandle)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.InstantiateAsync<T>(T)

Object.InstantiateAsync<T>(T, Transform)

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

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

Object.InstantiateAsync<T>(T, int)

Object.InstantiateAsync<T>(T, int, Transform)

Object.InstantiateAsync<T>(T, int, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion)

Object.InstantiateAsync<T>(T, int, Transform, Vector3, Quaternion, CancellationToken)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>)

Object.InstantiateAsync<T>(T, int, Transform, ReadOnlySpan<Vector3>, ReadOnlySpan<Quaternion>, CancellationToken)

Object.Instantiate(Object, Vector3, Quaternion)

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

Object.Instantiate(Object)

Object.Instantiate(Object, Scene)

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

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: UnityEngine.XR.ARFoundation

Assembly: Unity.XR.ARFoundation.dll

Syntax

[RequireComponent(typeof(XROrigin))]
[DisallowMultipleComponent]
[DefaultExecutionOrder(-2147483647)]
[AddComponentMenu("XR/AR Foundation/AR Face Manager")]
public sealed class ARFaceManager : ARTrackableManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider, XRFace, ARFace>, ITrackablesChanged<ARFace>

Remarks

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

Related information: AR Face Manager component

Properties

currentMaximumFaceCount

Get the maximum number of faces to track simultaneously.

Declaration

public int currentMaximumFaceCount { get; }

Property Value

Type	Description
int

facePrefab

Getter/setter for the Face Prefab.

Declaration

public GameObject facePrefab { get; set; }

Property Value

Type	Description
GameObject

gameObjectName

The name assigned to each GameObject belonging to each ARFace.

Declaration

protected override string gameObjectName { get; }

Property Value

Type	Description
string

Overrides

ARTrackableManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider, XRFace, ARFace>.gameObjectName

requestedMaximumFaceCount

Get or set the requested maximum number of faces to track simultaneously

Declaration

public int requestedMaximumFaceCount { get; set; }

Property Value

Type	Description
int

supportedFaceCount

Get the supported number of faces that can be tracked simultaneously. This value might change when the configuration changes.

Declaration

public int supportedFaceCount { get; }

Property Value

Type	Description
int

Methods

GetPrefab()

Get the Prefab that will be instantiated for each ARFace. Can be null.

Declaration

protected override GameObject GetPrefab()

Returns

Type	Description
GameObject	The prefab that will be instantiated for each ARFace.

Overrides

ARTrackableManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider, XRFace, ARFace>.GetPrefab()

OnAfterSetSessionRelativeData(ARFace, XRFace)

Invoked just after an ARFace has been updated.

Declaration

protected override void OnAfterSetSessionRelativeData(ARFace face, XRFace sessionRelativeData)

Parameters

Type	Name	Description
ARFace	face
XRFace	sessionRelativeData

Overrides

ARTrackableManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider, XRFace, ARFace>.OnAfterSetSessionRelativeData(ARFace, XRFace)

OnBeforeStart()

Invoked just before calling Start on the Subsystem. Used to set the requestedMaximumFaceCount on the subsystem.

Declaration

protected override void OnBeforeStart()

Overrides

SubsystemLifecycleManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider>.OnBeforeStart()

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

Invoked when the base class detects trackable changes.

Declaration

[Obsolete("OnTrackablesChanged() has been deprecated in AR Foundation version 6.0.", false)]
protected override void OnTrackablesChanged(List<ARFace> added, List<ARFace> updated, List<ARFace> removed)

Parameters

Type	Name	Description
List<ARFace>	added	The list of added ARFaces.
List<ARFace>	updated	The list of updated ARFaces.
List<ARFace>	removed	The list of removed ARFaces.

Overrides

ARTrackableManager<XRFaceSubsystem, XRFaceSubsystemDescriptor, XRFaceSubsystem.Provider, XRFace, ARFace>.OnTrackablesChanged(List<ARFace>, List<ARFace>, List<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 ARFace if found. null otherwise.

Events

facesChanged

Raised for each new ARFace detected in the environment.

Declaration

[Obsolete("facesChanged has been deprecated in AR Foundation version 6.0. Use trackablesChanged instead.", false)]
public event Action<ARFacesChangedEventArgs> facesChanged

Event Type

Type	Description
Action<ARFacesChangedEventArgs>

Implements

ITrackablesChanged<TTrackable>