PlacenoteTracker

PlacenoteTracker

Placenote tracks environment features and targets (qr codes). It can also save features in a tracking map. Targets can be either when the
floor is found or a scanned qr code. The tracker needs to initialize the ground position on the floor first. After
that tracking maps can be saved and loaded or qr codes can be scanned.
See Placenote documentation: https://placenote.com/documentation/

Extends

Members

active :boolean

Inherited From:

Is the tracker active or not.

Type:
  • boolean

activeTrackingMap :string

The currently loaded tracking map.

Type:
  • string

groundConfirmed :boolean

Inherited From:

Is the ground position already confirmed.

Type:
  • boolean

name :string

Inherited From:

Name of the tracker.

Type:
  • string

targets :Array.<TrackingTarget>

Inherited From:

The list of tracking targets.

Type:

tracking :boolean

Inherited From:

Current target tracking status.

Type:
  • boolean

trackingMapId :string

The last generated tracking map id.

Type:
  • string

Methods

(async) _loadTrackingMap(mapId) → {Array.<string>}

Deletes a previously saved tracking map.

Parameters:
Name Type Description
mapId string

the id of the tracking map to delete.
Returns:

List of all tracking maps.

Type
Array.<string>

(async) activate()

Inherited From:

Activate the tracker. Disables all other currently active trackers.

(async) confirmGroundPosition()

Inherited From:

Confirms ground position to start feature tracking.

(async) deactivate()

Inherited From:

Deactivate the tracker.

(async) generateTrackingMapId() → {string}

Generates a new tracking map id.

Returns:

The generated tracking map id.

Type
string

isActive() → {boolean}

Inherited From:

Is the tracker currently active.

Returns:

True if active.

Type
boolean

(async) loadTrackingMap(mapId) → {boolean}

See:

Loads a previously saved tracking map. This requires a confirmed ground position beforehand.

Parameters:
Name Type Description
mapId string

the id of the tracking map to load.
Returns:

True if successfull.

Type
boolean

off(eventName, eventHandler)

Inherited From:
Parameters:
Name Type Description
eventName string
eventHandler function

on(eventName, eventHandler)

Inherited From:
Parameters:
Name Type Description
eventName string
eventHandler function

once(eventName, eventHandler)

Inherited From:
Parameters:
Name Type Description
eventName string
eventHandler function

(async) reset()

Inherited From:

Reset the tracker. Shorthand function for Tracker#deactivate and Tracker#activate.

(async) saveTrackingMap(mapId) → {string}

Saves the currently detected tracking map.

Parameters:
Name Type Description
mapId string

a new tracking map id. Needs to be generated first with PlacenoteTracker#generateTrackingMapId.
If no map id is given, a new one is automatically generated.
Returns:

The id of the saved tracking map or false if saving failed.

Type
string

(async) setTrackingTargets(newTargets)

Inherited From:

Update the tracking target config. This will override existing targets and remove already learned targets.

Parameters:
Name Type Description
newTargets Array.<TargetConfig>

Events

trackingMapLoadProgress

Emits progress when loading a tracking map.

Parameters:
Name Type Description
progress number

in percent between 0 and 1.

trackingMapSaveProgress

Emits progress when saving a tracking map.

Parameters:
Name Type Description
progress number

in percent between 0 and 1.

trackingStatusChanged

Inherited From:

Fired when a tracking target is found or lost.

Parameters:
Name Type Description
info object
Properties
Name Type Description
target TrackingTarget
trackedTargets Array.<TrackingTarget>
untrackedTargets Array.<TrackingTarget>

trackingTargetNew

Inherited From:

Fired when an unregistered tracking target is found.

Parameters:
Name Type Description
target TrackingTarget

trackingTargetStatusChanged

Inherited From:

Fired when a tracking target is found or lost.

Parameters:
Name Type Description
target TrackingTarget