Wikitude tracks environment features. It needs to find and confirm a ground position on the floor first to enable the feature tracking.
See Wikitude documentation: http://www.wikitude.com/documentation/
Extends
Members
active :boolean
- Inherited From:
Is the tracker active or not.
Type:
- boolean
floorOffset :number
- Inherited From:
Get the current floor offset in mm (default value: 1400).
Only available if "scaleEstimation" is set to true in tracker config.
Type:
- number
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:
- Array.<TrackingTarget>
tracking :boolean
- Inherited From:
Current target tracking status.
Type:
- boolean
Methods
(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) getFloorOffset() → {number}
- Inherited From:
Retrieves the current floor offset.
Only available if "scaleEstimation" is set to true in tracker config.
Returns:
current floor offset.
- Type
- number
isActive() → {boolean}
- Inherited From:
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) reset()
- Inherited From:
Reset the tracker. Shorthand function for Tracker#deactivate and Tracker#activate.
(async) setFloorOffset(height)
- Inherited From:
Sets the current floor offset. The scene will be adjusted vertically according to this offset.
Only available if "scaleEstimation" is set to true in tracker config.
Parameters:
| Name | Type | Description |
|---|---|---|
height |
number |
(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
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 |