Introduced TrackerResult.of(). Made other changes

src/core/session.ts

@@ -33,7 +33,7 @@ import { Settings } from './settings';
 import { Stats } from './stats';
 import { Gizmos } from '../ui/gizmos';
 import { Frame } from './frame';
-import { Tracker } from '../trackers/tracker';
+import { Trackable, Tracker, TrackerResult } from '../trackers/tracker';
 import { TimeManager } from './time-manager';
 import { Source } from '../sources/source';
 import { VideoSource } from '../sources/video-source';
@@ -87,6 +87,21 @@ const DEFAULT_OPTIONS: Readonly<Required<SessionOptions>> = {
     gizmos: false,
 };
 
+/** Helper class */
+class EmptyTrackerResult extends TrackerResult
+{
+    readonly tracker: Tracker;
+    readonly trackables: Trackable[];
+
+    constructor(tracker: Tracker)
+    {
+        super();
+        this.tracker = tracker;
+        this.trackables = [];
+    }
+}
+
+
 
 
 /**
@@ -707,10 +722,7 @@ export class Session extends AREventTarget<SessionEvent>
 
                 // create a frame
                 const results = this._trackers.map(tracker =>
-                    tracker._output.exports || ({
-                        tracker: tracker,
-                        trackables: [],
-                    })
+                    tracker._output.exports || new EmptyTrackerResult(tracker)
                 );
                 const frame = new Frame(this, results);
 

src/sources/canvas-source.ts

@@ -55,14 +55,13 @@ export class CanvasSource implements Source
      * A type-identifier of the source of data
      * @internal
      */
-    get _type(): string
+    get _type(): keyof SourceType
     {
         return 'canvas';
     }
 
     /**
      * Check if this source is of a certain type
-     * This is a convenient type-narrowing utility
      * @internal
      */
     _is<T extends keyof SourceType>(type: T): this is SourceType[T]

src/sources/pointer-source.ts

@@ -55,14 +55,13 @@ export class PointerSource implements Source
      * A type-identifier of the source of data
      * @internal
      */
-    get _type(): string
+    get _type(): keyof SourceType
     {
         return 'pointer-source';
     }
 
     /**
      * Check if this source is of a certain type
-     * This is a convenient type-narrowing utility
      * @internal
      */
     _is<T extends keyof SourceType>(type: T): this is SourceType[T]

src/sources/source.ts

@@ -31,9 +31,9 @@ import { VideoSource } from './video-source';
 export interface Source
 {
     /** @internal type-identifier of the source of data */
-    readonly _type: string;
+    readonly _type: keyof SourceType;
 
-    /** @internal check if this source is of a certain type - this is a convenient type-narrowing utility */
+    /** @internal check if this source is of a certain type */
     _is<T extends keyof SourceType>(type: T): this is SourceType[T];
 
     /** @internal method to initialize the source of data (gets the data ready) */

src/sources/video-source.ts

@@ -70,14 +70,13 @@ export class VideoSource implements Source
      * A type-identifier of the source of data
      * @internal
      */
-    get _type(): string
+    get _type(): keyof SourceType
     {
         return 'video';
     }
 
     /**
      * Check if this source is of a certain type
-     * This is a convenient type-narrowing utility
      * @internal
      */
     _is<T extends keyof SourceType>(type: T): this is SourceType[T]

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

@@ -33,7 +33,7 @@ import { SpeedyPipelineNodeFASTKeypointDetector } from 'speedy-vision/types/core
 import { SpeedyKeypoint } from 'speedy-vision/types/core/speedy-keypoint';
 import { VideoSource } from '../../sources/video-source';
 import { CanvasSource } from '../../sources/canvas-source';
-import { Tracker, TrackerOutput, TrackerResult, Trackable, TrackerType } from '../tracker';
+import { Tracker, TrackerOutput, TrackerResult, Trackable, TrackerType, TrackerResultType } from '../tracker';
 import { Session } from '../../core/session';
 import { IllegalOperationError, IllegalArgumentError } from '../../utils/errors';
 import { Resolution } from '../../utils/resolution';
@@ -65,7 +65,7 @@ export interface TrackableImage extends Trackable
 }
 
 /** Image Tracker result to be consumed by the user */
-export interface ImageTrackerResult extends TrackerResult
+export class ImageTrackerResult extends TrackerResult
 {
     /** tracker */
     readonly tracker: ImageTracker;
@@ -75,6 +75,20 @@ export interface ImageTrackerResult extends TrackerResult
 
     /** 3D virtual camera */
     readonly viewer: Viewer;
+
+    /**
+     * Constructor
+     * @param tracker
+     * @param trackables
+     * @param viewer
+     */
+    constructor(tracker: ImageTracker, trackables: TrackableImage[], viewer: Viewer)
+    {
+        super();
+        this.tracker = tracker;
+        this.trackables = trackables;
+        this.viewer = viewer;
+    }
 }
 
 /** Image Tracker output */
@@ -185,7 +199,6 @@ export class ImageTracker extends AREventTarget<ImageTrackerEvent> implements Tr
 
     /**
      * Check if this tracker is of a certain type
-     * This is a convenient type-narrowing utility
      */
     is<T extends keyof TrackerType>(type: T): this is TrackerType[T]
     {

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

@@ -433,11 +433,11 @@ export class ImageTrackerTrackingState extends ImageTrackerState
             };
 
             // the result generated by the image tracker
-            const result: ImageTrackerResult = {
-                tracker: this._imageTracker,
-                trackables: [ trackable ],
-                viewer: viewer
-            };
+            const result = new ImageTrackerResult(
+                this._imageTracker,
+                [ trackable ],
+                viewer
+            );
 
             // tracker output
             const trackerOutput: ImageTrackerOutput = {

src/trackers/pointer-tracker/pointer-tracker.ts

@@ -34,13 +34,25 @@ import { Viewport } from '../../core/viewport';
 /**
  * A result of a PointerTracker. It's meant to be consumed by the user/application
  */
-export interface PointerTrackerResult extends TrackerResult
+export class PointerTrackerResult extends TrackerResult
 {
     /** the tracker that generated this result */
     readonly tracker: PointerTracker;
 
     /** the trackables */
     readonly trackables: TrackablePointer[];
+
+    /**
+     * Constructor
+     * @param tracker
+     * @param trackables
+     */
+    constructor(tracker: PointerTracker, trackables: TrackablePointer[])
+    {
+        super();
+        this.tracker = tracker;
+        this.trackables = trackables;
+    }
 }
 
 /**
@@ -196,7 +208,6 @@ export class PointerTracker implements Tracker
 
     /**
      * Check if this tracker is of a certain type
-     * This is a convenient type-narrowing utility
      */
     is<T extends keyof TrackerType>(type: T): this is TrackerType[T]
     {
@@ -480,12 +491,8 @@ export class PointerTracker implements Tracker
         const trackables: TrackablePointer[] = [];
         this._activePointers.forEach(trackable => trackables.push(trackable));
 
-        return {
-            exports: {
-                tracker: this,
-                trackables: this._sortTrackables(trackables)
-            }
-        };
+        const result = new PointerTrackerResult(this, this._sortTrackables(trackables));
+        return { exports: result };
     }
 
     /**

src/trackers/tracker.ts

@@ -23,8 +23,8 @@
 import { Session } from '../core/session';
 import { SpeedyPromise } from 'speedy-vision/types/core/speedy-promise';
 import { SpeedyMedia } from 'speedy-vision/types/core/speedy-media';
-import { ImageTracker } from './image-tracker/image-tracker';
-import { PointerTracker } from './pointer-tracker/pointer-tracker';
+import { ImageTracker, ImageTrackerResult } from './image-tracker/image-tracker';
+import { PointerTracker, PointerTrackerResult } from './pointer-tracker/pointer-tracker';
 
 /**
  * A Trackable is something that can be tracked
@@ -39,13 +39,19 @@ export interface Trackable
  * The result of a Tracker in a particular frame of a session. Such result is
  * meant to be consumed by the user/application.
  */
-export interface TrackerResult
+export abstract class TrackerResult
 {
     /** the tracker that generated this result */
-    readonly tracker: Tracker;
+    abstract readonly tracker: Tracker;
 
     /** an array of trackables (possibly empty) */
-    readonly trackables: Trackable[];
+    abstract readonly trackables: Trackable[];
+
+    /** check if this result was generated by a tracker of a certain type */
+    of<T extends keyof TrackerResultType>(trackerType: T): this is TrackerResultType[T]
+    {
+        return this.tracker.is(trackerType);
+    }
 }
 
 /**
@@ -65,7 +71,7 @@ export interface TrackerOutput
  */
 export interface Tracker
 {
-    /** check if this tracker is of a certain type - this is a convenient type-narrowing utility */
+    /** check if this tracker is of a certain type */
     is<T extends keyof TrackerType>(type: T): this is TrackerType[T];
 
     /** a string that identifies the type of the tracker @deprecated */
@@ -94,4 +100,13 @@ export interface Tracker
 export type TrackerType = {
     'image-tracker': ImageTracker,
     'pointer-tracker': PointerTracker
+};
+
+/**
+ * A helper for type-narrowing
+ * @internal
+ */
+export type TrackerResultType = {
+    'image-tracker': ImageTrackerResult,
+    'pointer-tracker': PointerTrackerResult
 };