docs.unity3d.com
    Show / Hide Table of Contents

    Struct XRHumanBody

    Container for the data representing a trackable human body.

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

    Properties

    defaultValue

    Get the default human body data.

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

    The default human body data.

    estimatedHeightScaleFactor

    The scale factor that relates the implementation's default body height to the estimated height.

    Declaration
    public float estimatedHeightScaleFactor { get; }
    Property Value
    Type Description
    Single

    The scale factor that relates the implementation's default body height to the estimated height.

    nativePtr

    The native pointer to implementation-specific human body.

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

    The native pointer to implementation-specific human body.

    Implements
    ITrackable.nativePtr

    pose

    The pose for the human body origin.

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

    The pose for the human body origin.

    Implements
    ITrackable.pose

    trackableId

    The trackable identifier for the human body.

    Declaration
    public TrackableId trackableId { get; }
    Property Value
    Type Description
    TrackableId

    The trackable identifier for the human body.

    Implements
    ITrackable.trackableId

    trackingState

    The tracking state for the human body.

    Declaration
    public TrackingState trackingState { get; }
    Property Value
    Type Description
    TrackingState

    The tracking state for the human body.

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

    Overrides
    ValueType.Equals(Object)

    Equals(XRHumanBody)

    Tests for equality.

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

    The other XRHumanBody to compare against.

    Returns
    Type Description
    Boolean

    True if every field in other is equal to this XRHumanBody, 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(XRHumanBody, XRHumanBody)

    Tests for equality. Same as Equals(XRHumanBody).

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

    The left-hand side of the comparison.

    XRHumanBody rhs

    The right-hand side of the comparison.

    Returns
    Type Description
    Boolean

    True if lhs is equal to rhs, otherwise false.

    Inequality(XRHumanBody, XRHumanBody)

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

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

    The left-hand side of the comparison.

    XRHumanBody 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