Struct XRReferencePoint

Describes session relative data for a reference point.

Namespace: UnityEngine.XR.ARSubsystems
Syntax
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

nativePtr

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

Declaration
public IntPtr nativePtr { get; }
Property Value
Type Description
IntPtr

pose

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

Declaration
public Pose pose { get; }
Property Value
Type Description
Pose
Implements

sessionId

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

Declaration
public Guid sessionId { get; }
Property Value
Type Description
Guid

trackableId

Get the TrackableId associated with this reference point.

Declaration
public TrackableId trackableId { get; }
Property Value
Type Description
TrackableId
Implements

trackingState

Get the TrackingState of this reference point.

Declaration
public TrackingState trackingState { get; }
Property Value
Type Description
TrackingState
Implements

Methods

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
Overrides

Equals(XRReferencePoint)

Declaration
public bool Equals(XRReferencePoint other)
Parameters
Type Name Description
XRReferencePoint other
Returns
Type Description
Boolean

GetDefault()

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 XRReferencePoint GetDefault()
Returns
Type Description
XRReferencePoint

A default XRReferencePoint.

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides

Operators

Equality(XRReferencePoint, XRReferencePoint)

Declaration
public static bool operator ==(XRReferencePoint lhs, XRReferencePoint rhs)
Parameters
Type Name Description
XRReferencePoint lhs
XRReferencePoint rhs
Returns
Type Description
Boolean

Inequality(XRReferencePoint, XRReferencePoint)

Declaration
public static bool operator !=(XRReferencePoint lhs, XRReferencePoint rhs)
Parameters
Type Name Description
XRReferencePoint lhs
XRReferencePoint rhs
Returns
Type Description
Boolean

See Also