@inweb/viewer-three 26.6.5 → 26.6.7

package/src/Viewer/loaders/GLTFFileLoader.ts

@@ -26,6 +26,7 @@ import { Loader } from "@inweb/viewer-core";
 
 import { Viewer } from "../Viewer";
 import { GLTFLoadingManager, GLTFLoadParams } from "./GLTFLoadingManager";
+import { ModelImpl } from "../model/ModelImpl";
 
 export class GLTFFileLoader extends Loader {
   public viewer: Viewer;
@@ -59,8 +60,12 @@ export class GLTFFileLoader extends Loader {
     const gltf = await loader.loadAsync(manager.fileURL, progress);
     if (!this.viewer.scene) return this;
 
-    this.viewer.scene.add(gltf.scene);
-    this.viewer.models.push(gltf.scene);
+    const modelImpl = new ModelImpl(gltf.scene);
+    modelImpl.loader = this;
+    modelImpl.viewer = this.viewer;
+
+    this.viewer.scene.add(modelImpl.scene);
+    this.viewer.models.push(modelImpl);
 
     this.viewer.syncOptions();
     this.viewer.syncOverlay();

package/src/Viewer/loaders/index.ts

@@ -24,7 +24,7 @@
 import { ILoadersRegistry, loadersRegistry } from "@inweb/viewer-core";
 
 import { GLTFFileLoader } from "./GLTFFileLoader";
-import { GLTFCloudModelLoader } from "./GLTFCloudModelLoader";
+import { GLTFCloudDynamicLoader } from "./GLTFCloudDynamicLoader";
 
 /**
  * Viewer loaders registry. Use this registry to register custom loaders.
@@ -96,4 +96,4 @@ export const loaders: ILoadersRegistry = loadersRegistry("threejs");
 // build-in loaders
 
 loaders.registerLoader("gltf-file", (viewer: any) => new GLTFFileLoader(viewer));
-loaders.registerLoader("gltf-cloud-model", (viewer: any) => new GLTFCloudModelLoader(viewer));
+loaders.registerLoader("gltf-cloud", (viewer: any) => new GLTFCloudDynamicLoader(viewer));

package/src/Viewer/model/IModelImpl.ts

@@ -0,0 +1,67 @@
+///////////////////////////////////////////////////////////////////////////////
+// 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 { Box3, Object3D } from "three";
+import { ILoader, IViewer } from "@inweb/viewer-core";
+
+/**
+ * Model interface.
+ */
+export interface IModelImpl {
+  handle: string;
+  scene: Object3D;
+  loader: ILoader;
+  viewer: IViewer;
+
+  dispose(): void;
+
+  getExtents(target: Box3): Box3;
+
+  getObjects(): Object3D[];
+
+  getVisibleObjects(): Object3D[];
+
+  hasObject(objects: Object3D): boolean;
+
+  getOwnObjects(objects: Object3D | Object3D[]): Object3D[];
+
+  getObjectsByHandles(handles: string | string[]): Object3D[];
+
+  getHandlesByObjects(objects: Object3D | Object3D[]): string[];
+
+  hideObjects(objects: Object3D | Object3D[]): this;
+
+  hideAllObjects(): this;
+
+  isolateObjects(objects: Object3D | Object3D[]): this;
+
+  showObjects(objects: Object3D | Object3D[]): this;
+
+  showAllObjects(): this;
+
+  showOriginalObjects(objects: Object3D | Object3D[]): this;
+
+  hideOriginalObjects(objects: Object3D | Object3D[]): this;
+
+  explode(scale: number, coeff?: number): this;
+}

package/src/Viewer/model/ModelImpl.ts

@@ -0,0 +1,215 @@
+///////////////////////////////////////////////////////////////////////////////
+// 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 { Box3, Object3D, Vector3 } from "three";
+import { ILoader } from "@inweb/viewer-core";
+
+import { IModelImpl } from "./IModelImpl";
+import { Viewer } from "../Viewer";
+
+/**
+ * Basic model implementation.
+ */
+export class ModelImpl implements IModelImpl {
+  public handle: string;
+  public scene: Object3D;
+  public loader: ILoader;
+  public viewer: Viewer;
+
+  constructor(scene: Object3D) {
+    this.handle = "1";
+    this.scene = scene;
+  }
+
+  dispose() {
+    function disposeMaterial(material: any) {
+      // if (material.alphaMap) material.alphaMap.dispose();
+      // if (material.anisotropyMap) material.anisotropyMap.dispose();
+      // if (material.aoMap) material.aoMap.dispose();
+      // if (material.bumpMap) material.bumpMap.dispose();
+      // if (material.clearcoatMap) material.clearcoatMap.dispose();
+      // if (material.clearcoatNormalMap) material.clearcoatNormalMap.dispose();
+      // if (material.clearcoatRoughnessMap) material.clearcoatRoughnessMap.dispose();
+      // if (material.displacementMap) material.displacementMap.dispose();
+      // if (material.emissiveMap) material.emissiveMap.dispose();
+      // if (material.gradientMap) material.gradientMap.dispose();
+      // if (material.envMap) material.envMap.dispose();
+      // if (material.iridescenceMap) material.iridescenceMap.dispose();
+      // if (material.lightMap) material.lightMap.dispose();
+      // if (material.map) material.map.dispose();
+      // if (material.metalnessMap) material.metalnessMap.dispose();
+      // if (material.normalMap) material.normalMap.dispose();
+      // if (material.roughnessMap) material.roughnessMap.dispose();
+      // if (material.sheenColorMap) material.sheenColorMap.dispose();
+      // if (material.sheenRoughnessMap) material.sheenRoughnessMap.dispose();
+      // if (material.specularMap) material.specularMap.dispose();
+      // if (material.thicknessMap) material.thicknessMap.dispose();
+      // if (material.transmissionMap) material.transmissionMap.dispose();
+      material.dispose();
+    }
+
+    function disposeMaterials(material: any) {
+      const materials = Array.isArray(material) ? material : [material];
+      materials.forEach((material: any) => disposeMaterial(material));
+    }
+
+    function disposeObject(object: any) {
+      if (object.geometry) object.geometry.dispose();
+      if (object.material) disposeMaterials(object.material);
+    }
+
+    this.scene.traverse(disposeObject);
+    this.scene.clear();
+  }
+
+  getExtents(target: Box3): Box3 {
+    this.scene.traverseVisible((object) => !object.children.length && target.expandByObject(object));
+    return target;
+  }
+
+  getObjects(): Object3D[] {
+    const objects = [];
+    this.scene.traverse((object) => objects.push(object));
+    return objects;
+  }
+
+  getVisibleObjects(): Object3D[] {
+    const objects = [];
+    this.scene.traverseVisible((object) => objects.push(object));
+    return objects;
+  }
+
+  hasObject(object: Object3D): boolean {
+    while (object) {
+      if (object === this.scene) return true;
+      object = object.parent;
+    }
+    return false;
+  }
+
+  getOwnObjects(objects: Object3D | Object3D[]): Object3D[] {
+    if (!Array.isArray(objects)) objects = [objects];
+    return objects.filter((object) => this.hasObject(object));
+  }
+
+  getObjectsByHandles(handles: string | string[]): Object3D[] {
+    const handleSet = new Set(handles);
+    const objects = [];
+    this.scene.traverse((object) => handleSet.has(object.userData.handle) && objects.push(object));
+    return objects;
+  }
+
+  getHandlesByObjects(objects: Object3D | Object3D[]): string[] {
+    if (!Array.isArray(objects)) objects = [objects];
+    const handlesSet = new Set<string>();
+    this.getOwnObjects(objects).forEach((object) => handlesSet.add(object.userData.handle));
+    return Array.from(handlesSet);
+  }
+
+  hideObjects(objects: Object3D | Object3D[]): this {
+    if (!Array.isArray(objects)) objects = [objects];
+    this.getOwnObjects(objects).forEach((object) => (object.visible = false));
+    return this;
+  }
+
+  hideAllObjects(): this {
+    return this.isolateObjects([]);
+  }
+
+  isolateObjects(objects: Object3D | Object3D[]): this {
+    if (!Array.isArray(objects)) objects = [objects];
+    const visibleSet = new Set(objects);
+    this.getOwnObjects(objects).forEach((object) => object.traverseAncestors((parent) => visibleSet.add(parent)));
+    this.scene.traverse((object) => (object.visible = visibleSet.has(object)));
+    return this;
+  }
+
+  showObjects(objects: Object3D | Object3D[]): this {
+    if (!Array.isArray(objects)) objects = [objects];
+    this.getOwnObjects(objects).forEach((object) => {
+      object.visible = true;
+      object.traverseAncestors((parent) => (parent.visible = true));
+    });
+    return this;
+  }
+
+  showAllObjects(): this {
+    this.scene.traverse((object) => (object.visible = true));
+    return this;
+  }
+
+  showOriginalObjects(objects: Object3D | Object3D[]): this {
+    return this;
+  }
+
+  hideOriginalObjects(objects: Object3D | Object3D[]): this {
+    return this;
+  }
+
+  explode(scale = 0, coeff = 4): this {
+    function calcExplodeDepth(object: Object3D, depth: number): number {
+      let res = depth;
+      object.children.forEach((x: Object3D) => {
+        const objectDepth = calcExplodeDepth(x, depth + 1);
+        if (res < objectDepth) res = objectDepth;
+      });
+
+      object.userData.originalPosition = object.position.clone();
+      object.userData.originalCenter = new Box3().setFromObject(object).getCenter(new Vector3());
+      object.userData.isExplodeLocked = depth > 2 && object.children.length === 0;
+
+      return res;
+    }
+
+    scale /= 100;
+
+    if (!this.scene.userData.explodeDepth) this.scene.userData.explodeDepth = calcExplodeDepth(this.scene, 1);
+    const maxDepth = this.scene.userData.explodeDepth;
+
+    const scaledExplodeDepth = scale * maxDepth + 1;
+    const explodeDepth = 0 | scaledExplodeDepth;
+    const currentSegmentFraction = scaledExplodeDepth - explodeDepth;
+
+    function explodeObject(object: Object3D, depth: number) {
+      object.position.copy(object.userData.originalPosition);
+
+      if (depth > 0 && depth <= explodeDepth && !object.userData.isExplodeLocked) {
+        let objectScale = scale * coeff;
+        if (depth === explodeDepth) objectScale *= currentSegmentFraction;
+
+        const parentCenter = object.parent.userData.originalCenter;
+        const objectCenter = object.userData.originalCenter;
+        const objectOffset = objectCenter.clone().sub(parentCenter).multiplyScalar(objectScale);
+
+        object.position.add(objectOffset);
+      }
+
+      object.children.forEach((x) => explodeObject(x, depth + 1));
+    }
+
+    explodeObject(this.scene, 0);
+    this.scene.updateMatrixWorld();
+
+    return this;
+  }
+}

package/src/Viewer/model/index.ts

@@ -0,0 +1,25 @@
+///////////////////////////////////////////////////////////////////////////////
+// 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.
+///////////////////////////////////////////////////////////////////////////////
+
+export * from "./IModelImpl";
+export * from "./ModelImpl";

package/src/index.ts

@@ -26,6 +26,7 @@ export * from "./Viewer/commands";
 export * from "./Viewer/components";
 export * from "./Viewer/loaders";
 export * from "./Viewer/loaders/GLTFLoadingManager";
+export * from "./Viewer/model";
 export * from "./Viewer/Viewer";
 
 // the lines below are required for typedoc to include the viewer core and markups documentation

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

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