PlaneTracker

The PlaneTracker class provides functionality for locating a 3D plane based on 2D screen coordinates.

Properties

PropertyDescription
confidence
(get) confidence: StringSignal
(set) (Not Available)


Returns tracking confidence level info.
This value indicates if PlaneTracker is currently tracking and how confident it is in reported results.
Possible values:
- HIGH
- MEDIUM
- LOW
- NOT_TRACKING
trackingMode
(get) trackingMode: SceneModule.TrackingMode
(set) trackingMode: SceneModule.TrackingMode


Specifies if this tracker object should track horizontal plane or moving object.

See Also: PlaneTracker.mode and PlaneTracker.setMode.

Methods

MethodDescription
hitTest
hitTest(screenLocation: Point2D): Point3D


Returns a point on tracked plane in local coordinates of PlaneTracker (in 3D units).
Returns null if tracked plane is not found at given screen point.
trackPoint
trackPoint(screenLocation: Point2D): void
trackPoint(screenX: number, screenY: number): void
trackPoint(screenLocation: Point2DSignal, gestureState: StringSignal): void


PlaneTracker origin is bound to a point in 3d space, located on detected plane.
This method updates PlaneTracker to track 3d point currently under given screen coordiantes.
This also triggers new plane detection, in result this object's transform will be modified.

Version with signal parameters can be used in touch gestures for continuous updating:

TouchGestures.onPan().subscribe(function(gesture) {
planeTracker.trackPoint(gesture.location, gesture.state);
});