@inweb/client 25.2.5 → 25.2.8

package/lib/Viewer/IViewer.d.ts

@@ -19,6 +19,8 @@ export interface IViewer extends IEventEmitter, ICommandService {
     setActiveDragger(name: string): any;
     resetActiveDragger(): void;
     is3D(): boolean;
+    drawViewpoint(viewpoint: object): void;
+    createViewpoint(): object;
     loadReferences(model: Model | File | Assembly): Promise<this>;
     open(model: Model | File | Assembly): Promise<this>;
     cancel(): this;

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

@@ -1,10 +1,11 @@
 import { TCSLoader } from "./TCSLoader";
-import { VsfXLoader } from "./VsfXLoader";
+import { VsfXStreamingLoader } from "./VsfXStreamingLoader";
 import { VsfXPartialLoader } from "./VsfXPartialLoader";
 import { Viewer } from "../Viewer";
 import { Model } from "../../Api/Model";
 import { OptionsData } from "../Options";
+import { VsfXLoader } from "./VsfXLoader";
 export declare class LoaderFactory {
-    create(viewer: Viewer, model: Model, options: OptionsData): TCSLoader | VsfXLoader | VsfXPartialLoader;
+    create(viewer: Viewer, model: Model, options: OptionsData): TCSLoader | VsfXStreamingLoader | VsfXPartialLoader | VsfXLoader;
 }
 //# sourceMappingURL=LoaderFactory.d.ts.map

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

@@ -0,0 +1,5 @@
+import { BaseLoader } from "./BaseLoader";
+export declare class VsfXStreamingLoader extends BaseLoader {
+    load(): Promise<void>;
+}
+//# sourceMappingURL=VsfXStreamingLoader.d.ts.map

package/lib/Viewer/Markup/IMarkup.d.ts

@@ -21,15 +21,15 @@ export interface IMarkup {
     dispose(): void;
     getDraggers(): Map<string, typeof OdBaseDragger>;
     clearOverlay(): void;
+    setMarkupColor(r: number, g: number, b: number): void;
     getMarkupColor(): {
         r: number;
         g: number;
         b: number;
     };
-    setMarkupColor(r: number, g: number, b: number): void;
     colorizeAllMarkup(r: number, g: number, b: number): void;
-    drawViewpoint(viewpoint: any): void;
-    createViewpoint(): object;
+    setViewpoint(viewpoint: object): void;
+    getViewpoint(): any;
     createObject(type: string, params: any): IMarkupObject;
     getObjects(): IMarkupObject[];
     getSelectedObjects(): IMarkupObject[];

package/lib/Viewer/Markup/Impl/Konva/KonvaMarkup.d.ts

@@ -37,8 +37,8 @@ export declare class KonvaMarkup implements IMarkup {
     };
     setMarkupColor(r: number, g: number, b: number): void;
     colorizeAllMarkup(r?: number, g?: number, b?: number): void;
-    drawViewpoint(viewpoint: any): void;
-    createViewpoint(): object;
+    setViewpoint(viewpoint: any): void;
+    getViewpoint(): object;
     createObject(type: string, params: any): IMarkupObject;
     getObjects(): IMarkupObject[];
     getSelectedObjects(): IMarkupObject[];

package/lib/Viewer/Markup/Impl/Visualize/VisualizeMarkup.d.ts

@@ -21,13 +21,14 @@ export declare class VisualizeMarkup implements IMarkup {
     };
     setMarkupColor(r: number, g: number, b: number): void;
     colorizeAllMarkup(r?: number, g?: number, b?: number): void;
-    drawViewpoint(viewpoint: any): void;
-    createViewpoint(): object;
+    setViewpoint(viewpoint: any): void;
+    getViewpoint(): object;
     getLayer(): any;
     createObject(type: string, params: any): IMarkupObject;
     getObjects(): IMarkupObject[];
     getSelectedObjects(): IMarkupObject[];
     selectObjects(objects: IMarkupObject[]): void;
     clearSelected(): void;
+    private getPoint3dFromArray;
 }
 //# sourceMappingURL=VisualizeMarkup.d.ts.map

package/lib/Viewer/Options.d.ts

@@ -56,6 +56,15 @@ export interface OptionsData {
      * @defaultValue false
      */
     ambientOcclusion?: boolean;
+    /**
+     * Enable streaming mode
+     *
+     * If enableStreamingMode is true then enablePartialMode will be used, otherwise -
+     * enablePartialMode will be ignored and file / assembly will be loaded in one go
+     *
+     * @defaultValue true
+     */
+    enableStreamingMode?: boolean;
     /**
      * Enable partial load mode to be able open large drawing If enablePartialMode enabled, then
      * sceneGraph will be switched off
@@ -176,6 +185,8 @@ export declare class Options {
     set cameraAxisYSpeed(value: number);
     get ambientOcclusion(): boolean;
     set ambientOcclusion(value: boolean);
+    get enableStreamingMode(): boolean;
+    set enableStreamingMode(value: boolean);
     get enablePartialMode(): boolean;
     set enablePartialMode(value: boolean);
     get memoryLimit(): number;

package/lib/Viewer/Viewer.d.ts

@@ -334,13 +334,19 @@ export declare class Viewer extends EventEmitter2<ViewerEventMap & OptionsEventM
      *
      * @param viewpoint - Viewpoint.
      */
-    drawViewpoint(viewpoint: any): void;
+    drawViewpoint(viewpoint: object): void;
     /**
      * 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()}.
      */
     createViewpoint(): object;
+    private getPoint3dFromArray;
+    private getLogicalPoint3dAsArray;
+    private getOrthogonalCameraSettings;
+    private setOrthogonalCameraSettings;
+    private getClippingPlanes;
+    private setClippingPlanes;
     /**
      * Executes the command denoted by the given command identifier.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@inweb/client",
-  "version": "25.2.5",
+  "version": "25.2.8",
   "description": "Client.js is a library for implementing BIM Project management applications.",
   "homepage": "https://cloud.opendesign.com/docs/index.html",
   "license": "SEE LICENSE IN LICENSE",

package/src/Viewer/IViewer.ts

@@ -48,6 +48,9 @@ export interface IViewer extends IEventEmitter, ICommandService {
 
   is3D(): boolean;
 
+  drawViewpoint(viewpoint: object): void;
+  createViewpoint(): object;
+
   loadReferences(model: Model | File | Assembly): Promise<this>;
   open(model: Model | File | Assembly): Promise<this>;
   cancel(): this;

package/src/Viewer/Loaders/LoaderFactory.ts

@@ -22,20 +22,23 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { TCSLoader } from "./TCSLoader";
-import { VsfXLoader } from "./VsfXLoader";
+import { VsfXStreamingLoader } from "./VsfXStreamingLoader";
 import { VsfXPartialLoader } from "./VsfXPartialLoader";
 import { Viewer } from "../Viewer";
 import { Model } from "../../Api/Model";
 import { OptionsData } from "../Options";
+import { VsfXLoader } from "./VsfXLoader";
 
 export class LoaderFactory {
   create(viewer: Viewer, model: Model, options: OptionsData) {
     const geometryType = model.database.split(".").pop();
+
     if (model.geometry.length === 0 && geometryType === "vsfx") {
-      return options.enablePartialMode
-        ? new VsfXPartialLoader(viewer, model, options)
-        : new VsfXLoader(viewer, model, options);
+      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);
     }
+
     if (geometryType === "data") {
       return new TCSLoader(viewer, model, options);
     }

package/src/Viewer/Loaders/VsfXLoader.ts

@@ -22,7 +22,6 @@
 ///////////////////////////////////////////////////////////////////////////////
 
 import { BaseLoader } from "./BaseLoader";
-import { UpdaterController, UpdateType } from "./UpdaterController";
 
 export class VsfXLoader extends BaseLoader {
   override async load(): Promise<void> {
@@ -32,52 +31,31 @@ export class VsfXLoader extends BaseLoader {
     const visViewer = visLib.getViewer();
     const abortController = new AbortController();
 
-    const updaterController = new UpdaterController();
-    updaterController.initialize(this.viewer);
-
     this.viewer._abortController = abortController;
 
-    let isFireDatabaseChunk = false;
-
-    const chunkLoadHandler = (progress, data) => {
-      if (!this.viewer.visualizeJs) return;
-
-      const status = visViewer.parseVsfx(data);
-      updaterController.update(UpdateType.kDelay);
+    console.time("File load time");
+    try {
+      this.viewer.emitEvent({ type: "geometrystart", model: this.model });
 
-      this.viewer.emitEvent({ type: "geometryprogress", data: progress, model: this.model });
+      const progressCb = (progress) =>
+        this.viewer.emitEvent({ type: "geometryprogress", data: progress, model: this.model });
+      const arrayBuffer = await this.model.downloadResource(this.model.database, progressCb, abortController.signal);
 
-      let state = false;
-      if (
-        status === visLib.DatabaseStreamStatus.ReadyServiceData ||
-        (status === visLib.DatabaseStreamStatus.Complete && !isFireDatabaseChunk)
-      ) {
-        isFireDatabaseChunk = true;
-        state = true;
+      if (abortController.signal.aborted) {
+        await Promise.reject(new Error(`Open model aborted ${this.model.name}`));
       }
 
-      if (state) {
-        updaterController.update(UpdateType.kForce);
+      if (this.viewer.visualizeJs) {
+        visViewer.parseVsfx(new Uint8Array(arrayBuffer));
+        this.viewer.update(true);
 
         this.viewer.syncOpenCloudVisualStyle(false);
         this.viewer.syncOptions();
         this.viewer.resize();
-
-        this.viewer.emitEvent({ type: "databasechunk", data, model: this.model });
-      } else {
-        this.viewer.emitEvent({ type: "geometrychunk", data, model: this.model });
       }
-    };
-
-    console.time("File load time");
-    try {
-      this.viewer.emitEvent({ type: "geometrystart", model: this.model });
 
-      await this.model.partialDownloadResource(this.model.database, chunkLoadHandler, abortController.signal);
       console.timeEnd("File load time");
 
-      updaterController.update(UpdateType.kNormal);
-
       this.viewer.emitEvent({ type: "geometryend", model: this.model });
     } catch (error) {
       this.viewer.emitEvent({ type: "geometryerror", data: error, model: this.model });

package/src/Viewer/Loaders/VsfXStreamingLoader.ts

@@ -0,0 +1,87 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2002-2021, 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-2021 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 { BaseLoader } from "./BaseLoader";
+import { UpdaterController, UpdateType } from "./UpdaterController";
+
+export class VsfXStreamingLoader extends BaseLoader {
+  override async load(): Promise<void> {
+    if (!this.viewer.visualizeJs) return;
+
+    const visLib = this.viewer.visLib();
+    const visViewer = visLib.getViewer();
+    const abortController = new AbortController();
+
+    const updaterController = new UpdaterController();
+    updaterController.initialize(this.viewer);
+
+    this.viewer._abortController = abortController;
+
+    let isFireDatabaseChunk = false;
+
+    const chunkLoadHandler = (progress, data) => {
+      if (!this.viewer.visualizeJs) return;
+
+      const status = visViewer.parseVsfx(data);
+      updaterController.update(UpdateType.kDelay);
+
+      this.viewer.emitEvent({ type: "geometryprogress", data: progress, model: this.model });
+
+      let state = false;
+      if (
+        status === visLib.DatabaseStreamStatus.ReadyServiceData ||
+        (status === visLib.DatabaseStreamStatus.Complete && !isFireDatabaseChunk)
+      ) {
+        isFireDatabaseChunk = true;
+        state = true;
+      }
+
+      if (state) {
+        updaterController.update(UpdateType.kForce);
+
+        this.viewer.syncOpenCloudVisualStyle(false);
+        this.viewer.syncOptions();
+        this.viewer.resize();
+
+        this.viewer.emitEvent({ type: "databasechunk", data, model: this.model });
+      } else {
+        this.viewer.emitEvent({ type: "geometrychunk", data, model: this.model });
+      }
+    };
+
+    console.time("File load time");
+    try {
+      this.viewer.emitEvent({ type: "geometrystart", model: this.model });
+
+      await this.model.partialDownloadResource(this.model.database, chunkLoadHandler, abortController.signal);
+      console.timeEnd("File load time");
+
+      updaterController.update(UpdateType.kNormal);
+
+      this.viewer.emitEvent({ type: "geometryend", model: this.model });
+    } catch (error) {
+      this.viewer.emitEvent({ type: "geometryerror", data: error, model: this.model });
+      throw error;
+    }
+  }
+}

package/src/Viewer/Markup/IMarkup.ts

@@ -26,11 +26,11 @@ export interface IMarkup {
 
   getDraggers(): Map<string, typeof OdBaseDragger>;
   clearOverlay(): void;
-  getMarkupColor(): { r: number; g: number; b: number };
   setMarkupColor(r: number, g: number, b: number): void;
+  getMarkupColor(): { r: number; g: number; b: number };
   colorizeAllMarkup(r: number, g: number, b: number): void;
-  drawViewpoint(viewpoint: any): void;
-  createViewpoint(): object;
+  setViewpoint(viewpoint: object): void;
+  getViewpoint(): any;
 
   createObject(type: string, params: any): IMarkupObject;
   getObjects(): IMarkupObject[];

package/src/Viewer/Markup/Impl/Konva/KonvaMarkup.ts

@@ -236,60 +236,16 @@ export class KonvaMarkup implements IMarkup {
     this._konvaLayer.draw();
   }
 
-  drawViewpoint(viewpoint: any): void {
-    function getLogicalPoint3dAsArray(point3d) {
-      return [point3d.x, point3d.y, point3d.z];
-    }
-
-    if (!this._isInitialized) return;
-    if (!this._viewer.visualizeJs) return;
-
-    const visLib = this._viewer.visLib();
-    const visViewer = visLib.getViewer();
-    const activeView = visViewer.activeView;
-
-    this._viewer.resetActiveDragger();
-    this._viewer.clearSlices();
-    this._viewer.clearOverlay();
-
-    if (viewpoint.orthogonal_camera) {
-      activeView.setView(
-        getLogicalPoint3dAsArray(viewpoint.orthogonal_camera.view_point),
-        getLogicalPoint3dAsArray(viewpoint.orthogonal_camera.direction),
-        getLogicalPoint3dAsArray(viewpoint.orthogonal_camera.up_vector),
-        viewpoint.orthogonal_camera.field_width,
-        viewpoint.orthogonal_camera.field_height,
-        true
-      );
-    }
-
-    this._viewer.syncOverlay();
-
+  setViewpoint(viewpoint: any): void {
     const markupColor = viewpoint.custom_fields.markup_color || { r: 255, g: 0, b: 0 };
     this.setMarkupColor(markupColor.r, markupColor.g, markupColor.b);
 
-    if (viewpoint.clipping_planes) {
-      for (const plane of viewpoint.clipping_planes) {
-        const cuttingPlane = new visLib.OdTvPlane();
-        cuttingPlane.set(getLogicalPoint3dAsArray(plane.location), getLogicalPoint3dAsArray(plane.direction));
-
-        activeView.addCuttingPlane(cuttingPlane);
-        activeView.setEnableCuttingPlaneFill(true, 0x66, 0x66, 0x66);
-      }
-    }
-
     this.loadMarkup(viewpoint);
-
-    this._viewer.update();
   }
 
-  createViewpoint(): object {
+  getViewpoint(): object {
     if (!this._viewer.visualizeJs) return {};
 
-    const visLib = this._viewer.visLib();
-    const visViewer = visLib.getViewer();
-    const activeView = visViewer.activeView;
-
     const viewpoint = {
       lines: [],
       texts: [],
@@ -298,28 +254,8 @@ export class KonvaMarkup implements IMarkup {
       ellipses: [],
       images: [],
       rectangles: [],
-      clipping_planes: [],
     } as any;
 
-    viewpoint.orthogonal_camera = {
-      view_point: this.getPoint3dFromArray(activeView.viewPosition),
-      direction: this.getPoint3dFromArray(activeView.viewTarget),
-      up_vector: this.getPoint3dFromArray(activeView.upVector),
-      field_width: activeView.viewFieldWidth,
-      field_height: activeView.viewFieldHeight,
-    };
-
-    for (let i = 0; i < activeView.numCuttingPlanes(); i++) {
-      const cuttingPlane = activeView.getCuttingPlane(i);
-
-      const plane = {
-        location: this.getPoint3dFromArray(cuttingPlane.getOrigin()),
-        direction: this.getPoint3dFromArray(cuttingPlane.normal()),
-      };
-
-      viewpoint.clipping_planes.push(plane);
-    }
-
     viewpoint.snapshot = {
       data: this.combineMarkupWithDrawing(),
     };

package/src/Viewer/Markup/Impl/Visualize/VisualizeMarkup.ts

@@ -66,7 +66,7 @@ export class VisualizeMarkup implements IMarkup {
     this._viewer.update();
   }
 
-  drawViewpoint(viewpoint: any): void {
+  setViewpoint(viewpoint: any): void {
     function getLogicalPoint3dAsArray(point3d) {
       return [point3d.x, point3d.y, point3d.z];
     }
@@ -81,21 +81,6 @@ export class VisualizeMarkup implements IMarkup {
     const visViewer = visLib.getViewer();
     const activeView = visViewer.activeView;
 
-    this._viewer.resetActiveDragger();
-    this._viewer.clearSlices();
-    this.clearOverlay();
-
-    if (viewpoint.orthogonal_camera) {
-      activeView.setView(
-        getLogicalPoint3dAsArray(viewpoint.orthogonal_camera.view_point),
-        getLogicalPoint3dAsArray(viewpoint.orthogonal_camera.direction),
-        getLogicalPoint3dAsArray(viewpoint.orthogonal_camera.up_vector),
-        viewpoint.orthogonal_camera.field_width,
-        viewpoint.orthogonal_camera.field_height,
-        true
-      );
-    }
-
     this._viewer.syncOverlay();
 
     const markupColor = viewpoint.custom_fields.markup_color || { r: 255, g: 0, b: 0 };
@@ -139,20 +124,10 @@ export class VisualizeMarkup implements IMarkup {
       }
     }
 
-    if (viewpoint.clipping_planes) {
-      for (const plane of viewpoint.clipping_planes) {
-        const cuttingPlane = new visLib.OdTvPlane();
-        cuttingPlane.set(getLogicalPoint3dAsArray(plane.location), getLogicalPoint3dAsArray(plane.direction));
-
-        activeView.addCuttingPlane(cuttingPlane);
-        activeView.setEnableCuttingPlaneFill(true, 0x66, 0x66, 0x66);
-      }
-    }
-
     this._viewer.update();
   }
 
-  createViewpoint(): object {
+  getViewpoint(): object {
     function getLogicalPoint3dFromArray(array) {
       return { x: array[0], y: array[1], z: array[2] };
     }
@@ -161,22 +136,12 @@ export class VisualizeMarkup implements IMarkup {
 
     const visLib = this._viewer.visLib();
     const visViewer = visLib.getViewer();
-    const activeView = visViewer.activeView;
 
     const viewpoint = {
       lines: [],
       texts: [],
-      clipping_planes: [],
     } as any;
 
-    viewpoint.orthogonal_camera = {
-      view_point: getLogicalPoint3dFromArray(activeView.viewPosition),
-      direction: getLogicalPoint3dFromArray(activeView.viewTarget),
-      up_vector: getLogicalPoint3dFromArray(activeView.upVector),
-      field_width: activeView.viewFieldWidth,
-      field_height: activeView.viewFieldHeight,
-    };
-
     const model = visViewer.getMarkupModel();
     const itr = model.getEntitiesIterator();
     for (; !itr.done(); itr.step()) {
@@ -224,17 +189,6 @@ export class VisualizeMarkup implements IMarkup {
     }
     itr.delete();
 
-    for (let i = 0; i < activeView.numCuttingPlanes(); i++) {
-      const cuttingPlane = activeView.getCuttingPlane(i);
-
-      const plane = {
-        location: getLogicalPoint3dFromArray(cuttingPlane.getOrigin()),
-        direction: getLogicalPoint3dFromArray(cuttingPlane.normal()),
-      };
-
-      viewpoint.clipping_planes.push(plane);
-    }
-
     viewpoint.snapshot = {
       data: visLib.canvas.toDataURL("image/jpeg", 0.25),
     };
@@ -270,4 +224,8 @@ export class VisualizeMarkup implements IMarkup {
   clearSelected(): void {
     throw new Error("Not implemented yet");
   }
+
+  private getPoint3dFromArray(array) {
+    return { x: array[0], y: array[1], z: array[2] };
+  }
 }

package/src/Viewer/Options.ts

@@ -89,6 +89,16 @@ export interface OptionsData {
    */
   ambientOcclusion?: boolean;
 
+  /**
+   * Enable streaming mode
+   *
+   * If enableStreamingMode is true then enablePartialMode will be used, otherwise -
+   * enablePartialMode will be ignored and file / assembly will be loaded in one go
+   *
+   * @defaultValue true
+   */
+  enableStreamingMode?: boolean;
+
   /**
    * Enable partial load mode to be able open large drawing If enablePartialMode enabled, then
    * sceneGraph will be switched off
@@ -205,6 +215,7 @@ export class Options {
       cameraAxisXSpeed: 4,
       cameraAxisYSpeed: 1,
       ambientOcclusion: false,
+      enableStreamingMode: true,
       enablePartialMode: false,
       memoryLimit: 3294967296,
       cuttingPlaneFillColor: { red: 0xff, green: 0x98, blue: 0x00 },
@@ -354,6 +365,15 @@ export class Options {
     this.notifierChangeEvent();
   }
 
+  get enableStreamingMode(): boolean {
+    return this._data.enableStreamingMode;
+  }
+
+  set enableStreamingMode(value: boolean) {
+    this._data.enableStreamingMode = value;
+    this.notifierChangeEvent();
+  }
+
   get enablePartialMode(): boolean {
     return this._data.enablePartialMode;
   }