docs.unity3d.com
    Show / Hide Table of Contents

    Class ARFace

    Represents a face detected by an AR device.

    Inheritance
    Object
    Object
    Component
    Behaviour
    MonoBehaviour
    ARTrackable
    ARTrackable<XRFace, ARFace>
    ARFace
    Inherited Members
    ARTrackable<XRFace, ARFace>.destroyOnRemoval
    ARTrackable<XRFace, ARFace>.trackableId
    ARTrackable<XRFace, ARFace>.trackingState
    ARTrackable<XRFace, ARFace>.pending
    ARTrackable<XRFace, ARFace>.sessionRelativeData
    ARTrackable<XRFace, ARFace>.OnAfterSetSessionRelativeData()
    MonoBehaviour.IsInvoking()
    MonoBehaviour.CancelInvoke()
    MonoBehaviour.Invoke(String, Single)
    MonoBehaviour.InvokeRepeating(String, Single, Single)
    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.useGUILayout
    MonoBehaviour.runInEditMode
    Behaviour.enabled
    Behaviour.isActiveAndEnabled
    Component.GetComponent(Type)
    Component.GetComponent<T>()
    Component.TryGetComponent(Type, Component)
    Component.TryGetComponent<T>(T)
    Component.GetComponent(String)
    Component.GetComponentInChildren(Type, Boolean)
    Component.GetComponentInChildren(Type)
    Component.GetComponentInChildren<T>(Boolean)
    Component.GetComponentInChildren<T>()
    Component.GetComponentsInChildren(Type, Boolean)
    Component.GetComponentsInChildren(Type)
    Component.GetComponentsInChildren<T>(Boolean)
    Component.GetComponentsInChildren<T>(Boolean, List<T>)
    Component.GetComponentsInChildren<T>()
    Component.GetComponentsInChildren<T>(List<T>)
    Component.GetComponentInParent(Type)
    Component.GetComponentInParent<T>()
    Component.GetComponentsInParent(Type, Boolean)
    Component.GetComponentsInParent(Type)
    Component.GetComponentsInParent<T>(Boolean)
    Component.GetComponentsInParent<T>(Boolean, List<T>)
    Component.GetComponentsInParent<T>()
    Component.GetComponents(Type)
    Component.GetComponents(Type, List<Component>)
    Component.GetComponents<T>(List<T>)
    Component.GetComponents<T>()
    Component.CompareTag(String)
    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
    Component.rigidbody
    Component.rigidbody2D
    Component.camera
    Component.light
    Component.animation
    Component.constantForce
    Component.renderer
    Component.audio
    Component.networkView
    Component.collider
    Component.collider2D
    Component.hingeJoint
    Component.particleSystem
    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, Boolean)
    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, Boolean)
    Object.Destroy(Object, Single)
    Object.Destroy(Object)
    Object.DestroyImmediate(Object, Boolean)
    Object.DestroyImmediate(Object)
    Object.FindObjectsOfType(Type)
    Object.DontDestroyOnLoad(Object)
    Object.DestroyObject(Object, Single)
    Object.DestroyObject(Object)
    Object.FindSceneObjectsOfType(Type)
    Object.FindObjectsOfTypeIncludingAssets(Type)
    Object.FindObjectsOfType<T>()
    Object.FindObjectOfType<T>()
    Object.FindObjectsOfTypeAll(Type)
    Object.FindObjectOfType(Type)
    Object.ToString()
    Object.name
    Object.hideFlags
    Namespace: UnityEngine.XR.ARFoundation
    Syntax
    [DisallowMultipleComponent]
    [DefaultExecutionOrder(-2147483646)]
    [HelpURL("https://docs.unity3d.com/Packages/com.unity.xr.arfoundation@4.1/api/UnityEngine.XR.ARFoundation.ARFace.html")]
    public sealed class ARFace : ARTrackable<XRFace, ARFace>
    Remarks

    Generated by the ARFaceManager when an AR device detects a face in the environment.

    Properties

    fixationPoint

    The transform representing the point at which the eyes are fixated upon or null if there is no fixation data.

    Declaration
    public Transform fixationPoint { get; }
    Property Value
    Type Description
    Transform

    indices

    The indices defining the triangles of the face mesh. Check for existence with indices.IsCreated. The are three times as many indices as triangles, so this will always be a multiple of 3.

    Declaration
    public NativeArray<int> indices { get; }
    Property Value
    Type Description
    NativeArray<Int32>

    leftEye

    The transform of the left eye of the face, or null if there is no data for the left eye.

    Declaration
    public Transform leftEye { get; }
    Property Value
    Type Description
    Transform

    nativePtr

    Get a native pointer associated with this face.

    Declaration
    public IntPtr nativePtr { get; }
    Property Value
    Type Description
    IntPtr
    Remarks

    The data pointed to by this member is implementation defined. The lifetime of the pointed to object is also implementation defined, but should be valid at least until the next ARSession update.

    normals

    The normals representing the face mesh. Check for existence with normals.IsCreated. This array is parallel to vertices and uvs.

    Declaration
    public NativeArray<Vector3> normals { get; }
    Property Value
    Type Description
    NativeArray<Vector3>

    rightEye

    The transform of the right eye of the face, or null if there is no data for the right eye.

    Declaration
    public Transform rightEye { get; }
    Property Value
    Type Description
    Transform

    uvs

    The texture coordinates representing the face mesh. Check for existence with uvs.IsCreated. This array is parallel to vertices and normals.

    Declaration
    public NativeArray<Vector2> uvs { get; }
    Property Value
    Type Description
    NativeArray<Vector2>

    vertices

    The vertices representing the face mesh. Check for existence with vertices.IsCreated. This array is parallel to normals and uvs. Vertices are provided in face space, that is, relative to this ARFace's local position and rotation.

    Declaration
    public NativeArray<Vector3> vertices { get; }
    Property Value
    Type Description
    NativeArray<Vector3>

    Events

    updated

    Invoked when the face is updated. If face meshes are supported, there will be updated vertices, normals, indices, and uvs.

    Declaration
    public event Action<ARFaceUpdatedEventArgs> updated
    Event Type
    Type Description
    Action<ARFaceUpdatedEventArgs>
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023