CLEAR

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.

boundingBoxVisible (inherited from SceneObjectBase)

(get) boundingBoxVisible: BoolSignal (set) (Not Available)

Represents whether or not the bounding box for the object is visible.

cameraVisibility (inherited from SceneObjectBase)

(get) cameraVisibility: CameraVisibility (set) (Not Available)

Represents the CameraVisibility that contains a set of flags that specify the scene object (and its descendants) visibility depending on the active camera.

hidden (inherited from SceneObjectBase)

(get) hidden: BoolSignal (set) hidden: BoolSignal

Specifies whether the scene object and its descendants are hidden.

identifier (inherited from SceneObjectBase)

(get) identifier: String (set) (Not Available)

Specifies the scene object unique identifier. This value is specified internally in AR Studio.

materialIdentifier (inherited from SceneObjectBase)

(get) materialIdentifier: String (set) (Not Available)

Specifies the unique material identifier assigned to scene object. This value is specified internally in AR Studio.

name (inherited from SceneObjectBase)

(get) name: String (set) (Not Available)

Specifies the scene object name. This is the unique identifier of the object within the list of its siblings (immediate child objects of the same parent object).

Note: the object name is specified in AR Studio UI during design time.

Note: the object name must only be unique withing the list of direct siblings. There can be more than object with the same name in the scene as soon as they have different parents.

See Also: SceneObjectBase.child, SceneObjectBase.find, SceneModule.root.

outputVisibility (inherited from SceneObjectBase)

(get) outputVisibility: OutputVisibility (set) (Not Available)

Represents the OutputVisibility that contains a set of flags that specify the scene object (and its descendants) visibility depending on the output.

parentWorldTransform (inherited from SceneObjectBase)

(get) parentWorldTransform: TransformSignal (set) (Not Available)

Specifies a TransformSignal object describing the parent's transformation relative to world coordinate system.

transform (inherited from SceneObjectBase)

(get) transform: Transform (set) transform: TransformSignal

Represents the object transformation, in object's local coordinate system.

worldTransform (inherited from SceneObjectBase)

(get) worldTransform: WorldTransform (set) worldTransform: TransformSignal

Specifies a TransformSignal object describing the object's transformation relative to world coordinate system. World transform in not yet supported for Canvas and Legacy canvas. Accessing this property from such objects or any of their children is not allowed.

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: PixelPointSignal, 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); });

child (inherited from SceneObjectBase)

child(name: string): SceneObjectBase

Returns a child object by name. An exception is thrown if the object isn't found.

See Also: SceneObjectBase.find, SceneModule.root.

find (inherited from SceneObjectBase)

find(name: string): SceneObjectBase

Returns a descendant object by name. An exception is thrown if the object isn't found or if more than one is found.

Note: object D is considered to be a descendant of object P if either D is a child of P or if such an object C which is a child of P exists that D is a descendant of C.

See Also: SceneObjectBase.child, SceneModule.root.