Struct XRAnchor

Describes session-relative data for an anchor.

Implements
Inherited Members
Namespace: UnityEngine.XR.ARSubsystems
Assembly: Unity.XR.ARSubsystems.dll
Syntax
public struct XRAnchor : ITrackable, IEquatable<XRAnchor>

Constructors

XRAnchor(TrackableId, Pose, TrackingState, IntPtr)

Constructs the session-relative data for an anchor. This is typically provided by an implementation of the XRAnchorSubsystem and not invoked directly.

Declaration
public XRAnchor(TrackableId trackableId, Pose pose, TrackingState trackingState, IntPtr nativePtr)
Parameters
Type Name Description
TrackableId trackableId

The TrackableId associated with this anchor.
Pose pose

The Pose, in session space, of the anchor.
TrackingState trackingState

The TrackingState of the anchor.
IntPtr nativePtr

A native pointer associated with the anchor. The data pointed to by this pointer is implementation-specific.
See Also

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

Constructs the session-relative data for anchor. This is typically provided by an implementation of the XRAnchorSubsystem and not invoked directly.

Declaration
public XRAnchor(TrackableId trackableId, Pose pose, TrackingState trackingState, IntPtr nativePtr, Guid sessionId)
Parameters
Type Name Description
TrackableId trackableId

The TrackableId associated with this anchor.
Pose pose

The Pose, in session space, of the anchor.
TrackingState trackingState

The TrackingState of the anchor.
IntPtr nativePtr

A native pointer associated with the anchor. The data pointed to by this pointer is implementation-specific.
Guid sessionId

The session from which this anchor originated.
See Also

Properties

defaultValue

Gets a default-initialized XRAnchor. This may be different from the zero-initialized version (for example, the pose is Pose.identity instead of zero-initialized).

Declaration
public static XRAnchor defaultValue { get; }
Property Value
Type Description
XRAnchor
See Also

nativePtr

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

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

pose

Get the Pose, in session space, for this anchor.

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

sessionId

The id of the session from which this anchor originated.

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

trackableId

Get the TrackableId associated with this anchor.

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

trackingState

Get the TrackingState of this anchor.

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

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
bool

True if obj is of type XRAnchor and Equals(XRAnchor) also returns true; otherwise false.
Overrides
See Also

Equals(XRAnchor)

Tests for equality.

Declaration
public bool Equals(XRAnchor other)
Parameters
Type Name Description
XRAnchor other

The other XRAnchor to compare against.
Returns
Type Description
bool

True if every field in other is equal to this XRAnchor, otherwise false.
See Also

GetHashCode()

Generates a hash suitable for use with containers like HashSet and Dictionary.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code generated from this object's fields.
Overrides
See Also

Operators

operator ==(XRAnchor, XRAnchor)

Tests for equality. Same as Equals(XRAnchor).

Declaration
public static bool operator ==(XRAnchor lhs, XRAnchor rhs)
Parameters
Type Name Description
XRAnchor lhs

The left-hand side of the comparison.
XRAnchor rhs

The right-hand side of the comparison.
Returns
Type Description
bool

True if lhs is equal to rhs, otherwise false.
See Also

operator !=(XRAnchor, XRAnchor)

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

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

The left-hand side of the comparison.
XRAnchor rhs

The right-hand side of the comparison.
Returns
Type Description
bool

True if lhs is not equal to rhs, otherwise false.
See Also

Implements

See Also