Struct XRHumanBody

Container for the data that represents a trackable human body.

Inherited Members

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 the implementation-specific human body.

Declaration

public IntPtr nativePtr { get; }

Property Value

Type	Description
IntPtr	The native pointer to the 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.

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

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