Struct XRHumanBodyPose2DJoint | AR Subsystems | 2.2.0-preview.6
docs.unity3d.com
    Show / Hide Table of Contents

    Struct XRHumanBodyPose2DJoint

    Container for a human body pose 2D joint as part of a AR detected screen space skeleton.

    Namespace: UnityEngine.XR.ARSubsystems
    Syntax
    public struct XRHumanBodyPose2DJoint : IEquatable<XRHumanBodyPose2DJoint>

    Constructors

    XRHumanBodyPose2DJoint(Int32, Int32, Vector2, Boolean)

    Constructs a XRHumanBodyPose2DJoint with the given parameters.

    Declaration
    public XRHumanBodyPose2DJoint(int index, int parentIndex, Vector2 position, bool tracked)
    Parameters
    Type Name Description
    Int32 index

    The index of the joint in the skeleton hierachy.

    Int32 parentIndex

    The index of the parent joint in the skeleton hierarchy.

    Vector2 position

    The position of the joint in 2D screenspace.

    Boolean tracked

    Whether the joint is tracked.

    Properties

    index

    The index for the joint in the skeleton hierachy.

    Declaration
    public int index { get; }
    Property Value
    Type Description
    Int32

    The index for the joint in the skeleton hierachy.

    Remarks

    All indices will be non-negative.

    parentIndex

    The index for the parent joint in the skeleton hierachy.

    Declaration
    public int parentIndex { get; }
    Property Value
    Type Description
    Int32

    The index for the parent joint in the skeleton hierachy.

    Remarks

    A parent index that is negative represents that the joint has no parent in the hierachy.

    position

    The position of the joint in 2D screenspace.

    Declaration
    public Vector2 position { get; }
    Property Value
    Type Description
    Vector2

    The position of the joint in 2D screenspace.

    tracked

    Whether the joint is tracked.

    Declaration
    public bool tracked { get; }
    Property Value
    Type Description
    Boolean

    true if the joint is tracked. Otherwise, false.

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

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

    GetHashCode()

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

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    String
    Overrides
    ValueType.ToString()

    ToString(String)

    Declaration
    public string ToString(string format)
    Parameters
    Type Name Description
    String format
    Returns
    Type Description
    String

    Operators

    Equality(XRHumanBodyPose2DJoint, XRHumanBodyPose2DJoint)

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

    Inequality(XRHumanBodyPose2DJoint, XRHumanBodyPose2DJoint)

    Declaration
    public static bool operator !=(XRHumanBodyPose2DJoint lhs, XRHumanBodyPose2DJoint rhs)
    Parameters
    Type Name Description
    XRHumanBodyPose2DJoint lhs
    XRHumanBodyPose2DJoint rhs
    Returns
    Type Description
    Boolean
    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