@inweb/viewer-visualize 25.9.7 → 25.10.0

package/lib/Viewer/Viewer.d.ts

@@ -82,6 +82,7 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      *
      * Fires:
      *
+     * - {@link InitializeEvent | initialize}
      * - {@link InitializeProgressEvent | initializeprogress}
      *
      * @param canvas -
@@ -91,10 +92,6 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      *   of the `VisualizeJS` library.
      */
     initialize(canvas: HTMLCanvasElement, onProgress?: (event: ProgressEvent) => void): Promise<this>;
-    /**
-     * 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;
     /**
      * Returns `true` if `VisualizeJS` module has been loaded and initialized.
@@ -181,25 +178,8 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      * @param dragger - Dragger class.
      */
     registerDragger(name: string, dragger: typeof Dragger): void;
-    /**
-     * Returns the active dragger instance, or `null` if there is no active dragger.
-     */
     activeDragger(): IDragger | null;
-    /**
-     * Changes the active dragger. Viewer must be initialized before enable dragger or exception is thrown.
-     *
-     * Fires:
-     *
-     * - {@link ChangeActiveDraggerEvent | changeactivedragger}
-     *
-     * @param name - Dragger name. Can be one of the {@link draggers} list.
-     * @returns Returns the new active dragger instance or `null` if there is no dragger with the
-     *   given name.
-     */
-    setActiveDragger(name: string): IDragger | null;
-    /**
-     * Resets the state of the active dragger.
-     */
+    setActiveDragger(name?: string): IDragger | null;
     resetActiveDragger(): void;
     /**
      * Removes all cutting planes.
@@ -213,9 +193,6 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      * Creates an overlay view. Overlay view is used to draw cutting planes and `Visualize` markups.
      */
     syncOverlay(): any;
-    /**
-     * Returns `true` if current opened model is 3D model.
-     */
     is3D(): boolean;
     screenToWorld(position: {
         x: number;
@@ -260,6 +237,9 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      *
      * The file geometry data on the server must be converted to `VSFX` format.
      *
+     * To open a large file, enable {@link IOptions.enablePartialMode | partial load} mode before
+     * opening (see example below).
+     *
      * This method requires a `Client` instance to be specified when creating the viewer to load
      * model reference files from the Open Cloud Server. For a standalone viewer instance use
      * {@link openVsfFile | openVsfFile()} or {@link openVsfxFile | openVsfxFile()}.
@@ -274,6 +254,11 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      * - {@link GeometryEndEvent | geometryend}
      * - {@link GeometryErrorEvent | geometryerror}
      *
+     * @example <caption>Using partial load mode to open a large file from a server.</caption>
+     *   viewer.options.enableStreamingMode = true;
+     *   viewer.options.enablePartialMode = true;
+     *   await viewer.open(file);
+     *
      * @param file - File, assembly or specific model to load. If a `File` instance with multiple
      *   models is specified, the default model will be loaded. If there is no default model,
      *   first availiable model will be loaded.
@@ -315,13 +300,7 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      * @param buffer - Binary data buffer to load.
      */
     openVsfxFile(buffer: Uint8Array | ArrayBuffer): this;
-    /**
-     * Cancels asynchronous file loading started by {@link open | open()}.
-     */
     cancel(): this;
-    /**
-     * Unloads an open file and clears the canvas and markups.
-     */
     clear(): this;
     /**
      * Returns the color of new markup objects.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@inweb/viewer-visualize",
-  "version": "25.9.7",
-  "description": "3D viewer powered by VisualizeJS",
+  "version": "25.10.0",
+  "description": "JavaScript library for rendering CAD and BIM files in a browser using 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.9.7",
-    "@inweb/eventemitter2": "~25.9.7",
-    "@inweb/markup": "~25.9.7",
-    "@inweb/viewer-core": "~25.9.7"
+    "@inweb/client": "~25.10.0",
+    "@inweb/eventemitter2": "~25.10.0",
+    "@inweb/markup": "~25.10.0",
+    "@inweb/viewer-core": "~25.10.0"
   },
-  "visualizeJS": "https://opencloud.azureedge.net/libs/visualizejs/master/Visualize.js"
+  "visualizeJS": "https://public-fhemb7e3embacwec.z02.azurefd.net/libs/visualizejs/master/Visualize.js"
 }

package/src/Viewer/Viewer.ts

@@ -65,7 +65,6 @@ const isExist = (value) => value !== undefined && value !== null;
  * 3D viewer powered by
  * {@link https://cloud.opendesign.com/docs/index.html#/visualizejs | VisualizeJS} library.
  */
-
 export class Viewer
   extends EventEmitter2<ViewerEventMap & CanvasEventMap & OptionsEventMap>
   implements IViewer, IWorldTransform
@@ -196,6 +195,7 @@ export class Viewer
    *
    * Fires:
    *
+   * - {@link InitializeEvent | initialize}
    * - {@link InitializeProgressEvent | initializeprogress}
    *
    * @param canvas -
@@ -262,10 +262,6 @@ export class Viewer
     return this;
   }
 
-  /**
-   * 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();
     this.emitEvent({ type: "dispose" });
@@ -273,7 +269,7 @@ export class Viewer
     if (this.frameId) cancelAnimationFrame(this.frameId);
     this.frameId = 0;
 
-    this.setActiveDragger("");
+    this.setActiveDragger();
     this.removeAllListeners();
 
     if (this._gestureManager) this._gestureManager.dispose();
@@ -659,25 +655,11 @@ export class Viewer
     this.draggerFactory.set(name, dragger);
   }
 
-  /**
-   * Returns the active dragger instance, or `null` if there is no active dragger.
-   */
   activeDragger(): IDragger | null {
     return this._activeDragger;
   }
 
-  /**
-   * Changes the active dragger. Viewer must be initialized before enable dragger or exception is thrown.
-   *
-   * Fires:
-   *
-   * - {@link ChangeActiveDraggerEvent | changeactivedragger}
-   *
-   * @param name - Dragger name. Can be one of the {@link draggers} list.
-   * @returns Returns the new active dragger instance or `null` if there is no dragger with the
-   *   given name.
-   */
-  setActiveDragger(name: string): IDragger | null {
+  setActiveDragger(name = ""): IDragger | null {
     if (this._activeDragger?.name !== name) {
       if (this._activeDragger) {
         this._activeDragger.dispose();
@@ -705,13 +687,10 @@ export class Viewer
     return this._activeDragger;
   }
 
-  /**
-   * Resets the state of the active dragger.
-   */
   resetActiveDragger(): void {
     const dragger = this._activeDragger;
     if (dragger) {
-      this.setActiveDragger("");
+      this.setActiveDragger();
       this.setActiveDragger(dragger.name);
     }
   }
@@ -775,9 +754,6 @@ export class Viewer
     this.update();
   }
 
-  /**
-   * Returns `true` if current opened model is 3D model.
-   */
   is3D(): boolean {
     if (!this.visualizeJs) return false;
 
@@ -911,6 +887,9 @@ export class Viewer
    *
    * The file geometry data on the server must be converted to `VSFX` format.
    *
+   * To open a large file, enable {@link IOptions.enablePartialMode | partial load} mode before
+   * opening (see example below).
+   *
    * This method requires a `Client` instance to be specified when creating the viewer to load
    * model reference files from the Open Cloud Server. For a standalone viewer instance use
    * {@link openVsfFile | openVsfFile()} or {@link openVsfxFile | openVsfxFile()}.
@@ -925,6 +904,11 @@ export class Viewer
    * - {@link GeometryEndEvent | geometryend}
    * - {@link GeometryErrorEvent | geometryerror}
    *
+   * @example <caption>Using partial load mode to open a large file from a server.</caption>
+   *   viewer.options.enableStreamingMode = true;
+   *   viewer.options.enablePartialMode = true;
+   *   await viewer.open(file);
+   *
    * @param file - File, assembly or specific model to load. If a `File` instance with multiple
    *   models is specified, the default model will be loaded. If there is no default model,
    *   first availiable model will be loaded.
@@ -1063,9 +1047,6 @@ export class Viewer
     return this;
   }
 
-  /**
-   * Cancels asynchronous file loading started by {@link open | open()}.
-   */
   cancel(): this {
     this._abortControllerForReferences?.abort();
     this._abortControllerForReferences = undefined;
@@ -1081,15 +1062,13 @@ export class Viewer
     return this;
   }
 
-  /**
-   * Unloads an open file and clears the canvas and markups.
-   */
   clear(): this {
     if (!this.visualizeJs) return this;
 
     const visLib = this.visLib();
     const visViewer = visLib.getViewer();
 
+    this.setActiveDragger();
     this.clearOverlay();
 
     visViewer.clear();
@@ -1193,11 +1172,11 @@ export class Viewer
    * To save a viewpoint to the server for a specific file, use the `File.saveViewpoint()`.
    */
   createViewpoint(): IViewpoint {
-    const vp = this._markup.getViewpoint();
-    vp.orthogonal_camera = this.getOrthogonalCameraSettings();
-    vp.clipping_planes = this.getClippingPlanes();
+    const viewpoint = this._markup.getViewpoint();
+    viewpoint.orthogonal_camera = this.getOrthogonalCameraSettings();
+    viewpoint.clipping_planes = this.getClippingPlanes();
 
-    return vp;
+    return viewpoint;
   }
 
   private getPoint3dFromArray(array) {