Vuforia tracks either environment features or static targets registered at Vuforia beforehand. It needs to find and
confirm a ground position on the floor first to capture environment features. This requires a tracking target with
type 'ground'. On default the tracker expects an (adjustable) offset of 1400mm to the floor when confirming the
ground position.
See Vuforia documentation: https://library.vuforia.com/
Extends
- Tracker
- TargetTrackingProvider
- FloorOffsetProvider
- GroundConfirmProvider
- Emitter
- Tracker
Members
active :boolean
- Overrides:
Is the tracker active or not.
Type:
- boolean
canConfirmGround :boolean
Indicates if the tracker has confirm ground capabilities.
Type:
- boolean
groundConfirmed :boolean
- Inherited From:
Is the ground position already confirmed.
Type:
- boolean
name :string
- Overrides:
Name of the tracker.
Type:
- string
rangedBeacons :Array.<string>
Currently detected beacons that are in range.
Type:
- Array.<string>
targets :Array.<TrackingTarget>
- Inherited From:
The list of tracking targets.
Type:
- Array.<TrackingTarget>
tracking :boolean
- Inherited From:
Current target tracking status.
Type:
- boolean
Methods
(async) activate()
- Overrides:
Activate the tracker. Disables all other currently active trackers.
(async) captureUserTarget() → {Promise}
Captures a user target from the current camera input.
Returns:
resolved when done.
- Type
- Promise
(async) confirmGroundPosition()
- Inherited From:
Confirms ground position to start feature tracking.
(async) deactivate()
- Overrides:
Deactivate the tracker.
isActive() → {boolean}
- Overrides:
Is the tracker currently active.
Returns:
True if active.
- 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) removeUserTarget() → {Promise}
Removes the previously captures user target.
Returns:
resolved when done.
- Type
- Promise
(async) reset()
- Overrides:
Reset the tracker. Shorthand function for Tracker#deactivate and Tracker#activate.
(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
rangedBeaconsChanged
The list of beacons in range has changed.
Parameters:
| Name | Type | Description |
|---|---|---|
rangedBeacons |
Array.<string> | Array of beacons in range. |
trackingStatusChanged
- Inherited From:
Fired when a tracking target is found or lost.
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
info |
object |
Properties
|
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 |