@inweb/viewer-core 25.3.13

package/lib/viewer/ViewerEvents.d.ts

@@ -0,0 +1,599 @@
+import { Assembly, File, Model } from "@inweb/client";
+/**
+ * A {@link Viewer} event that fires when model loading has been canceled.
+ *
+ * @event
+ */
+export interface CancelEvent {
+    /**
+     * Event type.
+     */
+    type: "cancel";
+}
+/**
+ * A {@link Viewer} event that fires when the active dragger has been changed.
+ *
+ * @event
+ */
+export interface ChangeActiveDraggerEvent {
+    /**
+     * Event type.
+     */
+    type: "changeactivedragger";
+    /**
+     * Dragger name.
+     */
+    data: string;
+}
+/**
+ * A {@link Viewer} event that fires when the markup color has been changed.
+ *
+ * @event
+ */
+export interface ChangeMarkupColorEvent {
+    /**
+     * Event type.
+     */
+    type: "changemarkupcolor";
+    /**
+     * New color.
+     */
+    data: {
+        r: number;
+        g: number;
+        b: number;
+    };
+}
+/**
+ * A {@link Viewer} event that fires when the viewer has been cleared.
+ *
+ * @event
+ */
+export interface ClearEvent {
+    /**
+     * Event type.
+     */
+    type: "clear";
+}
+/**
+ * A {@link Viewer} event that fires after viewer executes the command.
+ *
+ * @event
+ */
+export interface CommandEvent {
+    /**
+     * Event type.
+     */
+    type: "command";
+    /**
+     * Command name.
+     */
+    data: string;
+    /**
+     * Command arguments.
+     */
+    args: any[];
+}
+/**
+ * A {@link Viewer} event that fires when the model scene description file has been loaded.
+ *
+ * @event
+ */
+export interface DatabaseChunkEvent {
+    /**
+     * Event type.
+     */
+    type: "databasechunk";
+    /**
+     * Scene description file.
+     */
+    data?: Uint8Array;
+    /**
+     * Model instance to open.
+     */
+    model?: Model;
+    /**
+     * Buffer to open.
+     */
+    buffer?: Uint8Array | ArrayBuffer;
+}
+/**
+ * A {@link Viewer} event that fires before viewer resources has been released.
+ *
+ * @event
+ */
+export interface DisposeEvent {
+    /**
+     * Event type.
+     */
+    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
+ */
+export interface GeometryChunkEvent {
+    /**
+     * Event type.
+     */
+    type: "geometrychunk";
+    /**
+     * Geometry data chunk.
+     */
+    data: Uint8Array;
+    /**
+     * Model instance to open.
+     */
+    model?: Model;
+    /**
+     * Buffer to open.
+     */
+    buffer?: Uint8Array | ArrayBuffer;
+}
+/**
+ * A {@link Viewer} event that fires after model has been successfully loaded.
+ *
+ * @event
+ */
+export interface GeometryEndEvent {
+    /**
+     * Event type.
+     */
+    type: "geometryend";
+    /**
+     * Model instance to open.
+     */
+    model?: Model;
+    /**
+     * Buffer to open.
+     */
+    buffer?: Uint8Array | ArrayBuffer;
+    /**
+     * Loaded data (viewer depended).
+     */
+    data?: any;
+}
+/**
+ * A {@link Viewer} event that fires when the model fails to load.
+ *
+ * @event
+ */
+export interface GeometryErrorEvent {
+    /**
+     * Event type.
+     */
+    type: "geometryerror";
+    /**
+     * Thrown exception.
+     */
+    data: Error;
+    /**
+     * Model instance to open.
+     */
+    model?: Model;
+    /**
+     * Buffer to open.
+     */
+    buffer?: Uint8Array | ArrayBuffer;
+}
+/**
+ * A {@link Viewer} event measuring progress of the model loading process.
+ *
+ * @event
+ */
+export interface GeometryProgressEvent {
+    /**
+     * Event type.
+     */
+    type: "geometryprogress";
+    /**
+     * The non-rounded progress value from 0 to 1. To get a percentage (%), multiply the `data` by 100.
+     */
+    data: number;
+    /**
+     * Model instance to open.
+     */
+    model?: Model;
+    /**
+     * Buffer to open.
+     */
+    buffer?: Uint8Array | ArrayBuffer;
+}
+/**
+ * A {@link Viewer} event that fires before the model loads.
+ *
+ * @event
+ */
+export interface GeometryStartEvent {
+    /**
+     * Event type.
+     */
+    type: "geometrystart";
+    /**
+     * Model instance to open.
+     */
+    model?: Model;
+    /**
+     * Buffer to open.
+     */
+    buffer?: Uint8Array | ArrayBuffer;
+}
+/**
+ * A {@link Viewer} event that fires before model opens.
+ *
+ * @event
+ */
+export interface OpenEvent {
+    /**
+     * Event type.
+     */
+    type: "open";
+    /**
+     * File instance to open.
+     */
+    file?: File | Assembly | Model;
+    model?: File | Assembly | Model;
+    /**
+     * Buffer to open.
+     */
+    buffer?: Uint8Array | ArrayBuffer;
+}
+/**
+ * A {@link Viewer} event that fires when rendering occurs.
+ *
+ * @event
+ */
+export interface RenderEvent {
+    /**
+     * Event type.
+     */
+    type: "render";
+    time: DOMHighResTimeStamp;
+    deltaTime: DOMHighResTimeStamp;
+}
+/**
+ * A {@link Viewer} event that fires when resize occurs.
+ *
+ * @event
+ */
+export interface ResizeEvent {
+    /**
+     * Event type.
+     */
+    type: "resize";
+    /**
+     * New width.
+     */
+    width: number;
+    /**
+     * New height.
+     */
+    height: number;
+}
+/**
+ * A {@link Viewer} event that fires when the selection changes.
+ *
+ * @event
+ */
+export interface SelectEvent {
+    /**
+     * Event type.
+     */
+    type: "select";
+    /**
+     * Selection set.
+     */
+    data: any;
+    /**
+     * Handles of selected entities.
+     */
+    handles: string[];
+}
+/**
+ * A {@link Viewer} event that fires when an update occurs.
+ *
+ * @event
+ */
+export interface UpdateEvent {
+    /**
+     * Event type.
+     */
+    type: "update";
+    /**
+     * `true` to force the update, otherwise the update is delayed until the next animation frame.
+     */
+    data: boolean;
+}
+/**
+ * A {@link Viewer} event measuring progress of loading a `VisualizeJS` library.
+ *
+ * @event
+ */
+export interface VisualizeProgressEvent {
+    /**
+     * Event type.
+     */
+    type: "visualizeprogress";
+    /**
+     * A 64-bit unsigned integer value indicating the amount of work already performed by the
+     * underlying process. The ratio of work done can be calculated by dividing total by the
+     * value of this property.
+     */
+    loaded: number;
+    /**
+     * A 64-bit unsigned integer representing the total amount of work that the underlying
+     * process is in the progress of performing.
+     */
+    total: number;
+}
+/**
+ * A {@link Viewer} event that fires when walk speed changing.
+ *
+ * @event
+ */
+export interface WalkSpeedChangeEvent {
+    /**
+     * Event type.
+     */
+    type: "walkspeedchange";
+    /**
+     * Multiplier
+     */
+    data: number;
+}
+/**
+ * A {@link Viewer} event that fires when walk started.
+ *
+ * @event
+ */
+export interface WalkStartEvent {
+    /**
+     * Event type.
+     */
+    type: "walkstart";
+}
+/**
+ * A {@link Viewer} pan to event.
+ *
+ * @event
+ */
+export interface PanEvent {
+    /**
+     * Event type.
+     */
+    type: "pan";
+    /**
+     * X coordinate.
+     */
+    x: number;
+    /**
+     * Y coordinate.
+     */
+    y: number;
+    /**
+     * delta X coordinate.
+     */
+    dX: number;
+    /**
+     * delta Y coordinate.
+     */
+    dY: number;
+}
+/**
+ * A {@link Viewer} zoom event.
+ *
+ * @event
+ */
+export interface ZoomEvent {
+    /**
+     * Event type.
+     */
+    type: "zoom";
+    /**
+     * New view parameters.
+     */
+    data?: any;
+}
+/**
+ * A {@link Viewer} zoom at event.
+ *
+ * @event
+ */
+export interface ZoomAtEvent {
+    /**
+     * Event type.
+     */
+    type: "zoomat";
+    /**
+     * Zoom factor
+     */
+    data: number;
+}
+/**
+ * A {@link Viewer} zoom to entity event.
+ *
+ * @event
+ */
+export interface ZoomToEntityEvent {
+    /**
+     * Event type.
+     */
+    type: "zoomtoentity";
+    /**
+     * Entity
+     */
+    data: any;
+}
+/**
+ * Viewer Events
+ */
+export interface ViewerEventMap {
+    /**
+     * A {@link Viewer} event that fires when model loading has been canceled.
+     */
+    cancel: CancelEvent;
+    /**
+     * A {@link Viewer} 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.
+     */
+    changemarkupcolor: ChangeMarkupColorEvent;
+    /**
+     * A {@link Viewer} event that fires when the viewer has been cleared.
+     */
+    clear: ClearEvent;
+    /**
+     * A {@link Viewer} 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.
+     */
+    databasechunk: DatabaseChunkEvent;
+    /**
+     * A {@link Viewer} 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.
+     */
+    geometrychunk: GeometryChunkEvent;
+    /**
+     * A {@link Viewer} event that fires after model has been successfully loaded.
+     */
+    geometryend: GeometryEndEvent;
+    /**
+     * A {@link Viewer} event that fires when the model fails to open.
+     */
+    geometryerror: GeometryErrorEvent;
+    /**
+     * A {@link Viewer} event measuring progress of the model loading process.
+     */
+    geometryprogress: GeometryProgressEvent;
+    /**
+     * A {@link Viewer} event that fires before the model opens.
+     */
+    geometrystart: GeometryStartEvent;
+    /**
+     * A {@link Viewer} event that fires before model opens.
+     */
+    open: OpenEvent;
+    /**
+     * A {@link Viewer} event that fires when an rendering occurs.
+     */
+    render: RenderEvent;
+    /**
+     * A {@link Viewer} event that fires when resize occurs.
+     */
+    resize: ResizeEvent;
+    /**
+     * A {@link Viewer} event that fires when the selection changes.
+     */
+    select: SelectEvent;
+    /**
+     * A {@link Viewer} event that fires when an update occurs.
+     */
+    update: UpdateEvent;
+    /**
+     * A {@link Viewer} event measuring progress of loading a `VisualizeJS` library.
+     */
+    visualizeprogress: VisualizeProgressEvent;
+    /**
+     * A {@link Viewer} event that fires when walk speed changing.
+     */
+    walkspeedchange: WalkSpeedChangeEvent;
+    /**
+     * A {@link Viewer} event that fires when walk started.
+     */
+    walkstart: WalkStartEvent;
+    /**
+     * A {@link Viewer} pan event.
+     */
+    pan: PanEvent;
+    /**
+     * A {@link Viewer} zoom event.
+     */
+    zoom: ZoomEvent;
+    /**
+     * A {@link Viewer} zoom at event.
+     */
+    zoomat: ZoomAtEvent;
+    /**
+     * A {@link Viewer} zoom to entity event.
+     */
+    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

@@ -0,0 +1,34 @@
+{
+  "name": "@inweb/viewer-core",
+  "version": "25.3.13",
+  "description": "3D CAD and BIM data Viewer core for the inWEB Open Cloud platform.",
+  "homepage": "https://cloud.opendesign.com/docs/index.html",
+  "license": "SEE LICENSE IN LICENSE",
+  "author": "Open Design Alliance",
+  "keywords": [
+    "opendesign",
+    "opencloud",
+    "inweb",
+    "viewer",
+    "core"
+  ],
+  "sideEffects": false,
+  "main": "dist/viewer-core.js",
+  "module": "dist/viewer-core.module.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "dist",
+    "lib/**/*.d.ts",
+    "src"
+  ],
+  "scripts": {
+    "build": "rollup -c rollup.config.js",
+    "test": "karma start karma.conf.js"
+  },
+  "devDependencies": {
+    "@inweb/eventemitter2": "^25.3.12"
+  },
+  "peerDependencies": {
+    "@inweb/eventemitter2": "^25.3.12"
+  }
+}

package/src/commands/Commands.ts

@@ -0,0 +1,84 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2002-2023, Open Design Alliance (the "Alliance").
+// All rights reserved.
+//
+// This software and its documentation and related materials are owned by
+// the Alliance. The software may only be incorporated into application
+// programs owned by members of the Alliance, subject to a signed
+// Membership Agreement and Supplemental Software License Agreement with the
+// Alliance. The structure and organization of this software are the valuable
+// trade secrets of the Alliance and its suppliers. The software is also
+// protected by copyright law and international treaty provisions. Application
+// programs incorporating this software must include the following statement
+// with their copyright notices:
+//
+//   This application incorporates Open Design Alliance software pursuant to a
+//   license agreement with Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2021 by Open Design Alliance.
+//   All rights reserved.
+//
+// By use of this software, its documentation or related materials, you
+// acknowledge and accept the above terms.
+///////////////////////////////////////////////////////////////////////////////
+
+import { IViewer } from "../viewer/IViewer";
+import { ICommand, ICommandHandler, ICommandDescription, ICommandsMap, ICommands } from "./ICommands";
+
+class Commands implements ICommands {
+  private readonly _commands = new Map<string, ICommand>();
+
+  registerCommand(id: string, handler: ICommandHandler, description?: ICommandDescription, thisArg?: any): void {
+    this._commands.set(id, { id, handler, thisArg, description });
+  }
+
+  registerCommandAlias(id: string, alias: string): void {
+    this.registerCommand(alias, (viewer: IViewer, ...args) => this.executeCommand(id, viewer, ...args));
+  }
+
+  getCommand(id: string): ICommand | undefined {
+    return this._commands.get(id);
+  }
+
+  getCommands(): ICommandsMap {
+    const map = new Map<string, ICommand>();
+    this._commands.forEach((value, key) => map.set(key, value));
+    return map;
+  }
+
+  executeCommand(id: string, viewer: IViewer, ...args: any[]): any {
+    const command = this._commands.get(id);
+    if (!command) {
+      if (viewer) {
+        const isDraggerCommand = viewer.draggers.includes(id);
+        if (isDraggerCommand) return viewer.setActiveDragger(id);
+      }
+
+      console.warn(`Command '${id}' not found`);
+      return undefined;
+    }
+
+    const { handler, thisArg } = command;
+    const result = handler.apply(thisArg, [viewer, ...args]);
+
+    viewer?.emit({ type: "command", data: id, args });
+
+    return result;
+  }
+}
+
+const _commands = new Map<string, Commands>();
+
+function commands(viewerType = ""): ICommands {
+  let result = _commands.get(viewerType);
+  if (!result) {
+    result = new Commands();
+    _commands.set(viewerType, result);
+  }
+  return result;
+}
+
+commands("").registerCommand("noop", () => {});
+commands("VisualizeJS").registerCommand("noop", () => {});
+commands("ThreeJS").registerCommand("noop", () => {});
+
+export { commands };