@inweb/viewer-visualize 26.5.0 → 26.5.2

package/lib/Viewer/Loaders/{UpdaterController.d.ts → UpdateController.d.ts}

@@ -4,7 +4,7 @@ export declare enum UpdateType {
     kNormal = 1,
     kForce = 2
 }
-export declare class UpdaterController {
+export declare class UpdateController {
     private lastUpdate;
     private viewer;
     delayUpdateTime: number;

package/lib/Viewer/Loaders/VSFBufferLoader.d.ts

@@ -0,0 +1,8 @@
+import { Loader } from "@inweb/viewer-core";
+import { Viewer } from "../Viewer";
+export declare class VSFBufferLoader extends Loader {
+    viewer: Viewer;
+    constructor(viewer: Viewer);
+    isSupport(file: any, format?: string): boolean;
+    load(buffer: any, format?: string): Promise<this>;
+}

package/lib/Viewer/Loaders/VSFModelLoader.d.ts

@@ -0,0 +1,8 @@
+import { Loader } from "@inweb/viewer-core";
+import { Viewer } from "../Viewer";
+export declare class VSFModelLoader extends Loader {
+    viewer: Viewer;
+    constructor(viewer: Viewer);
+    isSupport(file: any, format?: string): boolean;
+    load(model: any, format?: string): Promise<this>;
+}

package/lib/Viewer/Loaders/VSFXBufferLoader.d.ts

@@ -0,0 +1,8 @@
+import { Loader } from "@inweb/viewer-core";
+import { Viewer } from "../Viewer";
+export declare class VSFXBufferLoader extends Loader {
+    viewer: Viewer;
+    constructor(viewer: Viewer);
+    isSupport(file: any, format?: string): boolean;
+    load(buffer: any, format?: string): Promise<this>;
+}

package/lib/Viewer/Loaders/VSFXModelLoader.d.ts

@@ -0,0 +1,8 @@
+import { Loader } from "@inweb/viewer-core";
+import { Viewer } from "../Viewer";
+export declare class VSFXModelLoader extends Loader {
+    viewer: Viewer;
+    constructor(viewer: Viewer);
+    isSupport(file: any): boolean;
+    load(model: any, format?: string, params?: any): Promise<this>;
+}

package/lib/Viewer/Loaders/VSFXPartialLoader.d.ts

@@ -0,0 +1,10 @@
+import { Loader } from "@inweb/viewer-core";
+import { Viewer } from "../Viewer";
+export declare class VSFXPartialLoader extends Loader {
+    viewer: Viewer;
+    abortControllerForRequestMap: Map<number, AbortController>;
+    constructor(viewer: Viewer);
+    isSupport(file: any): boolean;
+    load(model: any, format?: string): Promise<this>;
+    cancel(): void;
+}

package/lib/Viewer/Loaders/VSFXStreamingLoader.d.ts

@@ -0,0 +1,8 @@
+import { Loader } from "@inweb/viewer-core";
+import { Viewer } from "../Viewer";
+export declare class VSFXStreamingLoader extends Loader {
+    viewer: Viewer;
+    constructor(viewer: Viewer);
+    isSupport(file: any): boolean;
+    load(model: any): Promise<this>;
+}

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

@@ -0,0 +1,67 @@
+import { ILoadersRegistry } from "@inweb/viewer-core";
+/**
+ * Viewer loaders registry. Use this registry to register custom loaders.
+ *
+ * To implement custom loader:
+ *
+ * 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.
+ *
+ *    The loader should do:
+ *
+ *    - Load model data from file. The model data must be a `VSFX` data buffer of `VSFX` data chunk.
+ *    - Parse model data with the `VisualizeJS` viewer instance.
+ *    - Synchronize viewer styles, options and overlay.
+ *    - Update the viewer.
+ *
+ *    The loader must emit events:
+ *
+ *    - `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.
+ * 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-visualize";
+ *
+ * class MyLoader extends Loader {
+ *   public viewer: Viewer;
+ *
+ *   constructor(viewer: Viewer) {
+ *     super();
+ *     this.viewer = viewer;
+ *   }
+ *
+ *   override isSupport(file, format): Boolean {
+ *     // place custom logic here
+ *     return ...;
+ *   }
+ *
+ *   override load(file, format, params): Promise<this> {
+ *
+ *     // place custom loading logic here
+ *     const data = ...
+ *
+ *     this.viewer.visualizeJs.getViewer().parseVsfx(data);
+ *
+ *     this.viewer.syncOpenCloudVisualStyle(false);
+ *     this.viewer.syncOptions();
+ *     this.viewer.syncOverlay();
+ *     this.viewer.resize();
+ *
+ *     this.viewer.emitEvent({ type: "databasechunk", data: model, file });
+ *
+ *     return Promise.resove(this);
+ *   };
+ * }
+ *
+ * loaders.registerLoader("MyLoader", (viewer) => new MyLoader(viewer));
+ * ```
+ */
+export declare const loaders: ILoadersRegistry;

package/lib/Viewer/Viewer.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter2 } from "@inweb/eventemitter2";
 import { Assembly, Client, File, Model } from "@inweb/client";
-import { CanvasEventMap, Dragger, IComponent, IDragger, IOptions, IViewer, IViewpoint, Options, OptionsEventMap, ViewerEventMap } from "@inweb/viewer-core";
+import { CanvasEventMap, Dragger, FileSource, IComponent, IDragger, ILoader, IOptions, IViewer, IViewpoint, Options, OptionsEventMap, ViewerEventMap } from "@inweb/viewer-core";
 import { IMarkup, IWorldTransform } from "@inweb/markup";
 import { MarkupType } from "./Markup/MarkupFactory";
 /**
@@ -23,10 +23,9 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
     canvasEvents: string[];
     private _markup;
     canvas: HTMLCanvasElement | undefined;
-    _abortController: AbortController | undefined;
-    _abortControllerForRequestMap: Map<string, AbortController> | undefined;
     _abortControllerForReferences: AbortController | undefined;
     client: Client | undefined;
+    loaders: Array<ILoader>;
     /**
      * @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
@@ -200,63 +199,12 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & CanvasEventMa
     loadReferences(model: Model | File | Assembly): Promise<this>;
     applyModelTransformMatrix(model: Model | Assembly): void;
     applySceneGraphSettings(options?: IOptions): void;
+    open(file: FileSource, params?: {
+        format?: string;
+        mode?: string;
+    }): Promise<this>;
     /**
-     * Loads a file from Open Cloud Server into the 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).
-     *
-     * 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.
-     *
-     * Fires:
-     *
-     * - {@link OpenEvent | open}
-     * - {@link GeometryStartEvent | geometrystart}
-     * - {@link GeometryProgressEvent | geometryprogress}
-     * - {@link DatabaseChunkEvent | databasechunk}
-     * - {@link GeometryChunkEvent | geometrychunk}
-     * - {@link GeometryEndEvent | geometryend}
-     * - {@link GeometryErrorEvent | geometryerror}
-     *
-     * @example Using partial streaming mode to open a large file from a server.
-     *
-     * ```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.
-     */
-    open(file: File | Assembly | Model): Promise<this>;
-    /**
-     * Loads a `VSF` file into the 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.
-     *
-     * Fires:
-     *
-     * - {@link OpenEvent | open}
-     * - {@link GeometryStartEvent | geometrystart}
-     * - {@link GeometryProgressEvent | geometryprogress}
-     * - {@link DatabaseChunkEvent | databasechunk}
-     * - {@link GeometryEndEvent | geometryend}
-     * - {@link GeometryErrorEvent | geometryerror}
-     *
-     * @param buffer - Binary data buffer to load.
+     * Deprecated since `26.4`. Use {@link open | open()} instead.
      */
     openVsfFile(buffer: Uint8Array | ArrayBuffer): this;
     /**

package/lib/index.d.ts

@@ -1,8 +1,9 @@
-export * from "@inweb/viewer-core";
-export * from "@inweb/markup";
 export { draggers } from "./Viewer/Draggers";
 export { commands } from "./Viewer/Commands";
 export { components } from "./Viewer/Components";
+export { loaders } from "./Viewer/Loaders";
 export { Viewer } from "./Viewer/Viewer";
 export { OdBaseDragger } from "./Viewer/Draggers/Common/OdBaseDragger";
 export { MarkupType } from "./Viewer/Markup/MarkupFactory";
+export * from "@inweb/viewer-core";
+export * from "@inweb/markup";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/viewer-visualize",
-  "version": "26.5.0",
+  "version": "26.5.2",
   "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",
@@ -29,10 +29,10 @@
     "docs": "typedoc"
   },
   "dependencies": {
-    "@inweb/client": "~26.5.0",
-    "@inweb/eventemitter2": "~26.5.0",
-    "@inweb/markup": "~26.5.0",
-    "@inweb/viewer-core": "~26.5.0"
+    "@inweb/client": "~26.5.2",
+    "@inweb/eventemitter2": "~26.5.2",
+    "@inweb/markup": "~26.5.2",
+    "@inweb/viewer-core": "~26.5.2"
   },
   "visualizeJS": "https://public-fhemb7e3embacwec.z02.azurefd.net/libs/visualizejs/master/Visualize.js"
 }

package/src/Viewer/Loaders/{BaseLoader.ts → UpdateController.ts}

@@ -21,20 +21,40 @@
 // acknowledge and accept the above terms.
 ///////////////////////////////////////////////////////////////////////////////
 
-import { Model } from "@inweb/client";
-import { IOptions } from "@inweb/viewer-core";
 import { Viewer } from "../Viewer";
 
-export class BaseLoader {
-  protected viewer: Viewer;
-  protected model: Model;
-  protected options: IOptions;
+const DELAY_TIME_MULTIPLEXER = 2.0;
+const START_UPDATE_TIME = 1000;
 
-  constructor(viewer: Viewer, model: Model, options: IOptions) {
+export enum UpdateType {
+  kDelay,
+  kNormal,
+  kForce,
+}
+
+export class UpdateController {
+  private lastUpdate: number;
+  private viewer: Viewer;
+  public delayUpdateTime: number;
+
+  constructor() {
+    this.lastUpdate = 0;
+    this.delayUpdateTime = START_UPDATE_TIME;
+  }
+
+  initialize(viewer: Viewer) {
     this.viewer = viewer;
-    this.model = model;
-    this.options = options;
+    this.lastUpdate = performance.now();
   }
 
-  async load(): Promise<void> {}
+  update(type: UpdateType) {
+    const isNeedUpdate = type !== UpdateType.kDelay || performance.now() - this.lastUpdate >= this.delayUpdateTime;
+    const isForce = type === UpdateType.kForce;
+
+    if (isNeedUpdate) {
+      this.viewer.update(isForce);
+      this.lastUpdate = performance.now();
+      this.delayUpdateTime *= DELAY_TIME_MULTIPLEXER;
+    }
+  }
 }

package/src/Viewer/Loaders/{LoaderFactory.ts → VSFBufferLoader.ts}

@@ -21,29 +21,38 @@
 // acknowledge and accept the above terms.
 ///////////////////////////////////////////////////////////////////////////////
 
-import { Model } from "@inweb/client";
-import { IOptions } from "@inweb/viewer-core";
-
-import { TCSLoader } from "./TCSLoader";
-import { VsfXLoader } from "./VsfXLoader";
-import { VsfXStreamingLoader } from "./VsfXStreamingLoader";
-import { VsfXPartialLoader } from "./VsfXPartialLoader";
+import { Loader } from "@inweb/viewer-core";
 import { Viewer } from "../Viewer";
 
-export class LoaderFactory {
-  create(viewer: Viewer, model: Model, options: IOptions) {
-    const geometryType = model.database.split(".").pop();
+export class VSFBufferLoader extends Loader {
+  public viewer: Viewer;
+
+  constructor(viewer: Viewer) {
+    super();
+    this.viewer = viewer;
+  }
+
+  override isSupport(file: any, format?: string): boolean {
+    return file instanceof ArrayBuffer && /vsf$/i.test(format);
+  }
+
+  override load(buffer: any, format?: string): Promise<this> {
+    if (!this.viewer.visualizeJs) return Promise.resolve(this);
+
+    const visLib = this.viewer.visLib();
+    const visViewer = visLib.getViewer();
+
+    const data = new Uint8Array(buffer);
+    visViewer.parseFile(data);
 
-    if (model.geometry.length === 0 && geometryType === "vsfx") {
-      if (!options.enableStreamingMode) return new VsfXLoader(viewer, model, options);
-      else if (options.enablePartialMode) return new VsfXPartialLoader(viewer, model, options);
-      else return new VsfXStreamingLoader(viewer, model, options);
-    }
+    this.viewer.syncOpenCloudVisualStyle(false);
+    this.viewer.syncOptions();
+    this.viewer.syncOverlay();
+    this.viewer.resize();
 
-    if (geometryType === "data") {
-      return new TCSLoader(viewer, model, options);
-    }
+    this.viewer.emitEvent({ type: "geometryprogress", data: 1, file: buffer });
+    this.viewer.emitEvent({ type: "databasechunk", data, file: buffer });
 
-    throw new Error(`Unknown geometry type: ${geometryType}`);
+    return Promise.resolve(this);
   }
 }

package/src/Viewer/Loaders/VSFModelLoader.ts

@@ -0,0 +1,87 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance").
+// All rights reserved.
+//
+// This software and its documentation and related materials are owned by
+// the Alliance. The software may only be incorporated into application
+// programs owned by members of the Alliance, subject to a signed
+// Membership Agreement and Supplemental Software License Agreement with the
+// Alliance. The structure and organization of this software are the valuable
+// trade secrets of the Alliance and its suppliers. The software is also
+// protected by copyright law and international treaty provisions. Application
+// programs incorporating this software must include the following statement
+// with their copyright notices:
+//
+//   This application incorporates Open Design Alliance software pursuant to a
+//   license agreement with Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance.
+//   All rights reserved.
+//
+// By use of this software, its documentation or related materials, you
+// acknowledge and accept the above terms.
+///////////////////////////////////////////////////////////////////////////////
+
+import { Loader } from "@inweb/viewer-core";
+import { Viewer } from "../Viewer";
+
+export class VSFModelLoader extends Loader {
+  public viewer: Viewer;
+
+  constructor(viewer: Viewer) {
+    super();
+    this.viewer = viewer;
+  }
+
+  override isSupport(file: any, format?: string): boolean {
+    return (
+      typeof file === "object" &&
+      typeof file.database === "string" &&
+      typeof file.downloadResource === "function" &&
+      /.data$/i.test(file.database)
+    );
+  }
+
+  override async load(model: any, format?: string): Promise<this> {
+    if (!this.viewer.visualizeJs) return this;
+
+    const visLib = this.viewer.visLib();
+    const visViewer = visLib.getViewer();
+
+    const filesToDownload = [model.database, ...model.geometry];
+
+    console.time("File load time");
+
+    for (let i = 0; i < filesToDownload.length; i++) {
+      const dataId = filesToDownload[i];
+
+      const progress = (progress: number) => {
+        const data = (i + progress) / filesToDownload.length;
+        this.viewer.emitEvent({ type: "geometryprogress", data, file: model.file, model });
+      };
+
+      const arrayBuffer = await model.downloadResource(dataId, progress, this.abortController.signal);
+      if (!this.viewer.visualizeJs) return this;
+
+      const data = new Uint8Array(arrayBuffer);
+      visViewer.parseStream(data);
+
+      if (i === 0) {
+        this.viewer.update(true);
+
+        this.viewer.syncOpenCloudVisualStyle(false);
+        this.viewer.syncOptions();
+        this.viewer.syncOverlay();
+        this.viewer.resize();
+
+        this.viewer.emitEvent({ type: "databasechunk", data, file: model.file, model });
+      } else {
+        this.viewer.update();
+        this.viewer.emitEvent({ type: "geometrychunk", data, file: model.file, model });
+      }
+    }
+
+    console.timeEnd("File load time");
+
+    return this;
+  }
+}

package/src/Viewer/Loaders/VSFXBufferLoader.ts

@@ -0,0 +1,58 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance").
+// All rights reserved.
+//
+// This software and its documentation and related materials are owned by
+// the Alliance. The software may only be incorporated into application
+// programs owned by members of the Alliance, subject to a signed
+// Membership Agreement and Supplemental Software License Agreement with the
+// Alliance. The structure and organization of this software are the valuable
+// trade secrets of the Alliance and its suppliers. The software is also
+// protected by copyright law and international treaty provisions. Application
+// programs incorporating this software must include the following statement
+// with their copyright notices:
+//
+//   This application incorporates Open Design Alliance software pursuant to a
+//   license agreement with Open Design Alliance.
+//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance.
+//   All rights reserved.
+//
+// By use of this software, its documentation or related materials, you
+// acknowledge and accept the above terms.
+///////////////////////////////////////////////////////////////////////////////
+
+import { Loader } from "@inweb/viewer-core";
+import { Viewer } from "../Viewer";
+
+export class VSFXBufferLoader extends Loader {
+  public viewer: Viewer;
+
+  constructor(viewer: Viewer) {
+    super();
+    this.viewer = viewer;
+  }
+
+  override isSupport(file: any, format?: string): boolean {
+    return file instanceof ArrayBuffer && /vsfx$/i.test(format);
+  }
+
+  override load(buffer: any, format?: string): Promise<this> {
+    if (!this.viewer.visualizeJs) return Promise.resolve(this);
+
+    const visLib = this.viewer.visLib();
+    const visViewer = visLib.getViewer();
+
+    const data = new Uint8Array(buffer);
+    visViewer.parseVsfx(data);
+
+    this.viewer.syncOpenCloudVisualStyle(false);
+    this.viewer.syncOptions();
+    this.viewer.syncOverlay();
+    this.viewer.resize();
+
+    this.viewer.emitEvent({ type: "geometryprogress", data: 1, file: buffer });
+    this.viewer.emitEvent({ type: "databasechunk", data, file: buffer });
+
+    return Promise.resolve(this);
+  }
+}

package/src/Viewer/Loaders/{VsfXLoader.ts → VSFXModelLoader.ts}

@@ -21,54 +21,54 @@
 // acknowledge and accept the above terms.
 ///////////////////////////////////////////////////////////////////////////////
 
-import { BaseLoader } from "./BaseLoader";
+import { Loader } from "@inweb/viewer-core";
+import { Viewer } from "../Viewer";
 
-export class VsfXLoader extends BaseLoader {
-  override async load(): Promise<void> {
-    if (!this.viewer.visualizeJs) return;
+export class VSFXModelLoader extends Loader {
+  public viewer: Viewer;
+
+  constructor(viewer: Viewer) {
+    super();
+    this.viewer = viewer;
+  }
+
+  override isSupport(file: any): boolean {
+    return (
+      typeof file === "object" &&
+      typeof file.database === "string" &&
+      typeof file.downloadResource === "function" &&
+      /.vsfx$/i.test(file.database) &&
+      this.viewer.options.enableStreamingMode === false
+    );
+  }
+
+  override async load(model: any, format?: string, params: any = {}): Promise<this> {
+    if (!this.viewer.visualizeJs) return Promise.resolve(this);
 
     const visLib = this.viewer.visLib();
     const visViewer = visLib.getViewer();
-    const abortController = new AbortController();
-
-    this.viewer._abortController = abortController;
 
-    const chunkLoadHandler = (progress: number) => {
-      this.viewer.emitEvent({ type: "geometryprogress", data: progress, model: this.model });
+    const progress = (progress: number) => {
+      this.viewer.emitEvent({ type: "geometryprogress", data: progress, file: model.file, model });
     };
 
     console.time("File load time");
-    try {
-      this.viewer.emitEvent({ type: "geometrystart", model: this.model });
-
-      const arrayBuffer = await this.model.downloadResource(
-        this.model.database,
-        chunkLoadHandler,
-        abortController.signal
-      );
 
-      if (abortController.signal.aborted) {
-        await Promise.reject(new Error(`Open model aborted ${this.model.name}`));
-      }
+    const arrayBuffer = await model.downloadResource(model.database, progress, this.abortController.signal);
+    if (!this.viewer.visualizeJs) return this;
 
-      const data = new Uint8Array(arrayBuffer);
+    const data = new Uint8Array(arrayBuffer);
+    visViewer.parseVsfx(data);
 
-      if (this.viewer.visualizeJs) {
-        visViewer.parseVsfx(data);
+    this.viewer.syncOpenCloudVisualStyle(false);
+    this.viewer.syncOptions();
+    this.viewer.syncOverlay();
+    this.viewer.resize();
 
-        this.viewer.syncOpenCloudVisualStyle(false);
-        this.viewer.syncOptions();
-        this.viewer.syncOverlay();
-        this.viewer.resize();
-      }
+    this.viewer.emitEvent({ type: "databasechunk", data, file: model.file, model });
 
-      console.timeEnd("File load time");
+    console.timeEnd("File load time");
 
-      this.viewer.emitEvent({ type: "databasechunk", data, model: this.model });
-      this.viewer.emitEvent({ type: "geometryend", model: this.model });
-    } catch (error: any) {
-      this.viewer.emitEvent({ type: "geometryerror", data: error, model: this.model });
-      throw error;
-    }
+    return this;
   }
 }