@inweb/viewer-three 26.6.7 → 26.7.1

package/lib/Viewer/Viewer.d.ts

@@ -55,29 +55,20 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      * nothing.
      *
      * This method requires a `Client` instance to be specified to load file from the Open Cloud Server.
-     * The file geometry data on the Open Cloud Server must be converted into a format siutable for the
-     * viewer, otherwise an exception will be thrown.
+     * The file geometry data on the Open Cloud Server must be converted into a `gltf` format, otherwise an
+     * exception will be thrown.
      *
      * For files from Open Cloud Server, the default model will be loaded. If there is no default model,
      * first availiable model will be loaded. If no models are found in the file, an exception will be
      * thrown.
      *
-     * The file extension is used to determine the file format. For a `ArrayBuffer`, `Blob` and `Data URL`,
-     * a file format must be specified using `params.format` parameter (see below). If no appropriate
+     * For URLs, the file extension is used to determine the file format. For a `ArrayBuffer` and `Data
+     * URL`, a file format must be specified using `params.format` parameter (see below). If no appropriate
      * loader is found for the specified format, an exception will be thrown.
      *
      * 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.
      *
-     * To open a large files, enable {@link IOptions.enablePartialMode | partial streaming} mode before
-     * opening. For example:
-     *
-     * ```javascript
-     * viewer.options.enableStreamingMode = true;
-     * viewer.options.enablePartialMode = true;
-     * await viewer.open(file);
-     * ```
-     *
      * Fires:
      *
      * - {@link OpenEvent | open}
@@ -88,40 +79,47 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
      * - {@link GeometryEndEvent | geometryend}
      * - {@link GeometryErrorEvent | geometryerror}
      *
-     * @param file - File to load.
+     * @param file - File to load. Can be one of:
+     *
+     *   - `File`, `Assembly` or `Model` instance from the Open Cloud Server
+     *   - File `URL` string
+     *   - {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL} string
+     *   - {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object
+     *   - {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer}
+     *       object
+     *
      * @param params - Loading parameters.
-     * @param params.format - File format string. Required when loading a file as `ArrayBuffer`, `Blob` or
-     *   `Data URL`.
+     * @param params.format - File format string. Required when loading a file as `ArrayBuffer` or `Data
+     *   URL`.
      * @param params.mode - File opening mode. Can be one of:
      *
      *   - `open` - Unloads an open file and opens a new one. This is default mode.
      *   - `append` - Appends a file to an already open file.
      *
-     * @param params.externalFiles - External resource map such as binary data buffers or textures. Each
-     *   resource should be represented by a `uri` and a corresponding resource URL, or
-     *   {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object, or
-     *   {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer},
-     *   or {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob}, or
-     *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL} string,
-     * @param params.path - The base path from which additional resources will be loaded. If not defined,
-     *   the base path of the file URL will be used.
      * @param params.requestHeader - The
      *   {@link https://developer.mozilla.org/docs/Glossary/Request_header | request header} used in HTTP
      *   request.
-     * @param params.crossOrigin - The crossOrigin string to implement CORS for loading the url from a
-     *   different domain that allows CORS. Default is `anonymous`.
-     * @param params.withCredentials - Whether the XMLHttpRequest uses credentials such as cookies,
+     * @param params.withCredentials - Whether the HTTP request uses credentials such as cookies,
      *   authorization headers or TLS client certificates. See
      *   {@link https://developer.mozilla.org/docs/Web/API/XMLHttpRequest/withCredentials | XMLHttpRequest.withCredentials}.
+     * @param params.path - The base path from which external resources such as binary data buffers, images
+     *   or textures will be loaded. If not defined, the base path of the file URL will be used.
+     * @param params.externalFiles - External resource map. Each resource should be represented by a `uri`
+     *   and a corresponding resource URL, or
+     *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL} string, or
+     *   {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object, or
+     *   {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer}.
+     * @param params.crossOrigin - The crossOrigin string to implement CORS for loading the external
+     *   resources from a different domain that allows CORS. Default is `anonymous`.
      */
     open(file: FileSource, params?: {
         format?: string;
         mode?: string;
-        path?: string;
-        externalFiles?: Map<string, string | globalThis.File | ArrayBuffer | Blob>;
         requestHeader?: HeadersInit;
-        crossOrigin?: string;
         withCredentials?: boolean;
+        path?: string;
+        externalFiles?: Map<string, string | globalThis.File | ArrayBuffer>;
+        crossOrigin?: string;
     }): Promise<this>;
     /**
      * Deprecated since `26.4`. Use {@link open | open()} instead.

package/lib/Viewer/loaders/DynamicGltfLoader/DynamicModelImpl.d.ts

@@ -1,9 +1,6 @@
 import { Box3, Object3D } from "three";
 import { ModelImpl } from "../../model";
 import { DynamicGltfLoader } from "./DynamicGltfLoader.js";
-/**
- * Dynamic model implementation.
- */
 export declare class DynamicModelImpl extends ModelImpl {
     gltfLoader: DynamicGltfLoader;
     getExtents(target: Box3): Box3;

package/lib/Viewer/loaders/GLTFLoadingManager.d.ts

@@ -1,10 +1,10 @@
 import { LoadingManager } from "three";
-export type GLTFFileSource = string | globalThis.File | ArrayBuffer | Blob;
+export type GLTFFileSource = string | globalThis.File | ArrayBuffer;
 export type GLTFLoadParams = {
     path?: string;
     externalFiles?: Map<string, GLTFFileSource>;
-    requestHeader?: HeadersInit;
     crossOrigin?: string;
+    requestHeader?: HeadersInit;
     withCredentials?: boolean;
 };
 export declare class GLTFLoadingManager extends LoadingManager {

package/lib/Viewer/loaders/index.d.ts

@@ -7,12 +7,13 @@ import { ILoadersRegistry } from "@inweb/viewer-core";
  * 1. Define a loader class implements {@link ILoader}.
  * 2. Define a constructor with a `viewer` parameter.
  * 3. Override {@link ILoader.isSupport} and сheck if the loader can load the specified file.
- * 4. Override {@link ILoader.load} and define the logic for loading the model from the file.
+ * 4. Override {@link ILoader.load} and define the logic for loading the scene from the file.
  *
  *    The loader should do:
  *
- *    - Load model from file. The model must be a Three.js object of type `Object3D` or a descendant of it.
- *    - Add model to the viewer `scene` and `models` list.
+ *    - Load scene from file. The scene must be a Three.js object of type `Object3D` or a descendant of it.
+ *    - Add scene to the viewer `scene`.
+ *    - Create `ModelImpl` for the scene and to the viewer `models` list.
  *    - Synchronize viewer options and overlay.
  *    - Update the viewer.
  *
@@ -20,15 +21,14 @@ import { ILoadersRegistry } from "@inweb/viewer-core";
  *
  *    - `geometryprogress` - during loading. If progress is not supported, emit it once with a value of 100%
  *         after the load is complete.
- *    - `databasechunk` - when model is loaded and ready to render.
+ *    - `databasechunk` - when scene is loaded and ready to render.
  * 5. Override {@link ILoader.dispose} and release loader resources, if required.
  * 6. Register loader provider in the loaders registry by calling the {@link loaders.registerLoader}.
  *
  * @example Implementing a custom loader.
  *
  * ```javascript
- * import { Loader } from "@inweb/viewer-core";
- * import { loaders, Viewer } from "@inweb/viewer-three";
+ * import { loaders, Loader, ModelImpl, Viewer } from "@inweb/viewer-three";
  *
  * class MyLoader extends Loader {
  *   public viewer: Viewer;
@@ -46,16 +46,20 @@ import { ILoadersRegistry } from "@inweb/viewer-core";
  *   override load(file, format, params): Promise<this> {
  *
  *     // place custom loading logic here
- *     const model = ...;
+ *     const scene = ...;
  *
- *     this.viewer.scene.add(model);
- *     this.viewer.models.push(model);
+ *     const modelImpl = new ModelImpl(scene);
+ *     modelImpl.loader = this;
+ *     modelImpl.viewer = this.viewer;
+ *
+ *     this.viewer.scene.add(scene);
+ *     this.viewer.models.push(modelImpl);
  *
  *     this.viewer.syncOptions();
  *     this.viewer.syncOverlay();
  *     this.viewer.update();
  *
- *     this.viewer.emitEvent({ type: "databasechunk", data: model, file });
+ *     this.viewer.emitEvent({ type: "databasechunk", data: scene, file });
  *
  *     return Promise.resove(this);
  *   };

package/lib/Viewer/model/ModelImpl.d.ts

@@ -2,9 +2,6 @@ import { Box3, Object3D } from "three";
 import { ILoader } from "@inweb/viewer-core";
 import { IModelImpl } from "./IModelImpl";
 import { Viewer } from "../Viewer";
-/**
- * Basic model implementation.
- */
 export declare class ModelImpl implements IModelImpl {
     handle: string;
     scene: Object3D;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/viewer-three",
-  "version": "26.6.7",
+  "version": "26.7.1",
   "description": "JavaScript library for rendering CAD and BIM files in a browser using Three.js",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",
@@ -35,10 +35,10 @@
     "docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/client": "~26.6.7",
-    "@inweb/eventemitter2": "~26.6.7",
-    "@inweb/markup": "~26.6.7",
-    "@inweb/viewer-core": "~26.6.7"
+    "@inweb/client": "~26.7.1",
+    "@inweb/eventemitter2": "~26.7.1",
+    "@inweb/markup": "~26.7.1",
+    "@inweb/viewer-core": "~26.7.1"
   },
   "devDependencies": {
     "@types/three": "^0.173.0",

package/plugins/loaders/IFCXCloudLoader.ts

@@ -65,7 +65,7 @@ export class IFCXCloudLoader extends Loader {
     modelImpl.loader = this;
     modelImpl.viewer = this.viewer;
 
-    this.viewer.scene.add(modelImpl.scene);
+    this.viewer.scene.add(scene);
     this.viewer.models.push(modelImpl);
 
     this.viewer.syncOptions();

package/plugins/loaders/IFCXFileLoader.ts

@@ -66,7 +66,7 @@ export class IFCXFileLoader extends Loader {
     modelImpl.loader = this;
     modelImpl.viewer = this.viewer;
 
-    this.viewer.scene.add(modelImpl.scene);
+    this.viewer.scene.add(scene);
     this.viewer.models.push(modelImpl);
 
     this.viewer.syncOptions();

package/src/Viewer/Viewer.ts

@@ -273,29 +273,20 @@ export class Viewer
    * nothing.
    *
    * This method requires a `Client` instance to be specified to load file from the Open Cloud Server.
-   * The file geometry data on the Open Cloud Server must be converted into a format siutable for the
-   * viewer, otherwise an exception will be thrown.
+   * The file geometry data on the Open Cloud Server must be converted into a `gltf` format, otherwise an
+   * exception will be thrown.
    *
    * For files from Open Cloud Server, the default model will be loaded. If there is no default model,
    * first availiable model will be loaded. If no models are found in the file, an exception will be
    * thrown.
    *
-   * The file extension is used to determine the file format. For a `ArrayBuffer`, `Blob` and `Data URL`,
-   * a file format must be specified using `params.format` parameter (see below). If no appropriate
+   * For URLs, the file extension is used to determine the file format. For a `ArrayBuffer` and `Data
+   * URL`, a file format must be specified using `params.format` parameter (see below). If no appropriate
    * loader is found for the specified format, an exception will be thrown.
    *
    * 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.
    *
-   * To open a large files, enable {@link IOptions.enablePartialMode | partial streaming} mode before
-   * opening. For example:
-   *
-   * ```javascript
-   * viewer.options.enableStreamingMode = true;
-   * viewer.options.enablePartialMode = true;
-   * await viewer.open(file);
-   * ```
-   *
    * Fires:
    *
    * - {@link OpenEvent | open}
@@ -306,42 +297,49 @@ export class Viewer
    * - {@link GeometryEndEvent | geometryend}
    * - {@link GeometryErrorEvent | geometryerror}
    *
-   * @param file - File to load.
+   * @param file - File to load. Can be one of:
+   *
+   *   - `File`, `Assembly` or `Model` instance from the Open Cloud Server
+   *   - File `URL` string
+   *   - {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL} string
+   *   - {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object
+   *   - {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer}
+   *       object
+   *
    * @param params - Loading parameters.
-   * @param params.format - File format string. Required when loading a file as `ArrayBuffer`, `Blob` or
-   *   `Data URL`.
+   * @param params.format - File format string. Required when loading a file as `ArrayBuffer` or `Data
+   *   URL`.
    * @param params.mode - File opening mode. Can be one of:
    *
    *   - `open` - Unloads an open file and opens a new one. This is default mode.
    *   - `append` - Appends a file to an already open file.
    *
-   * @param params.externalFiles - External resource map such as binary data buffers or textures. Each
-   *   resource should be represented by a `uri` and a corresponding resource URL, or
-   *   {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object, or
-   *   {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer},
-   *   or {@link https://developer.mozilla.org/docs/Web/API/Blob/Blob | Blob}, or
-   *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL} string,
-   * @param params.path - The base path from which additional resources will be loaded. If not defined,
-   *   the base path of the file URL will be used.
    * @param params.requestHeader - The
    *   {@link https://developer.mozilla.org/docs/Glossary/Request_header | request header} used in HTTP
    *   request.
-   * @param params.crossOrigin - The crossOrigin string to implement CORS for loading the url from a
-   *   different domain that allows CORS. Default is `anonymous`.
-   * @param params.withCredentials - Whether the XMLHttpRequest uses credentials such as cookies,
+   * @param params.withCredentials - Whether the HTTP request uses credentials such as cookies,
    *   authorization headers or TLS client certificates. See
    *   {@link https://developer.mozilla.org/docs/Web/API/XMLHttpRequest/withCredentials | XMLHttpRequest.withCredentials}.
+   * @param params.path - The base path from which external resources such as binary data buffers, images
+   *   or textures will be loaded. If not defined, the base path of the file URL will be used.
+   * @param params.externalFiles - External resource map. Each resource should be represented by a `uri`
+   *   and a corresponding resource URL, or
+   *   {@link https://developer.mozilla.org/docs/Web/HTTP/Basics_of_HTTP/Data_URIs | Data URL} string, or
+   *   {@link https://developer.mozilla.org/docs/Web/API/File | Web API File} object, or
+   *   {@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ArrayBuffer}.
+   * @param params.crossOrigin - The crossOrigin string to implement CORS for loading the external
+   *   resources from a different domain that allows CORS. Default is `anonymous`.
    */
   async open(
     file: FileSource,
     params: {
       format?: string;
       mode?: string;
-      path?: string;
-      externalFiles?: Map<string, string | globalThis.File | ArrayBuffer | Blob>;
       requestHeader?: HeadersInit;
-      crossOrigin?: string;
       withCredentials?: boolean;
+      path?: string;
+      externalFiles?: Map<string, string | globalThis.File | ArrayBuffer>;
+      crossOrigin?: string;
     } = {}
   ): Promise<this> {
     if (!this.renderer) return this;
@@ -388,6 +386,10 @@ export class Viewer
    * @deprecated
    */
   openGltfFile(file, externalFiles, params: any = {}): Promise<this> {
+    console.warn(
+      "Viewer.openGltfFile() has been deprecated since 26.4 and will be removed in a future release, use Viewer.open() instead."
+    );
+
     return this.open(file, { ...params, format: "gltf", externalFiles });
   }
 
@@ -397,6 +399,10 @@ export class Viewer
    * @deprecated
    */
   loadGltfFile(file, externalFiles, params: any = {}): Promise<this> {
+    console.warn(
+      "Viewer.loadGltfFile() has been deprecated since 26.4 and will be removed in a future release, use Viewer.open() instead."
+    );
+
     return this.open(file, { ...params, format: "gltf", externalFiles, mode: "append" });
   }
 

package/src/Viewer/components/CameraComponent.ts

@@ -54,7 +54,7 @@ export class CameraComponent implements IComponent {
     if (sceneCamera) {
       this.viewer.camera = sceneCamera.clone();
       this.viewer.camera.up.set(0, 0, 1);
-      this.viewer.camera.scale.set(1, 1, 1); // <- visualize fix
+      this.viewer.camera.scale.set(1, 1, 1); // <- Visualize fix
     }
 
     const camera = this.viewer.camera as any;

package/src/Viewer/loaders/DynamicGltfLoader/DynamicModelImpl.ts

@@ -26,9 +26,8 @@ import { Box3, Object3D } from "three";
 import { ModelImpl } from "../../model";
 import { DynamicGltfLoader } from "./DynamicGltfLoader.js";
 
-/**
- * Dynamic model implementation.
- */
+// Dynamic model implementation.
+
 export class DynamicModelImpl extends ModelImpl {
   public gltfLoader: DynamicGltfLoader;
 

package/src/Viewer/loaders/GLTFFileLoader.ts

@@ -64,7 +64,7 @@ export class GLTFFileLoader extends Loader {
     modelImpl.loader = this;
     modelImpl.viewer = this.viewer;
 
-    this.viewer.scene.add(modelImpl.scene);
+    this.viewer.scene.add(gltf.scene);
     this.viewer.models.push(modelImpl);
 
     this.viewer.syncOptions();

package/src/Viewer/loaders/GLTFLoadingManager.ts

@@ -23,13 +23,13 @@
 
 import { LoadingManager, LoaderUtils } from "three";
 
-export type GLTFFileSource = string | globalThis.File | ArrayBuffer | Blob;
+export type GLTFFileSource = string | globalThis.File | ArrayBuffer;
 
 export type GLTFLoadParams = {
   path?: string;
   externalFiles?: Map<string, GLTFFileSource>;
-  requestHeader?: HeadersInit;
   crossOrigin?: string;
+  requestHeader?: HeadersInit;
   withCredentials?: boolean;
 };
 

package/src/Viewer/loaders/index.ts

@@ -34,12 +34,13 @@ import { GLTFCloudDynamicLoader } from "./GLTFCloudDynamicLoader";
  * 1. Define a loader class implements {@link ILoader}.
  * 2. Define a constructor with a `viewer` parameter.
  * 3. Override {@link ILoader.isSupport} and сheck if the loader can load the specified file.
- * 4. Override {@link ILoader.load} and define the logic for loading the model from the file.
+ * 4. Override {@link ILoader.load} and define the logic for loading the scene from the file.
  *
  *    The loader should do:
  *
- *    - Load model from file. The model must be a Three.js object of type `Object3D` or a descendant of it.
- *    - Add model to the viewer `scene` and `models` list.
+ *    - Load scene from file. The scene must be a Three.js object of type `Object3D` or a descendant of it.
+ *    - Add scene to the viewer `scene`.
+ *    - Create `ModelImpl` for the scene and to the viewer `models` list.
  *    - Synchronize viewer options and overlay.
  *    - Update the viewer.
  *
@@ -47,15 +48,14 @@ import { GLTFCloudDynamicLoader } from "./GLTFCloudDynamicLoader";
  *
  *    - `geometryprogress` - during loading. If progress is not supported, emit it once with a value of 100%
  *         after the load is complete.
- *    - `databasechunk` - when model is loaded and ready to render.
+ *    - `databasechunk` - when scene is loaded and ready to render.
  * 5. Override {@link ILoader.dispose} and release loader resources, if required.
  * 6. Register loader provider in the loaders registry by calling the {@link loaders.registerLoader}.
  *
  * @example Implementing a custom loader.
  *
  * ```javascript
- * import { Loader } from "@inweb/viewer-core";
- * import { loaders, Viewer } from "@inweb/viewer-three";
+ * import { loaders, Loader, ModelImpl, Viewer } from "@inweb/viewer-three";
  *
  * class MyLoader extends Loader {
  *   public viewer: Viewer;
@@ -73,16 +73,20 @@ import { GLTFCloudDynamicLoader } from "./GLTFCloudDynamicLoader";
  *   override load(file, format, params): Promise<this> {
  *
  *     // place custom loading logic here
- *     const model = ...;
+ *     const scene = ...;
  *
- *     this.viewer.scene.add(model);
- *     this.viewer.models.push(model);
+ *     const modelImpl = new ModelImpl(scene);
+ *     modelImpl.loader = this;
+ *     modelImpl.viewer = this.viewer;
+ *
+ *     this.viewer.scene.add(scene);
+ *     this.viewer.models.push(modelImpl);
  *
  *     this.viewer.syncOptions();
  *     this.viewer.syncOverlay();
  *     this.viewer.update();
  *
- *     this.viewer.emitEvent({ type: "databasechunk", data: model, file });
+ *     this.viewer.emitEvent({ type: "databasechunk", data: scene, file });
  *
  *     return Promise.resove(this);
  *   };

package/src/Viewer/model/ModelImpl.ts

@@ -27,9 +27,8 @@ import { ILoader } from "@inweb/viewer-core";
 import { IModelImpl } from "./IModelImpl";
 import { Viewer } from "../Viewer";
 
-/**
- * Basic model implementation.
- */
+// Basic model implementation.
+
 export class ModelImpl implements IModelImpl {
   public handle: string;
   public scene: Object3D;