@inweb/viewer-core 25.3.20 → 25.3.22

package/src/viewer/ViewerEvents.ts

@@ -1,7 +1,8 @@
 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
  */
@@ -13,7 +14,7 @@ export interface CancelEvent {
 }
 
 /**
- * A {@link Viewer} event that fires when the active dragger has been changed.
+ * Event that fires when the active dragger has been changed.
  *
  * @event
  */
@@ -30,7 +31,7 @@ export interface ChangeActiveDraggerEvent {
 }
 
 /**
- * A {@link Viewer} event that fires when the markup color has been changed.
+ * Event that fires when the markup color has been changed.
  *
  * @event
  */
@@ -47,7 +48,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
  */
@@ -59,7 +60,7 @@ export interface ClearEvent {
 }
 
 /**
- * A {@link Viewer} event that fires after viewer executes the command.
+ * Event that fires after viewer executes the command.
  *
  * @event
  */
@@ -81,7 +82,7 @@ export interface 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.
  *
  * @event
  */
@@ -108,7 +109,7 @@ export interface DatabaseChunkEvent {
 }
 
 /**
- * A {@link Viewer} event that fires before viewer resources has been released.
+ * Event that fires before viewer resources has been released.
  *
  * @event
  */
@@ -120,9 +121,9 @@ export interface DisposeEvent {
 }
 
 /**
- * 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
  */
@@ -149,7 +150,7 @@ export interface GeometryChunkEvent {
 }
 
 /**
- * A {@link Viewer} event that fires after model has been successfully loaded.
+ * Event that fires after model has been successfully loaded.
  *
  * @event
  */
@@ -176,7 +177,7 @@ export interface GeometryEndEvent {
 }
 
 /**
- * A {@link Viewer} event that fires when the model fails to load.
+ * Event that fires when the model fails to load.
  *
  * @event
  */
@@ -203,7 +204,7 @@ export interface GeometryErrorEvent {
 }
 
 /**
- * A {@link Viewer} event measuring progress of the model loading process.
+ * Event measuring progress of the model loading process.
  *
  * @event
  */
@@ -230,7 +231,7 @@ export interface GeometryProgressEvent {
 }
 
 /**
- * A {@link Viewer} event that fires before the model loads.
+ * Event that fires before the model loads.
  *
  * @event
  */
@@ -252,7 +253,7 @@ export interface GeometryStartEvent {
 }
 
 /**
- * A {@link Viewer} event that fires before model opens.
+ * Event that fires before model opens.
  *
  * @event
  */
@@ -279,7 +280,7 @@ export interface OpenEvent {
 }
 
 /**
- * A {@link Viewer} event that fires when rendering occurs.
+ * Event that fires when rendering occurs.
  *
  * @event
  */
@@ -289,13 +290,19 @@ export interface RenderEvent {
    */
   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
  */
@@ -317,7 +324,7 @@ export interface ResizeEvent {
 }
 
 /**
- * A {@link Viewer} event that fires when the selection changes.
+ * Event that fires when the selection changes.
  *
  * @event
  */
@@ -339,7 +346,7 @@ export interface SelectEvent {
 }
 
 /**
- * A {@link Viewer} event that fires when an update occurs.
+ * Event that fires when an update occurs.
  *
  * @event
  */
@@ -356,7 +363,7 @@ export interface UpdateEvent {
 }
 
 /**
- * A {@link Viewer} event measuring progress of loading a `VisualizeJS` library.
+ * Event measuring progress of loading a `VisualizeJS` library.
  *
  * @event
  */
@@ -381,7 +388,7 @@ export interface VisualizeProgressEvent {
 }
 
 /**
- * A {@link Viewer} event that fires when walk speed changing.
+ * Event that fires when walk speed changing.
  *
  * @event
  */
@@ -392,13 +399,13 @@ 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
  */
@@ -410,7 +417,7 @@ export interface WalkStartEvent {
 }
 
 /**
- * A {@link Viewer} pan to event.
+ * Event that fires when camera panning.
  *
  * @event
  */
@@ -439,7 +446,7 @@ export interface PanEvent {
 }
 
 /**
- * A {@link Viewer} zoom event.
+ * Event that fires when zooming of the camera.
  *
  * @event
  */
@@ -456,7 +463,7 @@ export interface ZoomEvent {
 }
 
 /**
- * A {@link Viewer} zoom at event.
+ * Event that fires when zooming of the camera.
  *
  * @event
  */
@@ -473,7 +480,7 @@ export interface ZoomAtEvent {
 }
 
 /**
- * A {@link Viewer} zoom to entity event.
+ * Event that fires when zooming to entity.
  *
  * @event
  */
@@ -492,212 +499,124 @@ 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;
-
-  // Canvas events
-
-  /**
-   * {@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;
 }