ARKitPlaneTracker
- Last UpdatedDec 07, 2023
- 3 minute read
The ARKitPlaneTracker node tracks the position and orientation of horizontal or vertical planes in the real world. You can set the ARKitPlaneTracker to track vertical, horizontal, or both planes. If the ARKitPlaneTracker node is active, it will look for the vertical/horizontal planes and will report the detected planes in the planesData field.
Platform support
This node is supported on iOS platform only.
|
XR-WIN |
XR-P-WIN |
XR-P-IOS |
XR-P-AND |
XR-P-WASM |
|---|---|---|---|---|
|
No support |
No support |
Full support |
No support |
No support |
|
|
|
|
|
|
Limitations
Since the ARKitPlaneTracker node is based on Apple ARKit APIs, it has the same restrictions as Apple ARKit. ARKit is only available on devices running A9 and more powerful processors: essentially iPhone 6S and newer, iPad Pros, and iPads released no earlier than 2017.
Code example
This is a code example for the ARKitPlaneTracker node.
<ARKitPlaneTracker name="ar_plane_tracker_vertical" active="false" trackMode="vertical"/>
Fields
These are the fields for the ARKitImageTracker node. Only the node-specific fields are indicated, not fields obtained by inheritance.
Field inheritance: NodeBase > ARKitPlaneTracker
|
Fields |
Type |
Use |
Default |
Description |
|---|---|---|---|---|
|
active |
sbool |
Mandatory |
|
If active, the plane tracking is turned ON and the plane details are updated each frame. |
|
isPlanesDetected |
sbool |
Read-only |
|
This field indicates whether a plane has been detected in the AR Session or not. |
|
planesData |
mdstring |
Read-only |
|
This field reports detected planes and their details. Each plane is represented by its anchorId identifier. For each detected plane, the following elements are made available in the planesData field: center, extents, alignment, matrix.
|
|
trackMode |
senum |
Mandatory |
The type of the plane to be tracked. The value of this field can be either horizontal, vertical, or both. |