@inweb/viewer-visualize 25.9.0 → 25.9.2

package/lib/Viewer/Viewer.d.ts

@@ -77,7 +77,7 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
         visualizeJsUrl?: string;
     }): this;
     /**
-     * Loads the `VisualizeJS` module and initialize it with the specified canvas. Call
+     * Loads the `VisualizeJS` module and initializes it with the specified canvas. Call
      * {@link dispose | dispose()} to release allocated resources.
      *
      * Fires:
@@ -92,8 +92,8 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      */
     initialize(canvas: HTMLCanvasElement, onProgress?: (event: ProgressEvent) => void): Promise<this>;
     /**
-     * Releases all resources allocated by this viewer instance. Call this method before release
-     * the `Viewer` instance.
+     * Unloads an open file, clears the canvas and markups, and releases resources allocated by
+     * this viewer instance. Call this method before release the `Viewer` instance.
      */
     dispose(): this;
     /**
@@ -151,7 +151,9 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
     syncOptions(options?: IOptions): this;
     syncHighlightingOptions(options?: IOptions): this;
     /**
-     * List of names of registered draggers. By default, the following draggers are registered:
+     * List of names of registered draggers.
+     *
+     * The following draggers are registered by default:
      *
      * - `Line`
      * - `Text`
@@ -166,19 +168,21 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      * - `CuttingPlaneZAxis`
      * - `Walk`
      *
-     * @readonly
+     * To register your own command use the {@link registerDragger | registerDragger()}.
      */
     get draggers(): string[];
     /**
-     * Registers a dragger for the viewer. Dragger is an object that received mouse/keyboard
-     * events and does something to the viewer.
+     * Registers a dragger for the viewer.
+     *
+     * Dragger is an object that received mouse/keyboard events and does something to the viewer.
+     * For a quick tutorial on how to create your own dragger, see {@link Dragger}.
      *
      * @param name - Dragger name.
      * @param dragger - Dragger class.
      */
     registerDragger(name: string, dragger: typeof Dragger): void;
     /**
-     * Returns active dragger instance or `null` if there is no active dragger.
+     * Returns the active dragger instance, or `null` if there is no active dragger.
      */
     activeDragger(): IDragger | null;
     /**
@@ -189,7 +193,8 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      * - {@link ChangeActiveDraggerEvent | changeactivedragger}
      *
      * @param name - Dragger name. Can be one of the {@link draggers} list.
-     * @returns Returns active dragger instance or `null` if there is no dragger with the given name.
+     * @returns Returns the new active dragger instance or `null` if there is no dragger with the
+     *   given name.
      */
     setActiveDragger(name: string): IDragger | null;
     /**
@@ -209,7 +214,7 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      */
     syncOverlay(): any;
     /**
-     * Returns `true` if current model is 3D model.
+     * Returns `true` if current opened model is 3D model.
      */
     is3D(): boolean;
     screenToWorld(position: {
@@ -305,11 +310,11 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      */
     openVsfxFile(buffer: Uint8Array | ArrayBuffer): this;
     /**
-     * Cancels asynchronous model loading started by {@link open | open()}.
+     * Cancels asynchronous file loading started by {@link open | open()}.
      */
     cancel(): this;
     /**
-     * Unloads the model and clears the viewer and markups.
+     * Unloads an open file and clears the canvas and markups.
      */
     clear(): this;
     /**
@@ -374,11 +379,42 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
     private getClippingPlanes;
     private setClippingPlanes;
     /**
-     * Executes the command denoted by the given command identifier.
-     *
-     * @param id - Identifier of the command to execute.
-     * @param args - Parameters passed to the command function.
-     * @returns A returned value of the given command. Returns `undefined` when the command doesn't exists.
+     * Executes the command denoted by the given command. If the command is not found, tries to
+     * set active dragger with the specified name.
+     *
+     * The following commands are registered by default:
+     *
+     * - `applyModelTransform`
+     * - `autoTransformAllModelsToCentralPoint`
+     * - `clearMarkup`
+     * - `clearSlices`
+     * - `createPreview`
+     * - `explode`
+     * - `getDefaultViewPositions`
+     * - `getModels`
+     * - `getSelected`
+     * - `hideSelected`
+     * - `isolateSelected`
+     * - `regenerateAll`
+     * - `resetView`
+     * - `selectModel`
+     * - `setActiveDragger`
+     * - `setDefaultViewPosition`
+     * - `setMarkupColor`
+     * - `setSelected`
+     * - `showAll`
+     * - `unselect`
+     * - `zoomToExtents`
+     * - `zoomToObjects`
+     * - `zoomToSelected`
+     *
+     * To register your own command use the {@link ICommands.registerCommand | registerCommand()}
+     * method of the {@link commands} manager.
+     *
+     * @param id - Command ID or dragger name.
+     * @param args - Parameters passed to the command handler function.
+     * @returns Returns the result of the command handler function or new active dragger
+     *   instance. Returns `undefined` if neither the command nor the dragger exists.
      */
     executeCommand(id: string, ...args: any[]): any;
     deviceAutoRegeneration(): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/viewer-visualize",
-  "version": "25.9.0",
+  "version": "25.9.2",
   "description": "3D viewer powered by VisualizeJS",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -29,10 +29,10 @@
     "docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/client": "~25.9.0",
-    "@inweb/eventemitter2": "~25.9.0",
-    "@inweb/markup": "~25.9.0",
-    "@inweb/viewer-core": "~25.9.0"
+    "@inweb/client": "~25.9.2",
+    "@inweb/eventemitter2": "~25.9.2",
+    "@inweb/markup": "~25.9.2",
+    "@inweb/viewer-core": "~25.9.2"
   },
   "visualizeJS": "https://opencloud.azureedge.net/libs/visualizejs/master/Visualize.js"
 }

package/src/Viewer/Draggers/OdZoomDragger.ts

@@ -45,7 +45,7 @@ export class OdZoomDragger extends OdBaseDragger {
   }
 
   override drag(x: number, y: number, dltX: number, dltY: number): void {
-    if (this.press && Math.abs(dltY) <= 10e-6) {
+    if (this.press && Math.abs(dltY) >= 10e-6) {
       const ZOOM_SPEED = 0.025;
       const zoomFactor = dltY > 0 ? 1 + ZOOM_SPEED : 1 - ZOOM_SPEED;
       this._zoomAction.action(this.pressX, this.pressY, zoomFactor);

package/src/Viewer/Viewer.ts

@@ -191,7 +191,7 @@ export class Viewer
   }
 
   /**
-   * Loads the `VisualizeJS` module and initialize it with the specified canvas. Call
+   * Loads the `VisualizeJS` module and initializes it with the specified canvas. Call
    * {@link dispose | dispose()} to release allocated resources.
    *
    * Fires:
@@ -263,8 +263,8 @@ export class Viewer
   }
 
   /**
-   * Releases all resources allocated by this viewer instance. Call this method before release
-   * the `Viewer` instance.
+   * Unloads an open file, clears the canvas and markups, and releases resources allocated by
+   * this viewer instance. Call this method before release the `Viewer` instance.
    */
   dispose(): this {
     this.cancel();
@@ -623,7 +623,9 @@ export class Viewer
   }
 
   /**
-   * List of names of registered draggers. By default, the following draggers are registered:
+   * List of names of registered draggers.
+   *
+   * The following draggers are registered by default:
    *
    * - `Line`
    * - `Text`
@@ -638,15 +640,17 @@ export class Viewer
    * - `CuttingPlaneZAxis`
    * - `Walk`
    *
-   * @readonly
+   * To register your own command use the {@link registerDragger | registerDragger()}.
    */
   get draggers(): string[] {
     return [...this.draggerFactory.keys()];
   }
 
   /**
-   * Registers a dragger for the viewer. Dragger is an object that received mouse/keyboard
-   * events and does something to the viewer.
+   * Registers a dragger for the viewer.
+   *
+   * Dragger is an object that received mouse/keyboard events and does something to the viewer.
+   * For a quick tutorial on how to create your own dragger, see {@link Dragger}.
    *
    * @param name - Dragger name.
    * @param dragger - Dragger class.
@@ -656,7 +660,7 @@ export class Viewer
   }
 
   /**
-   * Returns active dragger instance or `null` if there is no active dragger.
+   * Returns the active dragger instance, or `null` if there is no active dragger.
    */
   activeDragger(): IDragger | null {
     return this._activeDragger;
@@ -670,7 +674,8 @@ export class Viewer
    * - {@link ChangeActiveDraggerEvent | changeactivedragger}
    *
    * @param name - Dragger name. Can be one of the {@link draggers} list.
-   * @returns Returns active dragger instance or `null` if there is no dragger with the given name.
+   * @returns Returns the new active dragger instance or `null` if there is no dragger with the
+   *   given name.
    */
   setActiveDragger(name: string): IDragger | null {
     if (this._activeDragger?.name !== name) {
@@ -771,7 +776,7 @@ export class Viewer
   }
 
   /**
-   * Returns `true` if current model is 3D model.
+   * Returns `true` if current opened model is 3D model.
    */
   is3D(): boolean {
     if (!this.visualizeJs) return false;
@@ -1053,7 +1058,7 @@ export class Viewer
   }
 
   /**
-   * Cancels asynchronous model loading started by {@link open | open()}.
+   * Cancels asynchronous file loading started by {@link open | open()}.
    */
   cancel(): this {
     this._abortControllerForReferences?.abort();
@@ -1071,7 +1076,7 @@ export class Viewer
   }
 
   /**
-   * Unloads the model and clears the viewer and markups.
+   * Unloads an open file and clears the canvas and markups.
    */
   clear(): this {
     if (!this.visualizeJs) return this;
@@ -1267,11 +1272,42 @@ export class Viewer
   }
 
   /**
-   * Executes the command denoted by the given command identifier.
+   * Executes the command denoted by the given command. If the command is not found, tries to
+   * set active dragger with the specified name.
+   *
+   * The following commands are registered by default:
+   *
+   * - `applyModelTransform`
+   * - `autoTransformAllModelsToCentralPoint`
+   * - `clearMarkup`
+   * - `clearSlices`
+   * - `createPreview`
+   * - `explode`
+   * - `getDefaultViewPositions`
+   * - `getModels`
+   * - `getSelected`
+   * - `hideSelected`
+   * - `isolateSelected`
+   * - `regenerateAll`
+   * - `resetView`
+   * - `selectModel`
+   * - `setActiveDragger`
+   * - `setDefaultViewPosition`
+   * - `setMarkupColor`
+   * - `setSelected`
+   * - `showAll`
+   * - `unselect`
+   * - `zoomToExtents`
+   * - `zoomToObjects`
+   * - `zoomToSelected`
+   *
+   * To register your own command use the {@link ICommands.registerCommand | registerCommand()}
+   * method of the {@link commands} manager.
    *
-   * @param id - Identifier of the command to execute.
-   * @param args - Parameters passed to the command function.
-   * @returns A returned value of the given command. Returns `undefined` when the command doesn't exists.
+   * @param id - Command ID or dragger name.
+   * @param args - Parameters passed to the command handler function.
+   * @returns Returns the result of the command handler function or new active dragger
+   *   instance. Returns `undefined` if neither the command nor the dragger exists.
    */
   executeCommand(id: string, ...args: any[]): any {
     return commands("VisualizeJS").executeCommand(id, this, ...args);