Struct XRHumanBodyPose2DJoint

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

Inherited Members

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.
UnityEngine.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 readonly 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 readonly int parentIndex { get; }

Property Value

Type	Description
Int32	The index for the parent joint in the skeleton hierachy.

Remarks

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

position

The position of the joint in 2D screenspace.

Declaration

public readonly Vector2 position { get; }

Property Value

Type	Description
UnityEngine.Vector2	The position of the joint in 2D screenspace.

tracked

Whether the joint is tracked.

Declaration

public readonly bool tracked { get; }

Property Value

Type	Description
Boolean	`true` if the joint is tracked. Otherwise, `false`.

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

Overrides

ValueType.Equals(Object)

Equals(XRHumanBodyPose2DJoint)

Tests for equality.

Declaration

public bool Equals(XRHumanBodyPose2DJoint other)

Parameters

Type	Name	Description
XRHumanBodyPose2DJoint	other	The other XRHumanBodyPose2DJoint to compare against.

Returns

Type	Description
Boolean	`True` if every field in `other` is equal to this XRHumanBodyPose2DJoint, 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 XRHumanBodyPose2DJoint. Floating point values use the "F5" format specifier.

Declaration

public override string ToString()

Returns

Type	Description
String	A string representation of this XRHumanBodyPose2DJoint.

Overrides

ValueType.ToString()

ToString(String)

Generates a string representation of this XRHumanBodyPose2DJoint.

Declaration

public string ToString(string format)

Parameters

Type	Name	Description
String	format	A format specifier used for the floating point fields.

Returns

Type	Description
String	A string representation of this XRHumanBodyPose2DJoint.

Operators

Equality(XRHumanBodyPose2DJoint, XRHumanBodyPose2DJoint)

Tests for equality. Same as Equals(XRHumanBodyPose2DJoint).

Declaration

public static bool operator ==(XRHumanBodyPose2DJoint lhs, XRHumanBodyPose2DJoint rhs)

Parameters

Type	Name	Description
XRHumanBodyPose2DJoint	lhs	The left-hand side of the comparison.
XRHumanBodyPose2DJoint	rhs	The right-hand side of the comparison.

Returns

Type	Description
Boolean	`True` if `lhs` is equal to `rhs`, otherwise `false`.

Inequality(XRHumanBodyPose2DJoint, XRHumanBodyPose2DJoint)

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

Declaration

public static bool operator !=(XRHumanBodyPose2DJoint lhs, XRHumanBodyPose2DJoint rhs)

Parameters

Type	Name	Description
XRHumanBodyPose2DJoint	lhs	The left-hand side of the comparison.
XRHumanBodyPose2DJoint	rhs	The right-hand side of the comparison.

Returns

Type	Description
Boolean	`True` if `lhs` is not equal to `rhs`, otherwise `false`.