Struct XRTrackedImage
Contains low-level data for a tracked image in the environment.
Inherited Members
Namespace: UnityEngine .XR.ARSubsystems
Assembly: Unity.XR.ARSubsystems.dll
Syntax
public struct XRTrackedImage : ITrackable, IEquatable<XRTrackedImage>
Constructors
XRTrackedImage(TrackableId, Guid, Pose, Vector2, TrackingState, IntPtr)
Constructs an XRTracked
Declaration
public XRTrackedImage(TrackableId trackableId, Guid sourceImageId, Pose pose, Vector2 size, TrackingState trackingState, IntPtr nativePtr)
Parameters
Type | Name | Description |
---|---|---|
Trackable |
trackableId | The Trackable |
Guid | sourceImageId | A |
Pose | pose | The |
Vector2 | size | The size (dimensions) of the detected image. |
Tracking |
trackingState | The Tracking |
Int |
nativePtr | A native pointer associated with the detected image. |
Properties
defaultValue
Generates a XRTracked
Declaration
public static XRTrackedImage defaultValue { get; }
Property Value
Type | Description |
---|---|
XRTracked |
nativePtr
A native pointer associated with this tracked image.
The data pointed to by this pointer is implementation-defined.
While its lifetime is also implementation-defined, it should be
valid at least until the next call to
Get
Declaration
public IntPtr nativePtr { get; }
Property Value
Type | Description |
---|---|
Int |
pose
The Pose
associated with this tracked image.
Declaration
public Pose pose { get; }
Property Value
Type | Description |
---|---|
Pose |
size
The size (dimensions) of this tracked image.
Declaration
public Vector2 size { get; }
Property Value
Type | Description |
---|---|
Vector2 |
sourceImageId
The GUID
associated with the source image.
Declaration
public Guid sourceImageId { get; }
Property Value
Type | Description |
---|---|
Guid |
trackableId
The Trackable
Declaration
public TrackableId trackableId { get; }
Property Value
Type | Description |
---|---|
Trackable |
trackingState
The Tracking
Declaration
public TrackingState trackingState { get; }
Property Value
Type | Description |
---|---|
Tracking |
Methods
Equals(object)
Tests for equality.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
object | obj | The |
Returns
Type | Description |
---|---|
bool |
|
Overrides
Equals(XRTrackedImage)
Tests for equality.
Declaration
public bool Equals(XRTrackedImage other)
Parameters
Type | Name | Description |
---|---|---|
XRTracked |
other | The other XRTracked |
Returns
Type | Description |
---|---|
bool |
|
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
Operators
operator ==(XRTrackedImage, XRTrackedImage)
Tests for equality. Same as Equals(XRTracked
Declaration
public static bool operator ==(XRTrackedImage lhs, XRTrackedImage rhs)
Parameters
Type | Name | Description |
---|---|---|
XRTracked |
lhs | The left-hand side of the comparison. |
XRTracked |
rhs | The right-hand side of the comparison. |
Returns
Type | Description |
---|---|
bool |
|
operator !=(XRTrackedImage, XRTrackedImage)
Tests for inequality. Same as !
Equals(XRTracked
Declaration
public static bool operator !=(XRTrackedImage lhs, XRTrackedImage rhs)
Parameters
Type | Name | Description |
---|---|---|
XRTracked |
lhs | The left-hand side of the comparison. |
XRTracked |
rhs | The right-hand side of the comparison. |
Returns
Type | Description |
---|---|
bool |
|