Image Tracker: rename factory

demos/hello-babylon/demo.js

@@ -34,7 +34,7 @@ class EnchantedDemo extends ARDemo
             );
         }
 
-        const tracker = AR.Tracker.ImageTracker();
+        const tracker = AR.Tracker.Image();
         await tracker.database.add([
         {
             name: 'mage',

demos/hello-three/demo.js

@@ -108,7 +108,7 @@ class EnchantedDemo extends ARDemo
             );
         }
 
-        const tracker = AR.Tracker.ImageTracker();
+        const tracker = AR.Tracker.Image();
         await tracker.database.add([
         {
             name: 'mage',

demos/hello-webgl/demo.js

@@ -920,7 +920,7 @@ window.addEventListener('load', async function() {
 
         //AR.Settings.powerPreference = 'low-power';
 
-        const tracker = AR.Tracker.ImageTracker();
+        const tracker = AR.Tracker.Image();
         await tracker.database.add([{
             name: 'my-reference-image',
             image: document.getElementById('my-reference-image')

demos/hello-world/demo.js

@@ -18,7 +18,7 @@ async function startARSession()
         );
     }
 
-    const tracker = AR.Tracker.ImageTracker();
+    const tracker = AR.Tracker.Image();
     await tracker.database.add([
     {
         name: 'mage',

docs/api/image-tracker.md

@@ -4,11 +4,16 @@ A [tracker](tracker.md) that tracks images in a video. Images are tracked using
 
 ## Instantiation
 
-### AR.Tracker.ImageTracker
+### AR.Tracker.Image
 
-`AR.Tracker.ImageTracker(): ImageTracker`
+`AR.Tracker.Image(options: object): ImageTracker`
+
+Instantiate an image tracker with the specified `options`.
+
+**Arguments**
 
-Instantiate an image tracker.
+* `options: object, optional`. An object with the following keys (all are optional):
+    * `resolution: Resolution`. The [resolution](resolution.md) of the tracker. Make sure that the [resolution of the video](camera-source.md) is at least as high as this. Suggested values: `"sm"`, `"sm+"`, `"md"`, `"md+"`.
 
 **Returns**
 
@@ -17,9 +22,23 @@ A new image tracker.
 **Example**
 
 ```js
-const imageTracker = AR.Tracker.ImageTracker();
+const imageTracker = AR.Tracker.Image({
+    resolution: "sm"
+});
 ```
 
+### AR.Tracker.ImageTracker
+
+`AR.Tracker.ImageTracker(): ImageTracker`
+
+Instantiate an image tracker with default settings.
+
+*Deprecated since:* 0.4.0. Use `AR.Tracker.Image()` instead.
+
+**Returns**
+
+A new image tracker.
+
 ## Properties
 
 ### type

docs/getting-started/activate-your-webcam.md

@@ -16,7 +16,7 @@ async function startARSession()
         );
     }
 
-    const tracker = AR.Tracker.ImageTracker();
+    const tracker = AR.Tracker.Image();
     await tracker.database.add([{
         name: 'my-reference-image',
         image: document.getElementById('my-reference-image')
@@ -160,7 +160,7 @@ async function startARSession()
         );
     }
 
-    const tracker = AR.Tracker.ImageTracker();
+    const tracker = AR.Tracker.Image();
     await tracker.database.add([{
         name: 'my-reference-image',
         image: document.getElementById('my-reference-image')
@@ -206,7 +206,7 @@ async function startARSession()
         );
     }
 
-    const tracker = AR.Tracker.ImageTracker();
+    const tracker = AR.Tracker.Image();
     await tracker.database.add([{
         name: 'my-reference-image',
         image: document.getElementById('my-reference-image')
@@ -260,7 +260,7 @@ async function startARSession()
         );
     }
 
-    const tracker = AR.Tracker.ImageTracker();
+    const tracker = AR.Tracker.Image();
     await tracker.database.add([{
         name: 'my-reference-image',
         image: document.getElementById('my-reference-image')

docs/getting-started/next-steps.md

@@ -20,7 +20,7 @@ async function startARSession()
 
     AR.Settings.powerPreference = 'low-power'; // OPTIONAL
 
-    const tracker = AR.Tracker.ImageTracker();
+    const tracker = AR.Tracker.Image();
     await tracker.database.add([{
         name: 'my-reference-image',
         image: document.getElementById('my-reference-image')

docs/getting-started/set-up-the-session.md

@@ -39,7 +39,7 @@ window.onload = async function()
             );
         }
 
-        const tracker = AR.Tracker.ImageTracker();
+        const tracker = AR.Tracker.Image();
         await tracker.database.add([{
             name: 'my-reference-image',
             image: document.getElementById('my-reference-image')
@@ -70,7 +70,7 @@ window.onload = async function()
             );
         }
 
-        const tracker = AR.Tracker.ImageTracker();
+        const tracker = AR.Tracker.Image();
         await tracker.database.add([{
             name: 'my-reference-image',
             image: document.getElementById('my-reference-image')
@@ -104,7 +104,7 @@ window.onload = async function()
             );
         }
 
-        const tracker = AR.Tracker.ImageTracker();
+        const tracker = AR.Tracker.Image();
         await tracker.database.add([{
             name: 'my-reference-image',
             image: document.getElementById('my-reference-image')
@@ -167,7 +167,7 @@ async function startARSession()
         );
     }
 
-    const tracker = AR.Tracker.ImageTracker();
+    const tracker = AR.Tracker.Image();
     await tracker.database.add([{
         name: 'my-reference-image',
         image: document.getElementById('my-reference-image')

docs/getting-started/set-up-the-tracker.md

@@ -144,7 +144,7 @@ window.onload = async function()
             );
         }
 
-        const tracker = AR.Tracker.ImageTracker();
+        const tracker = AR.Tracker.Image();
     }
     catch(error) {
         alert(error.message);
@@ -185,7 +185,7 @@ window.onload = async function()
             );
         }
 
-        const tracker = AR.Tracker.ImageTracker();
+        const tracker = AR.Tracker.Image();
         await tracker.database.add([{
             name: 'my-reference-image',
             image: document.getElementById('my-reference-image')

plugins/aframe-with-encantar.js

@@ -913,7 +913,7 @@ AFRAME.registerComponent('ar-image-tracker', ARComponent({
 
     /* async */ tracker()
     {
-        const tracker = AR.Tracker.ImageTracker();
+        const tracker = AR.Tracker.Image();
         const referenceImages = [];
 
         tracker.resolution = this.data.resolution;

src/sources/camera-source.ts

@@ -68,6 +68,7 @@ export class CameraSource extends VideoSource
 
     /**
      * Constructor
+     * @param options
      */
     constructor(options: CameraSourceOptions)
     {

src/trackers/image-tracker/image-tracker.ts

@@ -48,7 +48,6 @@ import { ImageTrackerPreTrackingBState } from './states/pre-tracking-b';
 import { ImageTrackerTrackingState } from './states/tracking';
 import { Nullable, Utils } from '../../utils/utils';
 import { AREventTarget } from '../../utils/ar-events';
-import { DEFAULT_TRACKING_RESOLUTION } from './settings';
 import { ImageTrackerEvent, ImageTrackerEventType } from './image-tracker-event';
 import { SpeedyPoint2 } from 'speedy-vision/types/core/speedy-point';
 import { Viewer } from '../../geometry/viewer';
@@ -103,6 +102,18 @@ export type ImageTrackerStateName = 'initial' | 'training' | 'scanning' | 'pre-t
 /** A helper */
 const formatSize = (size: SpeedySize) => `${size.width}x${size.height}`;
 
+/** Options for instantiating an ImageTracker */
+export interface ImageTrackerOptions
+{
+    /** resolution of the tracker; it helps define the AR screen space */
+    resolution?: Resolution;
+}
+
+/** Default options for instantiating an ImageTracker */
+const DEFAULT_OPTIONS: Readonly<ImageTrackerOptions> = {
+    resolution: 'sm'
+};
+
 
 
 
@@ -138,8 +149,9 @@ export class ImageTracker extends AREventTarget<ImageTrackerEventType> implement
 
     /**
      * Constructor
+     * @param options
      */
-    constructor()
+    constructor(options: ImageTrackerOptions)
     {
         super();
 
@@ -161,7 +173,8 @@ export class ImageTracker extends AREventTarget<ImageTrackerEventType> implement
         this._database = new ReferenceImageDatabase();
 
         // user settings
-        this._resolution = DEFAULT_TRACKING_RESOLUTION;
+        options = Object.assign({}, DEFAULT_OPTIONS, options);
+        this._resolution = options.resolution!;
     }
 
     /**

src/trackers/image-tracker/settings.ts

@@ -20,9 +20,6 @@
  * Settings of the Image Tracker
  */
 
-/** Default tracking resolution */
-export const DEFAULT_TRACKING_RESOLUTION = 'sm';
-
 /** Maximum number of keypoints to be stored for each reference image when in the training state */
 export const TRAIN_MAX_KEYPOINTS = 1024; //512;
 

src/trackers/tracker-factory.ts

@@ -20,7 +20,7 @@
  * Tracker factory
  */
 
-import { ImageTracker } from './image-tracker/image-tracker';
+import { ImageTracker, ImageTrackerOptions } from './image-tracker/image-tracker';
 import { PointerTracker } from './pointer-tracker/pointer-tracker';
 
 /**
@@ -30,10 +30,20 @@ export class TrackerFactory
 {
     /**
      * Create an Image Tracker
+     * @param options
+     */
+    static Image(options: ImageTrackerOptions = {}): ImageTracker
+    {
+        return new ImageTracker(options);
+    }
+
+    /**
+     * Create an Image Tracker with default settings
+     * @deprecated
      */
     static ImageTracker(): ImageTracker
     {
-        return new ImageTracker();
+        return this.Image();
     }
 
     /**