Document TrackablePointer, PointerTracker, PointerSource and PointerTrackerResult

docs/api/pointer-source.md

@@ -0,0 +1,23 @@
+# PointerSource
+
+A [source](source.md) of [pointer](trackable-pointer.md)-based input. It feeds a [PointerTracker](pointer-tracker.md).
+
+*Since:* 0.4.0
+
+## Instantiation
+
+### AR.Source.Pointer
+
+`AR.Source.Pointer(): PointerSource`
+
+Create a new `PointerSource`.
+
+**Returns**
+
+A new `PointerSource`.
+
+**Example**
+
+```js
+const pointerSource = AR.Source.Pointer();
+```

docs/api/pointer-tracker-result.md

@@ -0,0 +1,19 @@
+# PointerTrackerResult
+
+A [result](tracker-result.md) generated by a [PointerTracker](pointer-tracker.md).
+
+*Since:* 0.4.0
+
+## Properties
+
+### tracker
+
+`result.tracker: PointerTracker, read-only`
+
+A reference to the [PointerTracker](pointer-tracker.md) that generated this result.
+
+### trackables
+
+`result.trackables: TrackablePointer[], read-only`
+
+An array of [TrackablePointers](trackable-pointer.md).

docs/api/pointer-tracker.md

@@ -0,0 +1,31 @@
+# PointerTracker
+
+A [tracker](tracker.md) of [pointers](trackable-pointer.md). It consumes data from a [PointerSource](pointer-source.md) and produces [PointerTrackerResults](pointer-tracker-result.md).
+
+*Since:* 0.4.0
+
+## Instantiation
+
+### AR.Tracker.Pointer
+
+`AR.Tracker.Pointer(): PointerTracker`
+
+Create a new `PointerTracker`.
+
+**Returns**
+
+A new `PointerTracker`.
+
+**Example**
+
+```js
+const pointerTracker = AR.Tracker.Pointer();
+```
+
+## Properties
+
+### type
+
+`tracker.type: string, read-only`
+
+The string `"pointer-tracker"`.

docs/api/trackable-pointer.md

@@ -0,0 +1,65 @@
+# TrackablePointer
+
+A [trackable](trackable.md) that represents a pointer tracked by a [PointerTracker](pointer-tracker.md).
+
+A pointer is an abstraction that represents an instance of user input that targets one or more coordinates on a screen. For example, each point of contact between fingers and a multitouch screen generate a pointer. Devices such as a mouse and a pen/stylus also generate pointers.
+
+Pointers are positioned in the [viewport](viewport.md), and their positions are given in normalized coordinates. Normalized coordinates range from -1 to +1. The center of the viewport is at (0,0). The top-right corner is at (1,1). The bottom-left corner is at (-1,-1).
+
+*Since:* 0.4.0
+
+## Properties
+
+### id
+
+`pointer.id: number, read-only`
+
+A unique identifier assigned to this pointer.
+
+### phase
+
+`pointer.phase: string, read-only`
+
+The phase of the pointer. It's one of the following strings:
+
+* `"began"`: the tracking began in this frame (e.g., a finger has just touched the screen)
+* `"stationary"`: the user did not move the pointer in this frame
+* `"moved"`: the user moved the pointer in this frame
+* `"ended"`: the tracking ended in this frame (e.g., a finger has just been lifted from the screen)
+* `"canceled"`: the tracking was canceled in this frame (e.g., the screen orientation of the device has just been changed)
+
+### position
+
+`pointer.position: Vector2, read-only`
+
+The current position of the pointer, given in normalized coordinates.
+
+### initialPosition
+
+`pointer.initialPosition: Vector2, read-only`
+
+The position of the pointer when its tracking began.
+
+### deltaPosition
+
+`pointer.deltaPosition: Vector2, read-only`
+
+The difference between the position of the pointer in this and in the previous frame.
+
+### velocity
+
+`pointer.velocity: Vector2, read-only`
+
+The current velocity of the pointer, given in normalized coordinates per second. You can get the speed of motion by calculating the [magnitude](vector2.md#length) of this vector.
+
+### isPrimary
+
+`pointer.isPrimary: boolean, read-only`
+
+Whether or not this is the primary pointer among all pointers of this [type](#type). A typical primary pointer is that of a finger that touches the screen when no other fingers are touching it.
+
+### type
+
+`pointer.type: string, read-only`
+
+The type of device that originated this pointer. Typically `"touch"`, `"mouse"` or `"pen"`.

mkdocs.yml

@@ -80,6 +80,10 @@ nav:
         - 'ReferenceImageDatabase': 'api/reference-image-database.md'
         - 'ImageTrackerResult': 'api/image-tracker-result.md'
         - 'TrackableImage': 'api/trackable-image.md'
+      - 'Pointer tracker':
+        - 'PointerTracker': 'api/pointer-tracker.md'
+        - 'PointerTrackerResult': 'api/pointer-tracker-result.md'
+        - 'TrackablePointer': 'api/trackable-pointer.md'
       - 'Tracker': 'api/tracker.md'
       - 'TrackerResult': 'api/tracker-result.md'
       - 'Trackable': 'api/trackable.md'
@@ -87,6 +91,7 @@ nav:
       - 'CameraSource': 'api/camera-source.md'
       - 'CanvasSource': 'api/canvas-source.md'
       - 'VideoSource': 'api/video-source.md'
+      - 'PointerSource': 'api/pointer-source.md'
       - 'Source': 'api/source.md'
     - 'Geometry':
       - 'Pose': 'api/pose.md'
@@ -95,9 +100,9 @@ nav:
       - 'View': 'api/view.md'
       - 'PerspectiveView': 'api/perspective-view.md'
       - 'Transform': 'api/transform.md'
-      - 'Quaternion': 'api/quaternion.md'
-      - 'Vector3': 'api/vector3.md'
       - 'Vector2': 'api/vector2.md'
+      - 'Vector3': 'api/vector3.md'
+      - 'Quaternion': 'api/quaternion.md'
     - 'Visualization':
       - 'Viewport': 'api/viewport.md'
       - 'HUD': 'api/hud.md'