Struct XRReferencePoint

Describes session relative data for a reference point.

Namespace: UnityEngine.XR.ARSubsystems

Syntax

[Obsolete("XRReferencePoint has been deprecated. Use XRAnchor instead (UnityUpgradable) -> UnityEngine.XR.ARSubsystems.XRAnchor", true)]
public struct XRReferencePoint : ITrackable, IEquatable<XRReferencePoint>

Constructors

XRReferencePoint(TrackableId, Pose, TrackingState, IntPtr)

Constructs the session relative data for reference point. This is typically provided by an implementation of the XRReferencePointSubsystem and not invoked directly.

Declaration

public XRReferencePoint(TrackableId trackableId, Pose pose, TrackingState trackingState, IntPtr nativePtr)

Parameters

Type	Name	Description
TrackableId	trackableId	The TrackableId associated with this reference point.
Pose	pose	The Pose, in session space, of the reference point.
TrackingState	trackingState	The TrackingState of the reference point.
IntPtr	nativePtr	A native pointer associated with the reference point. The data pointed to by this pointer is implementation-specific.

XRReferencePoint(TrackableId, Pose, TrackingState, IntPtr, Guid)

Constructs the session relative data for reference point. This is typically provided by an implementation of the XRReferencePointSubsystem and not invoked directly.

Declaration

public XRReferencePoint(TrackableId trackableId, Pose pose, TrackingState trackingState, IntPtr nativePtr, Guid sessionId)

Parameters

Type	Name	Description
TrackableId	trackableId	The TrackableId associated with this reference point.
Pose	pose	The Pose, in session space, of the reference point.
TrackingState	trackingState	The TrackingState of the reference point.
IntPtr	nativePtr	A native pointer associated with the reference point. The data pointed to by this pointer is implementation-specific.
Guid	sessionId	The session from which this reference point originated.

Properties

defaultValue

Gets a default-initialized XRReferencePoint. This may be different from the zero-initialized version, e.g., the pose is Pose.identity instead of zero-initialized.

Declaration

public static readonly XRReferencePoint defaultValue { get; }

Property Value

Type	Description
XRReferencePoint

nativePtr

A native pointer associated with the reference point. The data pointed to by this pointer is implementation-specific.

Declaration

public readonly IntPtr nativePtr { get; }

Property Value

Type	Description
IntPtr

Implements

ITrackable.nativePtr

pose

Get the Pose, in session space, for this reference point.

Declaration

public readonly Pose pose { get; }

Property Value

Type	Description
Pose

Implements

ITrackable.pose

sessionId

The id of the session from which this reference point originated.

Declaration

public readonly Guid sessionId { get; }

Property Value

Type	Description
Guid

trackableId

Get the TrackableId associated with this reference point.

Declaration

public readonly TrackableId trackableId { get; }

Property Value

Type	Description
TrackableId

Implements

ITrackable.trackableId

trackingState

Get the TrackingState of this reference point.

Declaration

public readonly TrackingState trackingState { get; }

Property Value

Type	Description
TrackingState

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

Overrides

ValueType.Equals(Object)

Equals(XRReferencePoint)

Tests for equality.

Declaration

public bool Equals(XRReferencePoint other)

Parameters

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

Returns

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

Operators

Equality(XRReferencePoint, XRReferencePoint)

Tests for equality. Same as Equals(XRReferencePoint).

Declaration

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

Parameters

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

Returns

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

Inequality(XRReferencePoint, XRReferencePoint)

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

Declaration

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

Parameters

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

Returns

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

See Also

XRReferencePointSubsystem