docs.unity3d.com
    Show / Hide Table of Contents

    Struct XRTrackedImage

    Contains low-level data for a tracked image in the environment.

    Namespace: UnityEngine.XR.ARSubsystems
    Syntax
    public struct XRTrackedImage : ITrackable, IEquatable<XRTrackedImage>

    Constructors

    XRTrackedImage(TrackableId, Guid, Pose, Vector2, TrackingState, IntPtr)

    Constructs an XRTrackedImage.

    Declaration
    public XRTrackedImage(TrackableId trackableId, Guid sourceImageId, Pose pose, Vector2 size, TrackingState trackingState, IntPtr nativePtr)
    Parameters
    Type Name Description
    TrackableId trackableId

    The TrackableId associated with this tracked image.

    Guid sourceImageId

    A GUID associated with the source image.

    Pose pose

    The Pose associated with the detected image.

    Vector2 size

    The size (i.e., dimensions) of the detected image.

    TrackingState trackingState

    The TrackingState of the detected image.

    IntPtr nativePtr

    A native pointer associated with the detected image.

    Properties

    defaultValue

    Generates a XRTrackedImage populated with default values.

    Declaration
    public static readonly XRTrackedImage defaultValue { get; }
    Property Value
    Type Description
    XRTrackedImage

    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 GetChanges(Allocator).

    Declaration
    public readonly IntPtr nativePtr { get; }
    Property Value
    Type Description
    IntPtr
    Implements
    ITrackable.nativePtr

    pose

    The Pose associated with this tracked image.

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

    size

    The size (i.e., dimensions) of this tracked image.

    Declaration
    public readonly Vector2 size { get; }
    Property Value
    Type Description
    Vector2

    sourceImageId

    The GUID associated with the source image.

    Declaration
    public readonly Guid sourceImageId { get; }
    Property Value
    Type Description
    Guid

    trackableId

    The TrackableId associated with this tracked image.

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

    trackingState

    The TrackingState associated with this tracked image.

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

    Overrides
    ValueType.Equals(Object)

    Equals(XRTrackedImage)

    Tests for equality.

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

    The other XRTrackedImage to compare against.

    Returns
    Type Description
    Boolean

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

    Tests for equality. Same as Equals(XRTrackedImage).

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

    The left-hand side of the comparison.

    XRTrackedImage rhs

    The right-hand side of the comparison.

    Returns
    Type Description
    Boolean

    True if lhs is equal to rhs, otherwise false.

    Inequality(XRTrackedImage, XRTrackedImage)

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

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

    The left-hand side of the comparison.

    XRTrackedImage rhs

    The right-hand side of the comparison.

    Returns
    Type Description
    Boolean

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

    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023