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 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 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 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 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 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 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 bool tracked { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
|
Methods
Equals(Object)
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| Object | obj |
Returns
| Type | Description |
|---|---|
| Boolean |
Overrides
Equals(XRHumanBodyJoint)
Declaration
public bool Equals(XRHumanBodyJoint other)Parameters
| Type | Name | Description |
|---|---|---|
| XRHumanBodyJoint | other |
Returns
| Type | Description |
|---|---|
| Boolean |
GetHashCode()
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| Int32 |
Overrides
ToString()
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| String |
Overrides
ToString(String)
Declaration
public string ToString(string format)Parameters
| Type | Name | Description |
|---|---|---|
| String | format |
Returns
| Type | Description |
|---|---|
| String |
Operators
Equality(XRHumanBodyJoint, XRHumanBodyJoint)
Declaration
public static bool operator ==(XRHumanBodyJoint lhs, XRHumanBodyJoint rhs)Parameters
| Type | Name | Description |
|---|---|---|
| XRHumanBodyJoint | lhs | |
| XRHumanBodyJoint | rhs |
Returns
| Type | Description |
|---|---|
| Boolean |
Inequality(XRHumanBodyJoint, XRHumanBodyJoint)
Declaration
public static bool operator !=(XRHumanBodyJoint lhs, XRHumanBodyJoint rhs)Parameters
| Type | Name | Description |
|---|---|---|
| XRHumanBodyJoint | lhs | |
| XRHumanBodyJoint | rhs |
Returns
| Type | Description |
|---|---|
| Boolean |