@inweb/viewer-visualize 26.1.0 → 26.1.2

package/src/Viewer/Viewer.ts

@@ -55,8 +55,8 @@ const OVERLAY_VIEW_NAME = "$OVERLAY_VIEW_NAME";
 const isExist = (value) => value !== undefined && value !== null;
 
 /**
- * 3D viewer powered by
- * {@link https://cloud.opendesign.com/docs/index.html#/visualizejs | VisualizeJS} library.
+ * 3D viewer powered by {@link https://cloud.opendesign.com/docs/index.html#/visualizejs | VisualizeJS}
+ * library.
  */
 export class Viewer
   extends EventEmitter2<ViewerEventMap & CanvasEventMap & OptionsEventMap>
@@ -86,18 +86,18 @@ export class Viewer
   public client: Client | undefined;
 
   /**
-   * @param client - The `Client` instance that is used to load model reference files from the
-   *   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 client - The `Client` instance that is used to load model reference files from the 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 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 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`.
+   * @param params.visualizeJsUrl - `VisualizeJS` library URL. Set this URL to use your own 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 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,
@@ -157,9 +157,9 @@ export class Viewer
    * Changes the viewer parameters.
    *
    * @param params - An object containing new parameters.
-   * @param params.visualizeJsUrl - `VisualizeJS` library URL. Set this URL to use your own
-   *   library instance or specify `undefined` or blank to use the default URL defined by
-   *   `Viewer.visualize` library you are using.
+   * @param params.visualizeJsUrl - `VisualizeJS` library URL. Set this URL to use your own 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 {
     this._visualizeJsUrl = params.visualizeJsUrl || "VISUALIZE_JS_URL";
@@ -176,10 +176,10 @@ export class Viewer
    * - {@link InitializeProgressEvent | initializeprogress}
    *
    * @param canvas -
-   *   {@link https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement | HTMLCanvasElement}
-   *   for `VisualizeJS`.
-   * @param onProgress - A callback function that handles events measuring progress of loading
-   *   of the `VisualizeJS` library.
+   *   {@link https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement | HTMLCanvasElement} for
+   *   `VisualizeJS`.
+   * @param onProgress - A callback function that handles events measuring progress of loading of the
+   *   `VisualizeJS` library.
    */
   async initialize(canvas: HTMLCanvasElement, onProgress?: (event: ProgressEvent) => void): Promise<this> {
     this.addEventListener("optionschange", (event) => this.syncOptions(event.data));
@@ -218,7 +218,7 @@ export class Viewer
 
     this._markup.initialize(this.canvas, this.canvasEvents, this, this);
 
-    for (let name of components.getComponents().keys()) {
+    for (const name of components.getComponents().keys()) {
       this._components.push(components.createComponent(name, this));
     }
 
@@ -306,15 +306,15 @@ export class Viewer
   /**
    * 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.
+   * 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:
    *
    * - {@link UpdateEvent | update}
    *
-   * @param force - If `true` updates the viewer immidietly. Otherwise updates on next
-   *   animation frame. Default is `false`.
+   * @param force - If `true` updates the viewer immidietly. Otherwise updates on next animation frame.
+   *   Default is `false`.
    */
   update(force = false) {
     if (this._enableAutoUpdate) {
@@ -347,11 +347,11 @@ export class Viewer
   }
 
   /**
-   * Updates the viewer asynchronously without locking the user interface. Used to update the
-   * viewer after changes that require a long rendering time.
+   * Updates the viewer asynchronously without locking the user interface. Used to update the viewer
+   * after changes that require a long rendering time.
    *
-   * 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.
+   * 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:
    *
@@ -376,24 +376,24 @@ export class Viewer
   }
 
   /**
-   * Returns `VisualizeJS`
-   * {@link https://cloud.opendesign.com/docs/index.html#/visualizejs_api | module} instance.
+   * Returns `VisualizeJS` {@link https://cloud.opendesign.com/docs/index.html#/visualizejs_api | module}
+   * instance.
    */
   get visualizeJs(): any {
     return this._visualizeJs;
   }
 
   /**
-   * Returns `VisualizeJS`
-   * {@link https://cloud.opendesign.com/docs/index.html#/visualizejs_api | module} instance.
+   * Returns `VisualizeJS` {@link https://cloud.opendesign.com/docs/index.html#/visualizejs_api | module}
+   * instance.
    */
   visLib(): any {
     return this.visualizeJs;
   }
 
   /**
-   * Returns `VisualizeJS`
-   * {@link https://cloud.opendesign.com/docs/index.html#/vis/Viewer | Viewer} instance.
+   * Returns `VisualizeJS` {@link https://cloud.opendesign.com/docs/index.html#/vis/Viewer | Viewer}
+   * instance.
    */
   visViewer(): any {
     return this.visualizeJs?.getViewer();
@@ -836,15 +836,15 @@ 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 streaming} mode
-   * before opening (see example below).
+   * To open a large file, enable {@link IOptions.enablePartialMode | partial streaming} 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
+   * 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()}.
    *
-   * If there was an active dragger before opening the file, it will be deactivated. After
-   * opening the file, you must manually activate the required dragger.
+   * If there was an active dragger before opening the file, it will be deactivated. After opening the
+   * file, you must manually activate the required dragger.
    *
    * Fires:
    *
@@ -856,14 +856,17 @@ export class Viewer
    * - {@link GeometryEndEvent | geometryend}
    * - {@link GeometryErrorEvent | geometryerror}
    *
-   * @example <caption>Using partial streaming mode to open a large file from a server.</caption>
-   *   viewer.options.enableStreamingMode = true;
-   *   viewer.options.enablePartialMode = true;
-   *   await viewer.open(file);
+   * @example Using partial streaming mode to open a large file from a server.
    *
-   * @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.
+   * ```javascript
+   * 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.
    */
   async open(file: File | Assembly | Model): Promise<this> {
     if (!this.visualizeJs) return this;
@@ -908,8 +911,8 @@ export class Viewer
    * This method does not support {@link IOptions.enableStreamingMode | streaming} or
    * {@link IOptions.enablePartialMode | partial streaming} mode.
    *
-   * If there was an active dragger before opening the file, it will be deactivated. After
-   * opening the file, you must manually activate the required dragger.
+   * If there was an active dragger before opening the file, it will be deactivated. After opening the
+   * file, you must manually activate the required dragger.
    *
    * Fires:
    *
@@ -961,8 +964,8 @@ export class Viewer
    * This method does not support {@link IOptions.enableStreamingMode | streaming} or
    * {@link IOptions.enablePartialMode | partial streaming} mode.
    *
-   * If there was an active dragger before opening the file, it will be deactivated. After
-   * opening the file, you must manually activate the required dragger.
+   * If there was an active dragger before opening the file, it will be deactivated. After opening the
+   * file, you must manually activate the required dragger.
    *
    * Fires:
    *
@@ -1165,6 +1168,7 @@ export class Viewer
       up_vector: this.getPoint3dFromArray(activeView.upVector),
       field_width: activeView.viewFieldWidth,
       field_height: activeView.viewFieldHeight,
+      view_to_world_scale: 1,
     };
   }
 
@@ -1231,8 +1235,8 @@ export class Viewer
   }
 
   /**
-   * Executes the command denoted by the given command. If the command is not found, tries to
-   * set active dragger with the specified name.
+   * 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 available by default:
    *
@@ -1264,8 +1268,8 @@ export class Viewer
    *
    * @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.
+   * @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.executeCommand(id, this, ...args);