@inweb/viewer-visualize 25.8.16 → 25.8.20

package/lib/Viewer/Markup/MarkupFactory.d.ts

@@ -1,12 +1,8 @@
 import { IMarkup } from "@inweb/markup";
 /**
- * The markup type: `Visualize` (deprecated) or `Konva`.
+ * Defines the type of the markup core.
  */
-export declare enum MarkupType {
-    Unknown = 0,
-    Konva = "Konva",
-    Visualize = "Visualize"
-}
+export type MarkupType = "Konva" | "Visualize";
 export declare class MarkupFactory {
     static createMarkup(markupType?: MarkupType): IMarkup;
 }

package/lib/Viewer/Viewer.d.ts

@@ -4,7 +4,7 @@ import { CanvasEventMap, Dragger, IDragger, IOptions, IViewer, IViewpoint, Optio
 import { IMarkup, IWorldTransform } from "@inweb/markup";
 import { MarkupType } from "./Markup/MarkupFactory";
 /**
- * The `Client.js` library class that provides methods to integrate with the
+ * 3D viewer powered by
  * {@link https://cloud.opendesign.com/docs/index.html#/visualizejs | VisualizeJS} library.
  */
 export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMap & OptionsEventMap> implements IViewer, IWorldTransform {
@@ -31,19 +31,17 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
     _abortControllerForReferences: AbortController | undefined;
     client: Client | undefined;
     /**
-     * @param client - The `Client` instance that provides access to a server. Do not specify
-     *   `Client` if you need a standalone viewer instance without access to server models.
+     * @param client - The `Client` instance that provides access to a Open Cloud Server. Do not
+     *   specify `Client` if you need a standalone viewer instance to view `VSFX` files from the
+     *   web or from local computer.
      * @param params - An object containing viewer configuration parameters.
      * @param params.visualizeJsUrl - `VisualizeJS` library URL. Set this URL to use your own
-     *   library instance, or leave it undefined or blank to use the default URL defined by
-     *   `Client.js` you are using.
-     *
-     *   _Note: Your own `VisualizeJS` library version must match the version of the `Client.js`
-     *   you are using._
+     *   library instance, or specify `undefined` or blank to use the default URL defined by
+     *   `Viewer.visualize` library you are using.
      * @param params.enableAutoUpdate - Enable auto-update of the viewer after any changes. If
-     *   the auto-update is disabled, you need to register the `update` event handler and update
-     *   the viewer and the active dragger manually. Default is `true`.
-     * @param params.markupType - Specifies type of the markup core: `Visualize` (deprecated) or
+     *   the auto-update is disabled, you need to register an `update` event handler and update
+     *   the `VisualizeJS` viewer and active dragger manually. Default is `true`.
+     * @param params.markupType - The type of the markup core: `Visualize` (deprecated) or
      *   `Konva`. Default is `Konva`.
      */
     constructor(client?: Client, params?: {
@@ -54,7 +52,7 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
     /**
      * Viewer options.
      */
-    get options(): Options;
+    get options(): IOptions;
     /**
      * `VisualizeJS` library URL. Use {@link configure | configure()} to change library URL.
      *
@@ -62,23 +60,24 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      */
     get visualizeJsUrl(): string;
     /**
-     * 2D markup core.
+     * 2D markup core instance used to create markups.
      *
      * @readonly
      */
     get markup(): IMarkup;
     /**
-     * Change the viewer configuration parameters.
+     * Changes the viewer parameters.
      *
-     * @param params - An object containing new configuration parameters.
+     * @param params - An object containing new parameters.
      * @param params.visualizeJsUrl - `VisualizeJS` library URL. Set this URL to use your own
-     *   library instance or leave it blank to use the default URL defined by `Client.js`.
+     *   library instance or specify `undefined` or blank to use the default URL defined by
+     *   `Viewer.visualize` library you are using.
      */
     configure(params: {
         visualizeJsUrl?: string;
     }): this;
     /**
-     * Load `VisualizeJS` module and initialize it with the specified canvas. Call
+     * Loads the `VisualizeJS` module and initialize it with the specified canvas. Call
      * {@link dispose | dispose()} to release allocated resources.
      *
      * Fires:
@@ -93,19 +92,21 @@ 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.
+     * Releases all resources allocated by this viewer instance. Call this method before release
+     * the `Viewer` instance.
      */
     dispose(): this;
     /**
-     * Returns `true` if `VisualizeJS` module has been loaded andinitialized.
+     * Returns `true` if `VisualizeJS` module has been loaded and initialized.
      */
     isInitialized(): boolean;
     private render;
     resize(): this;
     /**
-     * Updates the viewer. Do nothing if the auto-update mode is disabled in the constructor (use
-     * the `update` event to update viewer manually).
+     * Updates the viewer.
+     *
+     * Do nothing if the auto-update mode is disabled in the constructor. In this case, register
+     * an `update` event handler and update the `Visualize` viewer and active dragger manually.
      *
      * Fires:
      *
@@ -115,15 +116,21 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      *   animation frame. Default is `false`.
      */
     update(force?: boolean): void;
+    private scheduleUpdateAsync;
     /**
-     * Update with internal schedule, need after change operation when have long update for
-     * update without lock UI
+     * Updates the viewer asynchronously without locking the user interface. Used to update the
+     * viewer after changes that require a long rendering time.
      *
-     * @param maxScheduleUpdateTimeInMs - Maximum time for one update, by default 30 ms
-     * @param maxScheduleUpdateCount - Maximum count of schedule update
-     * @returns return void Promise
+     * Do nothing if the auto-update mode is disabled in the constructor. In this case, register
+     * an `update` event handler and update the `VisualizeJS` viewer and active dragger manually.
+     *
+     * Fires:
+     *
+     * - {@link UpdateEvent | update}
+     *
+     * @param maxScheduleUpdateTimeInMs - Maximum time for one update, default 30 ms.
+     * @param maxScheduleUpdateCount - Maximum count of scheduled updates.
      */
-    private scheduleUpdateAsync;
     updateAsync(maxScheduleUpdateTimeInMs?: number, maxScheduleUpdateCount?: number): Promise<void>;
     /**
      * Returns `VisualizeJS`
@@ -144,7 +151,7 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
     syncOptions(options?: IOptions): this;
     syncHighlightingOptions(options?: IOptions): this;
     /**
-     * List of names of available draggers:
+     * List of names of registered draggers. By default, the following draggers are registered:
      *
      * - `Line`
      * - `Text`
@@ -163,7 +170,8 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      */
     get draggers(): string[];
     /**
-     * Register dragger on draggerFactory.
+     * Registers a dragger for the viewer. Dragger is an object that received mouse/keyboard
+     * events and does something to the viewer.
      *
      * @param name - Dragger name.
      * @param dragger - Dragger class.
@@ -174,7 +182,7 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      */
     activeDragger(): IDragger | null;
     /**
-     * Set active dragger. `Viewer` must be initialized before enable dragger or exception is thrown.
+     * Changes the active dragger. Viewer must be initialized before enable dragger or exception is thrown.
      *
      * Fires:
      *
@@ -185,23 +193,23 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      */
     setActiveDragger(name: string): IDragger | null;
     /**
-     * Reset the state of the active dragger.
+     * Resets the state of the active dragger.
      */
     resetActiveDragger(): void;
     /**
-     * Remove all cutting planes.
+     * Removes all cutting planes.
      */
     clearSlices(): void;
     /**
-     * Clear overlay view.
+     * Clears the overlay view.
      */
     clearOverlay(): void;
     /**
-     * Create overlay view.
+     * Creates an overlay view. Overlay view is used to draw cutting planes and `Visualize` markups.
      */
     syncOverlay(): any;
     /**
-     * Returns `true` if current drawing is 3D drawing.
+     * Returns `true` if current model is 3D model.
      */
     is3D(): boolean;
     screenToWorld(position: {
@@ -226,13 +234,11 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
         z: number;
     };
     /**
-     * Returns a list of original handles for the selected entities.
+     * Returns a list of original handles for the selected objects.
      */
     getSelected(): string[];
     /**
-     * Select model entities by original handles that are obtained using
-     * {@link File.getProperties | File.getProperties()} or
-     * {@link File.searchProperties | File.searchProperties()} methods.
+     * Selects the model objects by original handles that are obtained using `File.searchProperties()`.
      *
      * Fires:
      *
@@ -241,18 +247,11 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      * @param handles - The list of original handles.
      */
     setSelected(handles?: string[]): void;
-    /**
-     * Load model references into the viewer. References are images, fonts, or any other files to
-     * correct rendering of the model.
-     *
-     * @param model - Instance of model with references. If a `File` instance is specified
-     *   instead of a model, the file references will be loaded.
-     */
     loadReferences(model: Model | File | Assembly): Promise<this>;
     applyModelTransformMatrix(model: Model | Assembly): void;
-    applySceneGraphSettings(options?: Options): void;
+    applySceneGraphSettings(options?: IOptions): void;
     /**
-     * Loads a model of a file or assembly into the viewer.
+     * Loads a model/file/assembly into the viewer.
      *
      * This method requires a {@link Client} instance to work. For standalone viewer instance use
      * {@link openVsfFile | openVsfFile()} or {@link openVsfxFile | openVsfxFile()}.
@@ -273,7 +272,7 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      */
     open(file: File | Assembly | Model): Promise<this>;
     /**
-     * Loads a VSF file into the viewer.
+     * Loads a `VSF` file into the viewer.
      *
      * Fires:
      *
@@ -288,7 +287,7 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      */
     openVsfFile(buffer: Uint8Array | ArrayBuffer): this;
     /**
-     * Loads a VSFX file into the viewer.
+     * Loads a `VSFX` file into the viewer.
      *
      * Fires:
      *
@@ -307,13 +306,11 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      */
     cancel(): this;
     /**
-     * Unloads the model and clears the viewer.
+     * Unloads the model and clears the viewer and markups.
      */
     clear(): this;
     /**
-     * Get markup color.
-     *
-     * @returns Color with `RGB` values.
+     * Returns the color of new markup objects.
      */
     getMarkupColor(): {
         r: number;
@@ -321,7 +318,11 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
         b: number;
     };
     /**
-     * Set markup color.
+     * Sets the color of new markup objects.
+     *
+     * Fires:
+     *
+     * - {@link ChangeMarkupColorEvent | changemarkupcolor}
      *
      * @param r - `Red` part of color.
      * @param g - `Green` part of color.
@@ -329,7 +330,7 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      */
     setMarkupColor(r?: number, g?: number, b?: number): void;
     /**
-     * Colorize all markup entities with the specified color.
+     * Colors all markup objects with the specified color.
      *
      * @param r - `Red` part of color.
      * @param g - `Green` part of color.
@@ -337,7 +338,7 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      */
     colorizeAllMarkup(r?: number, g?: number, b?: number): void;
     /**
-     * Colorize all selected markup entities with the specified color.
+     * Colors selected markup objects with the specified color.
      *
      * @param r - `Red` part of color.
      * @param g - `Green` part of color.
@@ -345,19 +346,21 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      */
     colorizeSelectedMarkups(r?: number, g?: number, b?: number): void;
     /**
-     * Add an empty markup entity to the overlay.
+     * Adds an empty `Visualize` markup entity to the overlay.
      */
     addMarkupEntity(entityName: string): any;
     /**
-     * Draw a viewpoint. To get a list of available model viewpoints, use the
-     * `Model.getViewpoints()` or `File.getViewpoints()` or `Assembly.getViewpoints()`.
+     * Sets the viewer state to the specified viewpoint.
+     *
+     * To get a list of available model viewpoints, use the `File.getViewpoints()`.
      *
      * @param viewpoint - Viewpoint data.
      */
     drawViewpoint(viewpoint: IViewpoint): void;
     /**
-     * Create a viewpoint. To add a viewpoint to the list of model viewpoints, use the
-     * `Model.saveViewpoint()` or `File.saveViewpoint()` or . `Assembly.saveViewpoint()`.
+     * Saves the viewer state at the viewpoint.
+     *
+     * To save a viewpoint to a model on the server, use the `File.saveViewpoint()`.
      */
     createViewpoint(): IViewpoint;
     private getPoint3dFromArray;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@inweb/viewer-visualize",
-  "version": "25.8.16",
-  "description": "3D CAD and BIM data Viewer powered by Visualize",
+  "version": "25.8.20",
+  "description": "3D viewer powered by VisualizeJS",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Open Design Alliance",
@@ -29,10 +29,10 @@
     "docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/client": "~25.8.16",
-    "@inweb/eventemitter2": "~25.8.16",
-    "@inweb/markup": "~25.8.16",
-    "@inweb/viewer-core": "~25.8.16"
+    "@inweb/client": "~25.8.20",
+    "@inweb/eventemitter2": "~25.8.20",
+    "@inweb/markup": "~25.8.20",
+    "@inweb/viewer-core": "~25.8.20"
   },
   "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) {
+    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/Markup/MarkupFactory.ts

@@ -25,24 +25,20 @@ import { IMarkup, Markup as KonvaMarkup } from "@inweb/markup";
 import { VisualizeMarkup } from "./Visualize/VisualizeMarkup";
 
 /**
- * The markup type: `Visualize` (deprecated) or `Konva`.
+ * Defines the type of the markup core.
  */
-export enum MarkupType {
-  Unknown,
-  Konva = "Konva",
-  Visualize = "Visualize",
-}
+export type MarkupType = "Konva" | "Visualize";
 
 export class MarkupFactory {
-  public static createMarkup(markupType: MarkupType = MarkupType.Konva): IMarkup {
+  public static createMarkup(markupType: MarkupType = "Konva"): IMarkup {
     let markup: IMarkup;
 
     switch (markupType) {
-      case MarkupType.Konva:
+      case "Konva":
         markup = new KonvaMarkup();
         break;
 
-      case MarkupType.Visualize:
+      case "Visualize":
         markup = new VisualizeMarkup();
         break;