@inweb/viewer-visualize 26.10.6 → 26.11.1

package/src/Viewer/Commands/SetSelected2.ts

@@ -0,0 +1,39 @@
+///////////////////////////////////////////////////////////////////////////////
+// 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 { Viewer } from "../Viewer";
+
+export function setSelected2(viewer: Viewer, handles2: string[] = []): void {
+  const handles = [];
+
+  handles2.forEach((handle) => {
+    if (!handle.includes(":")) {
+      handles.push(handle);
+    } else
+      viewer.models.forEach((model) => {
+        if (handle.split(":", 1)[0] === model.id + "") handles.push(handle);
+      });
+  });
+
+  return viewer.executeCommand("setSelected", handles);
+}

package/src/Viewer/Commands/index.ts

@@ -32,6 +32,7 @@ import { explode, collect } from "./Explode";
 import { getDefaultViewPositions } from "./GetDefaultViewPositions";
 import { getModels } from "./GetModels";
 import { getSelected } from "./GetSelected";
+import { getSelected2 } from "./GetSelected2";
 import { hideSelected } from "./HideSelected";
 import { isolateSelected } from "./IsolateSelected";
 import { regenerateAll } from "./RegenerateAll";
@@ -41,6 +42,7 @@ import { setActiveDragger } from "./SetActiveDragger";
 import { setDefaultViewPosition } from "./SetDefaultViewPosition";
 import { setMarkupColor } from "./SetMarkupColor";
 import { setSelected } from "./SetSelected";
+import { setSelected2 } from "./SetSelected2";
 import { showAll } from "./ShowAll";
 import { zoomToExtents } from "./ZoomToExtents";
 import { zoomToObjects } from "./ZoomToObjects";
@@ -87,6 +89,7 @@ commands.registerCommand("collect", collect);
 commands.registerCommand("getDefaultViewPositions", getDefaultViewPositions);
 commands.registerCommand("getModels", getModels);
 commands.registerCommand("getSelected", getSelected);
+commands.registerCommand("getSelected2", getSelected2);
 commands.registerCommand("hideSelected", hideSelected);
 commands.registerCommand("isolateSelected", isolateSelected);
 commands.registerCommand("regenerateAll", regenerateAll);
@@ -96,6 +99,7 @@ commands.registerCommand("setActiveDragger", setActiveDragger);
 commands.registerCommand("setDefaultViewPosition", setDefaultViewPosition);
 commands.registerCommand("setMarkupColor", setMarkupColor);
 commands.registerCommand("setSelected", setSelected);
+commands.registerCommand("setSelected2", setSelected2);
 commands.registerCommand("showAll", showAll);
 commands.registerCommand("zoomToExtents", zoomToExtents);
 commands.registerCommand("zoomToObjects", zoomToObjects);

package/src/Viewer/Components/index.ts

@@ -37,8 +37,8 @@ import { ResetComponent } from "./ResetComponent";
  *
  * 1. Define a component class implements {@link IComponent}.
  * 2. Define a constructor with a `viewer` parameter and add mouse event listeners for the specified viewer.
- * 3. Define the component logic in the event listeners. For example, listen for the `mousedown` event and
- *    select objects when the left mouse button is pressed.
+ * 3. Define the component logic in the event listeners. For example, listen for the `geometryend` event and
+ *    implement post-processing logic for the model.
  * 4. Override {@link IComponent.dispose} and remove mouse event listeners from the viewer.
  * 5. Register component provider in the components registry by calling the
  *    {@link components.registerComponent}.
@@ -51,18 +51,19 @@ import { ResetComponent } from "./ResetComponent";
  * class MyComponent implements IComponent {
  *   protected viewer: Viewer;
  *
- *   constructor(viewer: Viewer) {
+ *  constructor(viewer: Viewer) {
  *     this.viewer = viewer;
- *     this.viewer.addEventListener("mousedown", this.onMouseDown);
+ *     this.viewer.addEventListener("geometryend", this.onGeometryEnd);
  *   }
  *
  *   override dispose() {
- *     this.viewer.removeEventListener("mousedown", this.onMouseDown);
+ *     this.viewer.removeEventListener("geometryend", this.onGeometryEnd);
  *   }
  *
- *   onMouseDown = (event: PointerEvent) => {
- *     // place custom logic here
+ *   onGeometryEnd = (event: MouseEvent) => {
+ *     this.viewer.executeCommand("zoomToExtents");
  *   };
+ *
  * }
  *
  * components.registerComponent( "MyComponent", (viewer): IComponent => new MyComponent(viewer));

package/src/Viewer/Draggers/Common/OdBaseDragger.ts

@@ -135,8 +135,9 @@ export class OdBaseDragger extends OdaGeAction {
       this.subject.update();
 
       const selectionSet = viewer.getSelected();
-      const handles = this.subject.getSelected();
-      this.onmessage({ type: "select", data: selectionSet, handles });
+
+      this.onmessage({ type: "select", data: selectionSet, handles: this.subject.getSelected() });
+      this.onmessage({ type: "select2", data: selectionSet, handles: this.subject.getSelected2() });
     }
   }
 

package/src/Viewer/Draggers/OdJoyStickDragger.ts

@@ -100,7 +100,7 @@ export class OdJoyStickDragger {
         callback({
           x: 100 * ((movedX - centerX) / maxMoveStick),
           y: 100 * ((movedY - centerY) / maxMoveStick) * -1,
-          global: global,
+          global,
         });
       }
     };
@@ -116,7 +116,7 @@ export class OdJoyStickDragger {
       callback({
         x: 100 * ((movedX - centerX) / maxMoveStick),
         y: 100 * ((movedY - centerY) / maxMoveStick) * -1,
-        global: global,
+        global,
       });
     };
 

package/src/Viewer/Loaders/VSFCloudLoader.ts

@@ -23,6 +23,7 @@
 
 import { Loader } from "@inweb/viewer-core";
 import { Viewer } from "../Viewer";
+import { ModelImpl } from "../Models/ModelImpl";
 
 export class VSFCloudLoader extends Loader {
   public viewer: Viewer;
@@ -70,6 +71,11 @@ export class VSFCloudLoader extends Loader {
       }
 
       if (i === 0) {
+        const modelImpl = new ModelImpl();
+        modelImpl.id = model.file.id;
+
+        this.viewer.models.push(modelImpl);
+
         this.viewer.syncOptions();
         this.viewer.syncOverlay();
         this.viewer.update(true);

package/src/Viewer/Loaders/VSFFileLoader.ts

@@ -23,6 +23,7 @@
 
 import { Loader, LoadParams } from "@inweb/viewer-core";
 import { Viewer } from "../Viewer";
+import { ModelImpl } from "../Models/ModelImpl";
 import { FileLoader } from "./FileLoader";
 
 export class VSFFileLoader extends Loader {
@@ -40,7 +41,7 @@ export class VSFFileLoader extends Loader {
     );
   }
 
-  override async load(file: any, format?: string, params?: LoadParams): Promise<this> {
+  override async load(file: any, format?: string, params: LoadParams = {}): Promise<this> {
     if (!this.viewer.visualizeJs) return this;
 
     const visViewer = this.viewer.visViewer();
@@ -68,6 +69,11 @@ export class VSFFileLoader extends Loader {
       throw error;
     }
 
+    const modelImpl = new ModelImpl();
+    modelImpl.id = params.modelId || this.extractFileName(file);
+
+    this.viewer.models.push(modelImpl);
+
     this.viewer.syncOptions();
     this.viewer.syncOverlay();
     this.viewer.update(true);

package/src/Viewer/Loaders/VSFXCloudLoader.ts

@@ -23,6 +23,7 @@
 
 import { Loader } from "@inweb/viewer-core";
 import { Viewer } from "../Viewer";
+import { ModelImpl } from "../Models/ModelImpl";
 
 export class VSFXCloudLoader extends Loader {
   public viewer: Viewer;
@@ -42,7 +43,7 @@ export class VSFXCloudLoader extends Loader {
     );
   }
 
-  override async load(model: any, format?: string, params: any = {}): Promise<this> {
+  override async load(model: any): Promise<this> {
     if (!this.viewer.visualizeJs) return Promise.resolve(this);
 
     const visViewer = this.viewer.visViewer();
@@ -65,6 +66,11 @@ export class VSFXCloudLoader extends Loader {
       throw error;
     }
 
+    const modelImpl = new ModelImpl();
+    modelImpl.id = model.file.id;
+
+    this.viewer.models.push(modelImpl);
+
     this.viewer.syncOptions();
     this.viewer.syncOverlay();
     this.viewer.update(true);

package/src/Viewer/Loaders/VSFXCloudPartialLoader.ts

@@ -23,6 +23,7 @@
 
 import { Loader } from "@inweb/viewer-core";
 import { Viewer } from "../Viewer";
+import { ModelImpl } from "../Models/ModelImpl";
 import { UpdateController, UpdateType } from "./UpdateController";
 
 const PENDING_REQUESTS_SIZE = 50;
@@ -49,7 +50,7 @@ export class VSFXCloudPartialLoader extends Loader {
     );
   }
 
-  override async load(model: any, format?: string): Promise<this> {
+  override async load(model: any): Promise<this> {
     if (!this.viewer.visualizeJs) return this;
 
     const visViewer = this.viewer.visViewer();
@@ -81,10 +82,15 @@ export class VSFXCloudPartialLoader extends Loader {
       this.viewer.emitEvent({ type: "geometryprogress", data: progress, file: model.file, model });
 
       if (isDatabaseChunk) {
+        const modelImpl = new ModelImpl();
+        modelImpl.id = model.file.id;
+
+        this.viewer.models.push(modelImpl);
+
         this.viewer.syncOptions();
         this.viewer.syncOverlay();
-
         updateController.update(UpdateType.kForce);
+
         this.viewer.emitEvent({ type: "databasechunk", data: chunk, file: model.file, model });
       } else {
         updateController.update(UpdateType.kDelay);

package/src/Viewer/Loaders/VSFXCloudStreamingLoader.ts

@@ -23,6 +23,7 @@
 
 import { Loader } from "@inweb/viewer-core";
 import { Viewer } from "../Viewer";
+import { ModelImpl } from "../Models/ModelImpl";
 import { UpdateController, UpdateType } from "./UpdateController";
 
 export class VSFXCloudStreamingLoader extends Loader {
@@ -79,10 +80,15 @@ export class VSFXCloudStreamingLoader extends Loader {
       }
 
       if (isDatabaseChunk) {
+        const modelImpl = new ModelImpl();
+        modelImpl.id = model.file.id;
+
+        this.viewer.models.push(modelImpl);
+
         this.viewer.syncOptions();
         this.viewer.syncOverlay();
-
         updateController.update(UpdateType.kForce);
+
         this.viewer.emitEvent({ type: "databasechunk", data: chunk, file: model.file, model });
       } else {
         updateController.update(UpdateType.kDelay);

package/src/Viewer/Loaders/VSFXFileLoader.ts

@@ -23,6 +23,7 @@
 
 import { Loader, LoadParams } from "@inweb/viewer-core";
 import { Viewer } from "../Viewer";
+import { ModelImpl } from "../Models/ModelImpl";
 import { FileLoader } from "./FileLoader";
 
 export class VSFXFileLoader extends Loader {
@@ -40,7 +41,7 @@ export class VSFXFileLoader extends Loader {
     );
   }
 
-  override async load(file: any, format?: string, params?: LoadParams): Promise<this> {
+  override async load(file: any, format?: string, params: LoadParams = {}): Promise<this> {
     if (!this.viewer.visualizeJs) return this;
 
     const visViewer = this.viewer.visViewer();
@@ -68,6 +69,11 @@ export class VSFXFileLoader extends Loader {
       throw error;
     }
 
+    const modelImpl = new ModelImpl();
+    modelImpl.id = params.modelId || this.extractFileName(file);
+
+    this.viewer.models.push(modelImpl);
+
     this.viewer.syncOptions();
     this.viewer.syncOverlay();
     this.viewer.update(true);

package/src/Viewer/Loaders/index.ts

@@ -38,23 +38,24 @@ import { VSFXCloudPartialLoader } from "./VSFXCloudPartialLoader";
  *
  * 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.
+ * 3. Override {@link ILoader.isSupport} and check 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 into the buffer. The model data must be a `VSFX` format.
  *    - Parse data buffer with the `VisualizeJS` viewer instance.
+ *    - Create `ModelImpl` instance with unique model ID add it to the viewer `models` list.
  *    - 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.
+ *    - `geometryprogress` - during loading (or once at 100% when 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}.
+ * 6. Use `this.abortController` (defined in `Loader` class) to abort loading raw data.
+ * 7. Register loader provider in the loaders registry by calling the {@link loaders.registerLoader}.
  *
  * @example Implementing a custom loader.
  *
@@ -70,21 +71,25 @@ import { VSFXCloudPartialLoader } from "./VSFXCloudPartialLoader";
  *   }
  *
  *   override isSupport(file, format): Boolean {
- *     // place custom logic here
- *     return ...;
+ *     // check if this loader supports the file source and format
+ *     return type file === "string" && format === "myformat";
  *   }
  *
  *   override load(file, format, params): Promise<this> {
+ *    // load VSFX data from file (custom loading logic)
+ *     const data = await fetch(file).then((result) => result.arrayBuffer());
  *
- *     // place custom loading logic here
- *     const data = ...
+ *     const modelImpl = new ModelImpl();
+ *     modelImpl.id = params.modelId;
  *
- *     this.viewer.visualizeJs.getViewer().parseVsfx(data);
+ *     this.viewer.visViewer().parseVsfx(new Uint8Array(data));
+ *     this.viewer.models.push(modelImpl);
  *
  *     this.viewer.syncOptions();
  *     this.viewer.syncOverlay();
  *     this.viewer.update();
  *
+ *     this.viewer.emitEvent({ type: "geometryprogress", data: 1, file });
  *     this.viewer.emitEvent({ type: "databasechunk", data, file });
  *
  *     return Promise.resove(this);

package/src/Viewer/Models/IModelImpl.ts

@@ -0,0 +1,29 @@
+///////////////////////////////////////////////////////////////////////////////
+// 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 { IModel } from "@inweb/viewer-core";
+
+/**
+ * Basic model implementation.
+ */
+export type IModelImpl = IModel;

package/src/Viewer/Models/ModelImpl.ts

@@ -0,0 +1,32 @@
+///////////////////////////////////////////////////////////////////////////////
+// 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 { IModelImpl } from "./IModelImpl";
+
+// Basic model implementation.
+
+export class ModelImpl implements IModelImpl {
+  public id: string;
+
+  dispose(): void {}
+}