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.
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 |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.