@inweb/viewer-visualize 25.3.20 → 25.3.22

package/README.md

@@ -1,10 +1,10 @@
 # Viewer.visualize
 
-`Viewer.visualize` is JavaScript library powered by [Visualize](https://www.opendesign.com/products/visualize) for in-browser visualization of 3D CAD and BIM data in browser from `VSFX` files stored on the [Open Cloud Server](https://cloud.opendesign.com/docs/index.html#/opencloud_server), on the web, or on your local computer.
+`Viewer.visualize` is JavaScript library powered by [Visualize](https://www.opendesign.com/products/visualize) for in-browser visualization of 3D CAD and BIM data files stored on the [Open Cloud Server](https://cloud.opendesign.com/docs/index.html#/opencloud_server), on the web, or on your local computer.
 
-This library enables you to integrate advanced visualization capabilities into your web applications, including user interaction with scenes and objects, markups, and collaboration using the [inWEB Open Cloud](https://www.opendesign.com/products/open-cloud) platform.
+This library enables you to integrate advanced visualization capabilities into your web applications, including user interaction with scenes and markup creation.
 
-> `VSFX` is an internal [Visualize SDK](https://cloud.opendesign.com/docs/index.html#/visualizejs) file format with support for streaming and partial viewing.
+> `Viewer.visualize` uses `VSFX` file format as internal geometry data format. `VSFX` is a [Visualize SDK](https://cloud.opendesign.com/docs/index.html#/visualizejs) file format with support for streaming and partial viewing.
 
 ## Installation
 

package/dist/viewer-visualize.js

@@ -365,7 +365,9 @@
         }
     }
 
-    const CANVAS_EVENTS = [ "click", "dblclick", "mousedown", "mousemove", "mouseup", "mouseleave", "pointerdown", "pointermove", "pointerup", "pointerleave", "pointercancel", "wheel", "touchstart", "touchmove", "touchend", "touchcancel" ];
+    const CanvasEvents = [ "click", "contextmenu", "dblclick", "mousedown", "mouseleave", "mousemove", "mouseup", "pointercancel", "pointerdown", "pointerleave", "pointermove", "pointerup", "touchcancel", "touchend", "touchmove", "touchstart", "wheel" ];
+
+    const CANVAS_EVENTS = CanvasEvents;
 
     ///////////////////////////////////////////////////////////////////////////////
     const composeMatrixFromTransform = (translate, rotate, scale, modelCenter, matrix) => {
@@ -809,20 +811,6 @@
     ///////////////////////////////////////////////////////////////////////////////
     const CLICK_DELTA = 5;
     const INTERACTIVITY_FPS = 24;
-    /**
-     * A [Viewer]{@link Viewer} event that fires when the viewer needs to be updated.
-     *
-     * @property {string} type - `update`
-     * @event update
-     */
-    /**
-     * A [Viewer]{@link Viewer} event that fires when the user selects an entity with the mouse.
-     *
-     * @property {string} type - `select`
-     * @property {OdTvSelectionSet} data - The set of selected entities. For more information, see
-     *   [OdTvSelectionSet](https://cloud.opendesign.com/docs/index.html#/vis/OdTvSelectionSet?id=odtvselectionset).
-     * @event select
-     */
     class OdBaseDragger extends OdaGeAction {
         constructor(subject) {
             super(subject.visualizeJs);
@@ -16426,7 +16414,7 @@
             markupDraggers === null || markupDraggers === void 0 ? void 0 : markupDraggers.forEach((value, key) => {
                 this.registerDragger(key, value);
             });
-            this.canvasEvents = CANVAS_EVENTS;
+            this.canvasEvents = CANVAS_EVENTS.slice();
             this.canvaseventlistener = (event) => this.emit(event);
             this._enableAutoUpdate = (_b = params.enableAutoUpdate) !== null && _b !== void 0 ? _b : true;
             this._isNeedRender = false;
@@ -16494,7 +16482,7 @@
                 const event = { loaded, timeStamp, total, lengthComputable, type: "visualizeprogress" };
                 onProgress === null || onProgress === void 0 ? void 0 : onProgress(event);
             });
-            this.visualizeJs = visualizeJs;
+            this._visualizeJs = visualizeJs;
             this.visualizeJs.canvas = canvas;
             this.visualizeJs.Viewer.create();
             this.canvas = canvas;
@@ -16519,23 +16507,30 @@
          * release the `Viewer` instance.
          */
         dispose() {
-            var _a, _b, _c, _d;
             this.cancel();
             this.emitEvent({ type: "dispose" });
             if (this.frameId)
                 cancelAnimationFrame(this.frameId);
             this.frameId = 0;
             this.setActiveDragger("");
-            (_a = this._zoomWheelDragger) === null || _a === void 0 ? void 0 : _a.dispose();
-            (_b = this._gestureManager) === null || _b === void 0 ? void 0 : _b.dispose();
             this.removeAllListeners();
-            (_c = this._resizeObserver) === null || _c === void 0 ? void 0 : _c.disconnect();
+            if (this._gestureManager)
+                this._gestureManager.dispose();
+            this._gestureManager = undefined;
+            if (this._zoomWheelDragger)
+                this._zoomWheelDragger.dispose();
+            this._zoomWheelDragger = undefined;
+            if (this._resizeObserver)
+                this._resizeObserver.disconnect();
             this._resizeObserver = undefined;
             this.markup.dispose();
-            this.canvasEvents.forEach((x) => { var _a; return (_a = this.canvas) === null || _a === void 0 ? void 0 : _a.removeEventListener(x, this.canvaseventlistener); });
-            this.canvas = undefined;
-            (_d = this.visualizeJs) === null || _d === void 0 ? void 0 : _d.getViewer().clear();
-            this.visualizeJs = undefined;
+            if (this.canvas) {
+                this.canvasEvents.forEach((x) => this.canvas.removeEventListener(x, this.canvaseventlistener));
+                this.canvas = undefined;
+            }
+            if (this._visualizeJs)
+                this._visualizeJs.getViewer().clear();
+            this._visualizeJs = undefined;
             return this;
         }
         /**
@@ -16638,6 +16633,13 @@
                 this._isRunAsyncUpdate = false;
             }
         }
+        /**
+         * Returns `VisualizeJS`
+         * {@link https://cloud.opendesign.com/docs/index.html#/visualizejs_api | module} instance.
+         */
+        get visualizeJs() {
+            return this._visualizeJs;
+        }
         /**
          * Returns `VisualizeJS`
          * {@link https://cloud.opendesign.com/docs/index.html#/visualizejs_api | module} instance.
@@ -16827,7 +16829,7 @@
          *
          * Fires:
          *
-         * - {@link ChangeActiveDragger | changeactivedragger}
+         * - {@link ChangeActiveDraggerEvent | changeactivedragger}
          *
          * @param name - Dragger name. Can be one of the {@link Viewer#draggers | draggers} list.
          * @returns Returns active dragger instance or `null` if there is no dragger with the given name.
@@ -17187,7 +17189,7 @@
         colorizeAllMarkup(r = 255, g = 0, b = 0) {
             this.markup.colorizeAllMarkup(r, g, b);
         }
-        /**
+        /*
          * Add an empty markup entity to the overlay.
          */
         addMarkupEntity(entityName) {
@@ -17207,10 +17209,9 @@
         }
         /**
          * Draw a viewpoint. To get a list of available model viewpoints, use the
-         * {@link Model#getViewpoints | Model.getViewpoints()} or
-         * {@link File#getViewpoints | File.getViewpoints()}.
+         * {@link Model.getViewpoints()} or {@link File.getViewpoints()}.
          *
-         * @param viewpoint - Viewpoint.
+         * @param viewpoint - Viewpoint data.
          */
         drawViewpoint(viewpoint) {
             this.setOrthogonalCameraSettings(viewpoint.orthogonal_camera);
@@ -17219,8 +17220,7 @@
         }
         /**
          * Create a viewpoint. To add a viewpoint to the list of model viewpoints, use the
-         * {@link Model#saveViewpoint | Model.saveViewpoint()} or
-         * {@link File#saveViewpoint | File.saveViewpoint()}.
+         * {@link Model.saveViewpoint()} or {@link File.saveViewpoint()}.
          */
         createViewpoint() {
             const vp = this.markup.getViewpoint();
@@ -17295,6 +17295,7 @@
     }
 
     exports.CANVAS_EVENTS = CANVAS_EVENTS;
+    exports.CanvasEvents = CanvasEvents;
     exports.OdBaseDragger = OdBaseDragger;
     exports.Options = Options;
     exports.Viewer = Viewer;