@inweb/viewer-core 25.3.20 → 25.3.22

package/lib/viewer/ViewerEvents.d.ts

@@ -1,6 +1,7 @@
 import { Assembly, File, Model } from "@inweb/client";
+import { CanvasEventMap } from "./CanvasEvents";
 /**
- * A {@link Viewer} event that fires when model loading has been canceled.
+ * Event that fires when model loading has been canceled.
  *
  * @event
  */
@@ -11,7 +12,7 @@ export interface CancelEvent {
     type: "cancel";
 }
 /**
- * A {@link Viewer} event that fires when the active dragger has been changed.
+ * Event that fires when the active dragger has been changed.
  *
  * @event
  */
@@ -26,7 +27,7 @@ export interface ChangeActiveDraggerEvent {
     data: string;
 }
 /**
- * A {@link Viewer} event that fires when the markup color has been changed.
+ * Event that fires when the markup color has been changed.
  *
  * @event
  */
@@ -45,7 +46,7 @@ export interface ChangeMarkupColorEvent {
     };
 }
 /**
- * A {@link Viewer} event that fires when the viewer has been cleared.
+ * Event that fires when the viewer has been cleared.
  *
  * @event
  */
@@ -56,7 +57,7 @@ export interface ClearEvent {
     type: "clear";
 }
 /**
- * A {@link Viewer} event that fires after viewer executes the command.
+ * Event that fires after viewer executes the command.
  *
  * @event
  */
@@ -75,7 +76,7 @@ export interface CommandEvent {
     args: any[];
 }
 /**
- * A {@link Viewer} event that fires when the model scene description file has been loaded.
+ * Event that fires when the model scene description file has been loaded.
  *
  * @event
  */
@@ -98,7 +99,7 @@ export interface DatabaseChunkEvent {
     buffer?: Uint8Array | ArrayBuffer;
 }
 /**
- * A {@link Viewer} event that fires before viewer resources has been released.
+ * Event that fires before viewer resources has been released.
  *
  * @event
  */
@@ -109,9 +110,9 @@ export interface DisposeEvent {
     type: "dispose";
 }
 /**
- * A {@link Viewer} event that fires when the model geometry data chunk has been loaded. Note
- * that small files are loaded in one chunk, and `geometrychunk` event does not fire, only the
- * `databasechink` event fires.
+ * Event that fires when the model geometry data chunk has been loaded. Note that small files
+ * are loaded in one chunk, and `geometrychunk` event does not fire, only the `databasechink`
+ * event fires.
  *
  * @event
  */
@@ -134,7 +135,7 @@ export interface GeometryChunkEvent {
     buffer?: Uint8Array | ArrayBuffer;
 }
 /**
- * A {@link Viewer} event that fires after model has been successfully loaded.
+ * Event that fires after model has been successfully loaded.
  *
  * @event
  */
@@ -157,7 +158,7 @@ export interface GeometryEndEvent {
     data?: any;
 }
 /**
- * A {@link Viewer} event that fires when the model fails to load.
+ * Event that fires when the model fails to load.
  *
  * @event
  */
@@ -180,7 +181,7 @@ export interface GeometryErrorEvent {
     buffer?: Uint8Array | ArrayBuffer;
 }
 /**
- * A {@link Viewer} event measuring progress of the model loading process.
+ * Event measuring progress of the model loading process.
  *
  * @event
  */
@@ -203,7 +204,7 @@ export interface GeometryProgressEvent {
     buffer?: Uint8Array | ArrayBuffer;
 }
 /**
- * A {@link Viewer} event that fires before the model loads.
+ * Event that fires before the model loads.
  *
  * @event
  */
@@ -222,7 +223,7 @@ export interface GeometryStartEvent {
     buffer?: Uint8Array | ArrayBuffer;
 }
 /**
- * A {@link Viewer} event that fires before model opens.
+ * Event that fires before model opens.
  *
  * @event
  */
@@ -245,7 +246,7 @@ export interface OpenEvent {
     buffer?: Uint8Array | ArrayBuffer;
 }
 /**
- * A {@link Viewer} event that fires when rendering occurs.
+ * Event that fires when rendering occurs.
  *
  * @event
  */
@@ -254,11 +255,17 @@ export interface RenderEvent {
      * Event type.
      */
     type: "render";
+    /**
+     * Render time.
+     */
     time: DOMHighResTimeStamp;
+    /**
+     * The milliseconds passed since the previous render.
+     */
     deltaTime: DOMHighResTimeStamp;
 }
 /**
- * A {@link Viewer} event that fires when resize occurs.
+ * Event that fires when resize occurs.
  *
  * @event
  */
@@ -277,7 +284,7 @@ export interface ResizeEvent {
     height: number;
 }
 /**
- * A {@link Viewer} event that fires when the selection changes.
+ * Event that fires when the selection changes.
  *
  * @event
  */
@@ -296,7 +303,7 @@ export interface SelectEvent {
     handles: string[];
 }
 /**
- * A {@link Viewer} event that fires when an update occurs.
+ * Event that fires when an update occurs.
  *
  * @event
  */
@@ -311,7 +318,7 @@ export interface UpdateEvent {
     data: boolean;
 }
 /**
- * A {@link Viewer} event measuring progress of loading a `VisualizeJS` library.
+ * Event measuring progress of loading a `VisualizeJS` library.
  *
  * @event
  */
@@ -333,7 +340,7 @@ export interface VisualizeProgressEvent {
     total: number;
 }
 /**
- * A {@link Viewer} event that fires when walk speed changing.
+ * Event that fires when walk speed changing.
  *
  * @event
  */
@@ -343,12 +350,12 @@ export interface WalkSpeedChangeEvent {
      */
     type: "walkspeedchange";
     /**
-     * Multiplier
+     * Walk speed multiplier.
      */
     data: number;
 }
 /**
- * A {@link Viewer} event that fires when walk started.
+ * Event that fires when walk started.
  *
  * @event
  */
@@ -359,7 +366,7 @@ export interface WalkStartEvent {
     type: "walkstart";
 }
 /**
- * A {@link Viewer} pan to event.
+ * Event that fires when camera panning.
  *
  * @event
  */
@@ -386,7 +393,7 @@ export interface PanEvent {
     dY: number;
 }
 /**
- * A {@link Viewer} zoom event.
+ * Event that fires when zooming of the camera.
  *
  * @event
  */
@@ -401,7 +408,7 @@ export interface ZoomEvent {
     data?: any;
 }
 /**
- * A {@link Viewer} zoom at event.
+ * Event that fires when zooming of the camera.
  *
  * @event
  */
@@ -416,7 +423,7 @@ export interface ZoomAtEvent {
     data: number;
 }
 /**
- * A {@link Viewer} zoom to entity event.
+ * Event that fires when zooming to entity.
  *
  * @event
  */
@@ -433,170 +440,101 @@ export interface ZoomToEntityEvent {
 /**
  * Viewer Events
  */
-export interface ViewerEventMap {
+export interface ViewerEventMap extends CanvasEventMap {
     /**
-     * A {@link Viewer} event that fires when model loading has been canceled.
+     * Event that fires when model loading has been canceled.
      */
     cancel: CancelEvent;
     /**
-     * A {@link Viewer} event that fires when the active dragger has been changed.
+     * Event that fires when the active dragger has been changed.
      */
     changeactivedragger: ChangeActiveDraggerEvent;
     /**
-     * A {@link Viewer} event that fires when the markup color has been changed.
+     * Event that fires when the markup color has been changed.
      */
     changemarkupcolor: ChangeMarkupColorEvent;
     /**
-     * A {@link Viewer} event that fires when the viewer has been cleared.
+     * Event that fires when the viewer has been cleared.
      */
     clear: ClearEvent;
     /**
-     * A {@link Viewer} event that fires after viewer executes the command.
+     * Event that fires after viewer executes the command.
      */
     command: CommandEvent;
     /**
-     * A {@link Viewer} event that fires when the model scene description file has been loaded.
+     * Event that fires when the model scene description file has been loaded.
      */
     databasechunk: DatabaseChunkEvent;
     /**
-     * A {@link Viewer} event that fires before viewer resources has been released.
+     * Event that fires before viewer resources has been released.
      */
     dispose: DisposeEvent;
     /**
-     * A {@link Viewer} event that fires when the model geometry data chunk has been loaded.
+     * Event that fires when the model geometry data chunk has been loaded.
      */
     geometrychunk: GeometryChunkEvent;
     /**
-     * A {@link Viewer} event that fires after model has been successfully loaded.
+     * Event that fires after model has been successfully loaded.
      */
     geometryend: GeometryEndEvent;
     /**
-     * A {@link Viewer} event that fires when the model fails to open.
+     * Event that fires when the model fails to open.
      */
     geometryerror: GeometryErrorEvent;
     /**
-     * A {@link Viewer} event measuring progress of the model loading process.
+     * Event measuring progress of the model loading process.
      */
     geometryprogress: GeometryProgressEvent;
     /**
-     * A {@link Viewer} event that fires before the model opens.
+     * Event that fires before the model opens.
      */
     geometrystart: GeometryStartEvent;
     /**
-     * A {@link Viewer} event that fires before model opens.
+     * Event that fires before model opens.
      */
     open: OpenEvent;
     /**
-     * A {@link Viewer} event that fires when an rendering occurs.
+     * Event that fires when an rendering occurs.
      */
     render: RenderEvent;
     /**
-     * A {@link Viewer} event that fires when resize occurs.
+     * Event that fires when resize occurs.
      */
     resize: ResizeEvent;
     /**
-     * A {@link Viewer} event that fires when the selection changes.
+     * Event that fires when the selection changes.
      */
     select: SelectEvent;
     /**
-     * A {@link Viewer} event that fires when an update occurs.
+     * Event that fires when an update occurs.
      */
     update: UpdateEvent;
     /**
-     * A {@link Viewer} event measuring progress of loading a `VisualizeJS` library.
+     * Event measuring progress of loading a `VisualizeJS` library.
      */
     visualizeprogress: VisualizeProgressEvent;
     /**
-     * A {@link Viewer} event that fires when walk speed changing.
+     * Event that fires when walk speed changing.
      */
     walkspeedchange: WalkSpeedChangeEvent;
     /**
-     * A {@link Viewer} event that fires when walk started.
+     * Event that fires when walk started.
      */
     walkstart: WalkStartEvent;
     /**
-     * A {@link Viewer} pan event.
+     * Event that fires when camera panning.
      */
     pan: PanEvent;
     /**
-     * A {@link Viewer} zoom event.
+     * Event that fires when zooming of the camera.
      */
     zoom: ZoomEvent;
     /**
-     * A {@link Viewer} zoom at event.
+     * Event that fires when zooming of the camera.
      */
     zoomat: ZoomAtEvent;
     /**
-     * A {@link Viewer} zoom to entity event.
+     * Event that fires when zooming to entity.
      */
     zoomtoentity: ZoomToEntityEvent;
-    /**
-     * {@link Viewer} event that fires when the user attempts to open a context menu.
-     */
-    contextmenu: PointerEvent;
-    /**
-     * {@link Viewer} event that fires on mouse click.
-     */
-    click: MouseEvent;
-    /**
-     * A {@link Viewer} event that fires on mouse double click.
-     */
-    dblclick: MouseEvent;
-    /**
-     * A {@link Viewer} event that fires on mouse button is down.
-     */
-    mousedown: MouseEvent;
-    /**
-     * A {@link Viewer} event that fires on mouse leave.
-     */
-    mouseleave: MouseEvent;
-    /**
-     * A {@link Viewer} event that fires on mouse move.
-     */
-    mousemove: MouseEvent;
-    /**
-     * A {@link Viewer} event that fires on mouse button is up.
-     */
-    mouseup: MouseEvent;
-    /**
-     * A {@link Viewer} event is fired when the browser determines that there are unlikely to be
-     * any more pointer events.
-     */
-    pointercancel: PointerEvent;
-    /**
-     * A {@link Viewer} event that fires on mouse button is down.
-     */
-    pointerdown: PointerEvent;
-    /**
-     * A {@link Viewer} event that fires on mouse leave.
-     */
-    pointerleave: PointerEvent;
-    /**
-     * A {@link Viewer} event that fires on mouse move.
-     */
-    pointermove: PointerEvent;
-    /**
-     * A {@link Viewer} event that fires on mouse button is up.
-     */
-    pointerup: PointerEvent;
-    /**
-     * A {@link Viewer} event that fires touch is canceled.
-     */
-    touchcancel: TouchEvent;
-    /**
-     * A {@link Viewer} event that fires touch is ended.
-     */
-    touchend: TouchEvent;
-    /**
-     * A {@link Viewer} event that fires touch is moving.
-     */
-    touchmove: TouchEvent;
-    /**
-     * A {@link Viewer} event that fires when touch is started.
-     */
-    touchstart: TouchEvent;
-    /**
-     * A {@link Viewer} event that fires when mouse wheel is moving.
-     */
-    wheel: MouseEvent;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/viewer-core",
-  "version": "25.3.20",
+  "version": "25.3.22",
   "description": "3D CAD and BIM data Viewer core",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",

package/src/viewer/CanvasEvents.ts

@@ -21,21 +21,114 @@
 // acknowledge and accept the above terms.
 ///////////////////////////////////////////////////////////////////////////////
 
-export const CANVAS_EVENTS = [
+export const CanvasEvents = [
   "click",
+  "contextmenu",
   "dblclick",
   "mousedown",
+  "mouseleave",
   "mousemove",
   "mouseup",
-  "mouseleave",
+  "pointercancel",
   "pointerdown",
+  "pointerleave",
   "pointermove",
   "pointerup",
-  "pointerleave",
-  "pointercancel",
-  "wheel",
-  "touchstart",
-  "touchmove",
-  "touchend",
   "touchcancel",
+  "touchend",
+  "touchmove",
+  "touchstart",
+  "wheel",
 ];
+
+export const CANVAS_EVENTS = CanvasEvents;
+
+/**
+ * Canvas Events
+ */
+export interface CanvasEventMap {
+  /**
+   * Event that fires on mouse click.
+   */
+  click: MouseEvent;
+
+  /**
+   * Event that fires when the user attempts to open a context menu.
+   */
+  contextmenu: PointerEvent;
+
+  /**
+   * Event that fires on mouse double click.
+   */
+  dblclick: MouseEvent;
+
+  /**
+   * Event that fires on mouse button is down.
+   */
+  mousedown: MouseEvent;
+
+  /**
+   * Event that fires on mouse leave.
+   */
+  mouseleave: MouseEvent;
+
+  /**
+   * Event that fires on mouse move.
+   */
+  mousemove: MouseEvent;
+
+  /**
+   * Event that fires on mouse button is up.
+   */
+  mouseup: MouseEvent;
+
+  /**
+   * Event is fired when the browser determines that there are unlikely to be any more pointer events.
+   */
+  pointercancel: PointerEvent;
+
+  /**
+   * Event that fires on mouse button is down.
+   */
+  pointerdown: PointerEvent;
+
+  /**
+   * Event that fires on mouse leave.
+   */
+  pointerleave: PointerEvent;
+
+  /**
+   * Event that fires on mouse move.
+   */
+  pointermove: PointerEvent;
+
+  /**
+   * Event that fires on mouse button is up.
+   */
+  pointerup: PointerEvent;
+
+  /**
+   * Event that fires touch is canceled.
+   */
+  touchcancel: TouchEvent;
+
+  /**
+   * Event that fires touch is ended.
+   */
+  touchend: TouchEvent;
+
+  /**
+   * Event that fires touch is moving.
+   */
+  touchmove: TouchEvent;
+
+  /**
+   * Event that fires when touch is started.
+   */
+  touchstart: TouchEvent;
+
+  /**
+   * Event that fires when mouse wheel is moving.
+   */
+  wheel: MouseEvent;
+}