docs.unity3d.com
    Show / Hide Table of Contents

    Struct XRFace

    A struct describing face data that is stored in the XRFaceSubsystem

    Namespace: UnityEngine.XR.ARSubsystems
    Syntax
    public struct XRFace : ITrackable, IEquatable<XRFace>

    Properties

    defaultValue

    Get a XRFace with reasonable default values.

    Declaration
    public static readonly XRFace defaultValue { get; }
    Property Value
    Type Description
    XRFace

    fixationPoint

    The position of which the eyes are fixated in relation to the face.

    Declaration
    public readonly Vector3 fixationPoint { get; }
    Property Value
    Type Description
    Vector3

    leftEyePose

    The pose of the left eye in relation to the face.

    Declaration
    public readonly Pose leftEyePose { get; }
    Property Value
    Type Description
    Pose

    nativePtr

    A native pointer associated with this XRFace.

    Declaration
    public readonly IntPtr nativePtr { get; }
    Property Value
    Type Description
    IntPtr
    Implements
    ITrackable.nativePtr
    Remarks

    The data pointed to by this pointer is implementation-defined.

    pose

    The pose of the face describes its position and rotation in session space.

    Declaration
    public readonly Pose pose { get; }
    Property Value
    Type Description
    Pose
    Implements
    ITrackable.pose

    rightEyePose

    The pose of the right eye in relation to the face.

    Declaration
    public readonly Pose rightEyePose { get; }
    Property Value
    Type Description
    Pose

    trackableId

    The unique TrackableId of the face as a trackable within the XRFaceSubsystem.

    Declaration
    public readonly TrackableId trackableId { get; }
    Property Value
    Type Description
    TrackableId
    Implements
    ITrackable.trackableId
    Remarks

    With this, you are able to extract more data about this particular face from the XRFaceSubsystem.

    trackingState

    The tracking state associated with this XRFace.

    Declaration
    public readonly TrackingState trackingState { get; }
    Property Value
    Type Description
    TrackingState
    Implements
    ITrackable.trackingState

    Methods

    Equals(Object)

    Tests for equality.

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    Object obj

    The object to compare against.

    Returns
    Type Description
    Boolean

    True if obj is of type XRFace and Equals(XRFace) also returns true; otherwise false.

    Overrides
    ValueType.Equals(Object)

    Equals(XRFace)

    Tests for equality.

    Declaration
    public bool Equals(XRFace other)
    Parameters
    Type Name Description
    XRFace other

    The other XRFace to compare against.

    Returns
    Type Description
    Boolean

    True if every field in other is equal to this XRFace, otherwise false.

    GetHashCode()

    Generates a hash suitable for use with containers like HashSet and Dictionary.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32

    A hash code generated from this object's fields.

    Overrides
    ValueType.GetHashCode()

    Operators

    Equality(XRFace, XRFace)

    Tests for equality. Same as Equals(XRFace).

    Declaration
    public static bool operator ==(XRFace lhs, XRFace rhs)
    Parameters
    Type Name Description
    XRFace lhs

    The left-hand side of the comparison.

    XRFace rhs

    The right-hand side of the comparison.

    Returns
    Type Description
    Boolean

    True if lhs is equal to rhs, otherwise false.

    Inequality(XRFace, XRFace)

    Tests for inequality. Same as !Equals(XRFace).

    Declaration
    public static bool operator !=(XRFace lhs, XRFace rhs)
    Parameters
    Type Name Description
    XRFace lhs

    The left-hand side of the comparison.

    XRFace rhs

    The right-hand side of the comparison.

    Returns
    Type Description
    Boolean

    True if lhs is not equal to rhs, otherwise false.

    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