Struct TrackableId

A session-unique identifier for trackables in the real-world environment, such as planes and feature points.

Inherited Members

Namespace: UnityEngine.XR.ARSubsystems

Syntax

public struct TrackableId : IEquatable<TrackableId>

Remarks

Ids are generally unique to a particular session, but multiple sessions might produce identical ids for different trackables.

A trackable id is a 128 bit number, stored as two ulongs. This makes it large enough to hold a Guid.

Constructors

TrackableId(String)

Construct a trackable identifier by parsing the given identifier string.

Declaration

public TrackableId(string idString)

Parameters

Type	Name	Description
String	idString	An identifier string.

Exceptions

Type	Condition
FormatException	Thrown if the given identifier string cannot be parsed.

TrackableId(UInt64, UInt64)

Constructs a TrackableId from two ulongs.

Declaration

public TrackableId(ulong subId1, ulong subId2)

Parameters

Type	Name	Description
UInt64	subId1	The first half of the id.
UInt64	subId2	The second half of the id.

Properties

invalidId

Get the invalid id.

Declaration

public static readonly TrackableId invalidId { get; }

Property Value

Type	Description
TrackableId

subId1

The first half of the id.

Declaration

public ulong subId1 { get; set; }

Property Value

Type	Description
UInt64

subId2

The second half of the id.

Declaration

public ulong subId2 { get; set; }

Property Value

Type	Description
UInt64

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

Overrides

ValueType.Equals(Object)

Equals(TrackableId)

Tests for equality.

Declaration

public bool Equals(TrackableId other)

Parameters

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

Returns

Type	Description
Boolean	`True` if every field in `other` is equal to this TrackableId, otherwise `false`.

Implements

IEquatable<T>.Equals(T)

GetHashCode()

Generates a hash code suitable for use in a Dictionary or Set.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32	A hash code for participation in certain collections.

Overrides

ValueType.GetHashCode()

ToString()

Generates a string representation of the id suitable for debugging.

Declaration

public override string ToString()

Returns

Type	Description
String	A string representation of the id.

Overrides

ValueType.ToString()

Operators

Equality(TrackableId, TrackableId)

Tests for equality. Same as Equals(TrackableId).

Declaration

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

Parameters

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

Returns

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

Inequality(TrackableId, TrackableId)

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

Declaration

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

Parameters

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

Returns

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