docs.unity3d.com
    Show / Hide Table of Contents

    Enum TrackableType

    Flags that represent trackable types in XR. A trackable is feature in the physical environment that a device is able to track, such as a surface. Often used in conjunction with XRRaycastHit.

    Namespace: UnityEngine.XR.ARSubsystems
    Syntax
    [Flags]
    public enum TrackableType

    Fields

    Name Description Value
    AllTypes

    Refers to all trackable types.


    -1
    None

    No trackable.


    0
    PlaneWithinPolygon

    Refers to the 2D convex shape associated with a plane's boundary points.


    When used as the trackableTypeMask in a Raycast(Ray, TrackableType, Allocator), the ray is considered to have hit if the ray intersects with the polygon described by the exact boundary of the plane.

    1
    PlaneWithinBounds

    Refers to the 2D rectangular bounding box that tightly encloses the plane's polygon.


    When used as the trackableTypeMask in a Raycast(Ray, TrackableType, Allocator), the ray is considered to have hit if the ray intersects with the 2D box described by the size of the plane.

    2
    PlaneWithinInfinity

    Refers to the infinite plane described by its Pose (a position and orientation).


    When used as the trackableTypeMask in a Raycast(Ray, TrackableType, Allocator), the ray is considered to have hit if the ray intersects with the infinite plane.

    4
    PlaneEstimated

    Refers to an estimated plane.


    When used as the trackableTypeMask in a Raycast(Ray, TrackableType, Allocator), the ray is considered to have hit if the ray intersects with an estimated plane. An estimated plane is implementation-defined, but might not have an exact boundary. It is a guess that suggests the ray is near a surface.

    8
    Planes

    Refers to any of the plane type trackables.


    Often used with the trackableTypeMask in a Raycast(Ray, TrackableType, Allocator), the ray is considered to have hit if the ray intersects with any of the plane types.

    15
    FeaturePoint

    Refers to a feature point (that is, a point in a point cloud).


    When used as the trackableTypeMask in a Raycast(Ray, TrackableType, Allocator), the ray is considered to have hit if a cone around the ray intersects with a point in a point cloud.

    16
    Image

    Refers to a tracked image.


    32
    Face

    Refers to a tracked face.


    64
    All

    Deprecated in favor of AllTypes. Refers to all trackable types except Depth.


    127
    Depth

    Refers to a point in the depth map.


    128
    Back to top
    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