@vertexvis/utils 1.0.0-canary.5 → 1.0.0-canary.7

package/dist/index.d.ts

@@ -14,6 +14,8 @@ import * as Uri from './uri';
 import * as UUID from './uuid';
 export * from './disposable';
 export * from './eventDispatcher';
+export * from './interactions/basicInteractionHandler';
 export * from './mappedTypes';
 export * from './predicate';
+export * from './viewer/basicViewer';
 export { Async, BinaryReader, Color, EventTargets, Mapper, Objects, Range, Sets, Strings, Uri, UUID, };

package/dist/interactions/basicInteractionHandler.d.ts

@@ -0,0 +1,42 @@
+import { Disposable } from '../disposable';
+/**
+ * An `BasicInteractionHandler` provides a mechanism for customizing the mouse and
+ * touch handling in the viewer.
+ *
+ * When an interaction handler is registered with the viewer, it'll call the
+ * `initialize()` method and pass it the internal canvas element that can be
+ * used to modify the internal interaction state.
+ *
+ * @example
+ * ```
+ * class CustomInteractionHandler extends BasicInteractionHandler {
+ *   private element: HTMLElement;
+ *
+ *   public dispose(): void {
+ *     this.element.removeEventListener('click', this.handleElementClick);
+ *   }
+ *
+ *   public initialize(element: HTMLElement): void {
+ *     this.element = element;
+ *     this.element.addEventListener('click', this.handleElementClick);
+ *   }
+ *
+ *   private handleElementClick = (event: MouseEvent) => {
+ *     api.pick({ x: event.clientX, y: event.clientY });
+ *   }
+ * }
+ *
+ * const viewer = document.querySelector("vertex-viewer");
+ * viewer.registerInteractionHandler(new CustomInteractionHandler);
+ * ```
+ */
+export interface BasicInteractionHandler extends Disposable {
+    /**
+     * Called by the viewer when the interaction handler is registered with the
+     * viewer. Used to setup any necessary event listeners to handle user
+     * interactions.
+     *
+     * @param element The internal viewer element to add event listeners to.
+     */
+    initialize(element: HTMLElement): void;
+}

package/dist/viewer/basicViewer.d.ts

@@ -0,0 +1,5 @@
+import { Disposable } from '../disposable';
+import { BasicInteractionHandler } from '../interactions/basicInteractionHandler';
+export interface BasicViewer {
+    registerBasicInteractionHandler(interactionHandler: BasicInteractionHandler): Promise<Disposable>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertexvis/utils",
-  "version": "1.0.0-canary.5",
+  "version": "1.0.0-canary.7",
   "description": "Utility library for Viewer SDK.",
   "license": "MIT",
   "author": "Vertex Developers <support@vertex3d.com> (https://developer.vertex3d.com)",
@@ -52,7 +52,7 @@
     "@types/jest": "^29.5.14",
     "@vertexvis/eslint-config-vertexvis-typescript": "^0.5.0",
     "@vertexvis/jest-config-vertexvis": "^0.5.4",
-    "@vertexwebsdk/build": "1.0.0-canary.5",
+    "@vertexwebsdk/build": "1.0.0-canary.7",
     "eslint": "^8.57.1",
     "jest": "^29.5.14",
     "jest-cli": "^29.5.14",
@@ -64,5 +64,5 @@
   "peerDependencies": {
     "tslib": ">=2.4.0"
   },
-  "gitHead": "87508dde7c51472f558182a7c7bcd82267898535"
+  "gitHead": "bd084f39b93daca5cf74abd1a1dfb0ca1f055f2a"
 }