Struct XRFace | AR Subsystems | 3.0.0
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 XRFace defaultValue { get; }
    Property Value
    Type Description
    XRFace

    fixationPoint

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

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

    leftEyePose

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

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

    nativePtr

    A native pointer associated with this XRFace.

    Declaration
    public 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 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 Pose rightEyePose { get; }
    Property Value
    Type Description
    Pose

    trackableId

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

    Declaration
    public 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 TrackingState trackingState { get; }
    Property Value
    Type Description
    TrackingState
    Implements
    ITrackable.trackingState

    Methods

    Equals(Object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    Object obj
    Returns
    Type Description
    Boolean
    Overrides
    ValueType.Equals(Object)

    Equals(XRFace)

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

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32
    Overrides
    ValueType.GetHashCode()

    Operators

    Equality(XRFace, XRFace)

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

    Inequality(XRFace, XRFace)

    Declaration
    public static bool operator !=(XRFace lhs, XRFace rhs)
    Parameters
    Type Name Description
    XRFace lhs
    XRFace rhs
    Returns
    Type Description
    Boolean
    Back to top Copyright © 2019 Unity Technologies
    Generated by DocFX