docs.unity3d.com
    Show / Hide Table of Contents

    Struct ARCoreFaceRegionData

    Holds data associated with a face "region".

    Inherited Members
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: UnityEngine.XR.ARCore
    Syntax
    public struct ARCoreFaceRegionData : IEquatable<ARCoreFaceRegionData>

    Constructors

    ARCoreFaceRegionData(ARCoreFaceRegion, Pose)

    Constructs an ARCoreFaceRegionData.

    Declaration
    public ARCoreFaceRegionData(ARCoreFaceRegion region, Pose pose)
    Parameters
    Type Name Description
    ARCoreFaceRegion region

    The region this data describes.

    UnityEngine.Pose pose

    The pose associated with the given region.

    Properties

    pose

    The pose associated with the face region.

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

    Provides the 3D orientation of the region.

    region

    The region this data describes.

    Declaration
    public readonly ARCoreFaceRegion region { get; }
    Property Value
    Type Description
    ARCoreFaceRegion

    Identifies which part of the face this data applies to.

    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 ARCoreFaceRegionData and Equals(ARCoreFaceRegionData) also returns true; otherwise false.

    Overrides
    ValueType.Equals(Object)

    Equals(ARCoreFaceRegionData)

    Tests for equality.

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

    The other ARCoreFaceRegionData to compare against.

    Returns
    Type Description
    Boolean

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

    Implements
    IEquatable<T>.Equals(T)

    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()

    ToString()

    Generates a string representation of this ARCoreFaceRegionData.

    Declaration
    public override string ToString()
    Returns
    Type Description
    String

    A string representation of this ARCoreFaceRegionData.

    Overrides
    ValueType.ToString()

    Operators

    Equality(ARCoreFaceRegionData, ARCoreFaceRegionData)

    Tests for equality. Same as Equals(ARCoreFaceRegionData).

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

    The left-hand side of the comparison.

    ARCoreFaceRegionData rhs

    The right-hand side of the comparison.

    Returns
    Type Description
    Boolean

    True if lhs is equal to rhs, otherwise false.

    Inequality(ARCoreFaceRegionData, ARCoreFaceRegionData)

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

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

    The left-hand side of the comparison.

    ARCoreFaceRegionData rhs

    The right-hand side of the comparison.

    Returns
    Type Description
    Boolean

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

    See Also

    GetRegionPoses(TrackableId, Allocator, ref NativeArray<ARCoreFaceRegionData>)
    Back to top
    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