Tracking Functions
addTracker
|
Name
|
Type
|
Description
|
Required/Optional
|
Default
|
|---|---|---|---|---|
|
params
|
Object
|
Configuration object containing tracker settings.
|
Required
|
|
|
params.name
|
String
|
Name of the tracker or tracking context.
|
Required
|
|
|
params.enableTrackingEvents
|
Boolean
|
Enables or disables tracking events.
|
Optional
|
true
|
|
params.trackingHints
|
Boolean
|
Enables or disables tracking hints for improved recognition.
|
Optional
|
true
|
|
successCallback
|
Function
|
Called when the operation completes successfully.
|
Optional
|
|
|
errorCallback
|
Function
|
Called when the operation fails.
|
Optional
|
 |
If both enableTrackingEvents and trackingHints are true, tracking data is continuously broadcast via successCallback.
|
addMarker
Adds a marker (target) to the experience. The source can be any supported tracking target type. For information about supported tracker types, see Core Components and Concepts.
|
Name
|
Type
|
Description
|
Required/Optional
|
Default
|
|---|---|---|---|---|
|
trackerName
|
String
|
The tracker ID that this marker should be associated with (defined via addTracker).
|
Required
|
|
|
name
|
String
|
Studio ID of a target widget.
|
Required
|
|
|
src
|
String
|
Defines the type and ID of the tracking target to use.
Examples:
• "vuforia-vumark:///vumark?id=5:789"
• "vuforia-vumark:///app/resources/Uploaded/BarCodeEAN?id="
• "vuforia-image:///image?id=image-target-1"
• "vuforia-runtime-image:///app/resources/Uploaded/stones.jpg?id=0486b3eb-880e-4c9b-8416-0e646f409e4c"
• "vuforia-area:///area?id=area-target-1"
• "vuforia-model:///model?id=model-target-1"
|
Required
|
|
|
size
|
Float
|
Size of the tracking target in meters, used for image and ThingMark tracking targets.
|
Optional
|
0
|
|
successCallback
|
Function
|
Called when the operation completes successfully.
|
Optional
|
|
|
errorCallback
|
Function
|
Called when the operation fails.
|
Optional
|
getTracked
Retrieves a list of all currently active trackers (targets) and passes the names to the successCallback.
|
Name
|
Type
|
Description
|
Required/Optional
|
|---|---|---|---|
|
successCallback
|
Function
|
Called when the operation completes successfully.
|
Optional
|
|
errorCallback
|
Function
|
Called when the operation fails.
|
Optional
|
|
|
The array passed to successCallback looks like: ["targetName1", "targetName2"]
|
resetSpatialTracking
Resets the spatial tracking system, including world tracking.
|
Name
|
Type
|
Description
|
Required/Optional
|
|---|---|---|---|
|
successCallback
|
Function
|
Called when the operation completes successfully.
|
Optional
|
|
errorCallback
|
Function
|
Called when the operation fails.
|
Optional
|
|
|
This function removes all anchors and resets gesture-based transforms (for example, scaling, rotation, position).
|