Struct XRHumanBodyJoint

Containter for the human body joint data.

Namespace: UnityEngine.XR.ARSubsystems

Syntax

public struct XRHumanBodyJoint : IEquatable<XRHumanBodyJoint>

Constructors

XRHumanBodyJoint(Int32, Int32, Vector3, Pose, Vector3, Pose, Boolean)

Construct the human body joint.

Declaration

public XRHumanBodyJoint(int index, int parentIndex, Vector3 localScale, Pose localPose, Vector3 anchorScale, Pose anchorPose, bool tracked)

Parameters

Type	Name	Description
Int32	index	The index for the joint in the skeleton.
Int32	parentIndex	The index for the parent joint in the skeleton.
Vector3	localScale	The scale relative to the parent joint.
Pose	localPose	The pose relative to the parent joint.
Vector3	anchorScale	The scale relative to the human body origin.
Pose	anchorPose	The pose relative to the human body origin.
Boolean	tracked	Whether the joint is tracked.

Properties

anchorPose

The pose relative to the human body origin.

Declaration

public readonly Pose anchorPose { get; }

Property Value

Type	Description
Pose	The pose relative to the human body origin.

anchorScale

The scale relative to the human body origin.

Declaration

public readonly Vector3 anchorScale { get; }

Property Value

Type	Description
Vector3	The scale relative to the human body origin.

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.

localPose

The pose relative to the parent joint.

Declaration

public readonly Pose localPose { get; }

Property Value

Type	Description
Pose	The pose relative to the parent joint.

localScale

The scale relative to the parent joint.

Declaration

public readonly Vector3 localScale { get; }

Property Value

Type	Description
Vector3	The scale relative to the parent joint.

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 parent index that is negative represents that the joint has no parent in the hierachy.

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

Overrides

ValueType.Equals(Object)

Equals(XRHumanBodyJoint)

Tests for equality.

Declaration

public bool Equals(XRHumanBodyJoint other)

Parameters

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

Returns

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

ToString()

Generates a string representation of this XRHumanBodyJoint. Floating point values using the "F5" format specifier.

Declaration

public override string ToString()

Returns

Type	Description
String	A string representation of this XRHumanBodyJoint.

Overrides

ValueType.ToString()

ToString(String)

Generates a string representation of this XRHumanBodyJoint.

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 XRHumanBodyJoint.

Operators

Equality(XRHumanBodyJoint, XRHumanBodyJoint)

Tests for equality. Same as Equals(XRHumanBodyJoint).

Declaration

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

Parameters

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

Returns

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

Inequality(XRHumanBodyJoint, XRHumanBodyJoint)

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

Declaration

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

Parameters

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

Returns

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