@combeenation/3d-viewer 7.1.3 → 8.1.0-alpha1

package/src/api/manager/gltfExportManager.ts

@@ -1,237 +1,302 @@
-import { Viewer } from '../classes/viewer';
-import { injectNodeMetadata } from '../util/babylonHelper';
-import { isMeshIncludedInExclusionList } from '../util/structureHelper';
-import { PBRMaterial } from '@babylonjs/core/Materials/PBR/pbrMaterial';
-import { Color3 } from '@babylonjs/core/Maths/math.color';
-import { AbstractMesh } from '@babylonjs/core/Meshes/abstractMesh';
-import { Mesh } from '@babylonjs/core/Meshes/mesh';
-import { GLTF2Export, IExportOptions } from '@babylonjs/serializers/glTF/2.0';
-import { has, merge } from 'lodash-es';
-
-export class GltfExportManager {
-  public static readonly UNIQUE_MESH_METADATA_PROPERTY = 'originalName';
-
-  /**
-   * Constructor.
-   */
-  protected constructor(protected viewer: Viewer) {}
-
-  /**
-   * Creates an {@link GltfExportManager}.
-   */
-  public static async create(viewer: Viewer): Promise<GltfExportManager> {
-    return new GltfExportManager(viewer);
-  }
-
-  /**
-   * Exports selected nodes to a file.
-   * @param filename optional name of the exported .GLB file.
-   * @param exportOptions export options to be merged with default options.\
-   *                      `exportOptions.createUniqueMeshNames` defaults to `true` if not given.
-   * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
-   */
-  public async exportGlb(
-    filename = 'glb-export.glb',
-    { createUniqueMeshNames = true, ...exportOptionsRest }: IExportOptionsExtended = {},
-    excluded?: ExcludedGeometryList
-  ): Promise<File | undefined> {
-    const exportOptions = { createUniqueMeshNames, ...exportOptionsRest };
-    this.exportPreProcess(exportOptions);
-    const glbData = await GLTF2Export.GLBAsync(
-      this.viewer.scene,
-      'dummy',
-      this.gltfExportOptions(exportOptions, excluded)
-    );
-    this.exportPostProcess();
-    const resBlob = glbData.glTFFiles['dummy.glb']; // should be only one file for glb
-
-    // check if result is valid, according to the typings this could also be a string
-    if (resBlob instanceof Blob) {
-      if (!filename.endsWith('.glb')) {
-        filename += '.glb';
-      }
-      return new File([resBlob], filename);
-    } else {
-      // result was not a valid blob
-      return undefined;
-    }
-  }
-
-  /**
-   * Exports selected nodes to GLTF. This may result in more than one file, since textures are exported separately.
-   * @param filename name of the main (text-based) .GLTF file referring to separate texture files.
-   * @param exportOptions export options to be merged with default options.\
-   *                      `exportOptions.createUniqueMeshNames` defaults to `true` if not given.
-   * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
-   */
-  public async exportGltfToFile(
-    filename: string,
-    { createUniqueMeshNames = true, ...exportOptionsRest }: IExportOptionsExtended = {},
-    excluded?: ExcludedGeometryList
-  ) {
-    const exportOptions = { createUniqueMeshNames, ...exportOptionsRest };
-    this.exportPreProcess(exportOptions);
-    await GLTF2Export.GLTFAsync(this.viewer.scene, filename, this.gltfExportOptions(exportOptions, excluded)).then(
-      glb => {
-        glb.downloadFiles();
-      }
-    );
-    this.exportPostProcess();
-  }
-
-  /**
-   * Exports selected nodes to GLB. This results in one binary file.
-   * @param filename name of the .GLB file.
-   * @param exportOptions export options to be merged with default options.\
-   *                      `exportOptions.createUniqueMeshNames` defaults to `true` if not given.
-   * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
-   */
-  public async exportGlbToFile(
-    filename: string,
-    { createUniqueMeshNames = true, ...exportOptionsRest }: IExportOptionsExtended = {},
-    excluded?: ExcludedGeometryList
-  ) {
-    const exportOptions = { createUniqueMeshNames, ...exportOptionsRest };
-    this.exportPreProcess(exportOptions);
-    await GLTF2Export.GLBAsync(this.viewer.scene, filename, this.gltfExportOptions(exportOptions, excluded)).then(
-      glb => {
-        glb.downloadFiles();
-      }
-    );
-    this.exportPostProcess();
-  }
-
-  /**
-   * Gets predefined {@link IExportOptionsExtended } merged with given ones.
-   */
-  protected gltfExportOptions(
-    mergeWithOptions: IExportOptionsExtended = {},
-    excluded?: ExcludedGeometryList
-  ): IExportOptions {
-    const defaultOptions: IExportOptions = {
-      // includeCoordinateSystemConversionNodes: true,
-      shouldExportNode: function (node: any) {
-        if (!node.isEnabled()) {
-          return false;
-        }
-        if ((node.name as string).startsWith(Viewer.BOUNDING_BOX_NAME)) {
-          return false;
-        }
-        if (excluded && node instanceof Mesh && isMeshIncludedInExclusionList(node, excluded)) {
-          return false;
-        }
-        return true;
-      },
-    };
-    return merge({}, defaultOptions, mergeWithOptions);
-  }
-
-  /**
-   * Stuff to be done before exporting to GLTF
-   */
-  protected exportPreProcess({ createUniqueMeshNames = true }: IExportOptionsExtended) {
-    this.viewer.pauseRendering();
-    if (createUniqueMeshNames ?? true) {
-      this.setUniqueMeshNames();
-    }
-    this.exchangeRefractionMaterials();
-  }
-
-  /**
-   * Stuff to be done after the GLTF export
-   */
-  protected exportPostProcess() {
-    this.restoreRefractionMaterials();
-    this.restoreOriginalMeshNames();
-    this.viewer.resumeRendering();
-  }
-
-  /**
-   * Materials with refraction set are not exported properly.
-   * Exchange all such (relevant) materials with a more export-friendly version
-   */
-  protected exchangeRefractionMaterials() {
-    for (const n of this.viewer.scene.getNodes()) {
-      if (!(n instanceof AbstractMesh)) continue;
-      if (!(n.material instanceof PBRMaterial)) continue;
-      if (!(n.material as PBRMaterial).subSurface.isRefractionEnabled) continue;
-      if ((n.material as PBRMaterial).transparencyMode !== PBRMaterial.PBRMATERIAL_OPAQUE) continue;
-      // if we're here, we have a node holding a material with set refraction whose transparencyMode is set to
-      // PBRMATERIAL_OPAQUE
-      n.material = this.createRefractionMaterialReplacement(n.material);
-    }
-  }
-
-  /**
-   * Restore original materials with set refraction.
-   */
-  protected restoreRefractionMaterials() {
-    for (const n of this.viewer.scene.getNodes()) {
-      if (!(n instanceof AbstractMesh)) continue;
-      if (!(n.material instanceof PBRMaterial)) continue;
-      if (!this.isMaterialClonedForExport(n.material)) continue;
-      // at this point we have a pbrmaterial tagged as cloned in its metadata that's set on a mesh
-
-      // restore and dispose
-      const currMaterial = n.material;
-      const prevMaterial = this.viewer.scene.getMaterialByUniqueID(n.material.metadata.clonedFrom);
-      if (prevMaterial) {
-        n.material = prevMaterial; // restore previous material
-        currMaterial.dispose(false, true); // dispose of clone
-      }
-    }
-  }
-
-  /**
-   * Create an export-friendly replacement material for a material using refraction.
-   * @param mat Material to be replaced
-   */
-  protected createRefractionMaterialReplacement(mat: PBRMaterial): PBRMaterial {
-    // if we're dealing with a clone already, return it instead of cloning
-    if (this.isMaterialClonedForExport(mat)) return mat;
-
-    // change material according to https://www.notion.so/combeenation/Glas-materials-don-t-look-glasy-after-export-d5fda2c6515e4420a8772744d3e6b460
-    const clonedMaterial = mat.clone(mat.name); // clone material. clone uses same name
-    clonedMaterial.metadata = { ...mat.metadata, clonedFrom: mat.uniqueId }; // create shallow copy of metadata on clone. see https://forum.babylonjs.com/t/the-metadata-of-the-mesh-cloned-by-the-instantiatemodelstoscene-method-is-a-shallow-copy/21563
-    clonedMaterial.refractionTexture = null;
-    clonedMaterial.metallicReflectanceTexture = null; // is this the correct one for metallic roughness?
-    clonedMaterial.alpha = 0.7;
-    clonedMaterial.albedoColor = new Color3(0.3, 0.3, 0.3);
-    clonedMaterial.transparencyMode = PBRMaterial.PBRMATERIAL_ALPHABLEND;
-    clonedMaterial.metallic = 0.65;
-    clonedMaterial.roughness = 0.15;
-
-    return clonedMaterial;
-  }
-
-  /**
-   * Inspect if a material was temporarily cloned for GLB export
-   * @param mat Material to be inspected
-   */
-  protected isMaterialClonedForExport(mat: PBRMaterial): boolean {
-    return !!mat.metadata?.clonedFrom;
-  }
-
-  /**
-   * Set unique mesh names for GLB export
-   */
-  protected setUniqueMeshNames(): void {
-    this.viewer.scene.meshes.forEach(currMesh => {
-      injectNodeMetadata(currMesh, { [GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY]: currMesh.name }, false);
-      currMesh.name = `${currMesh.name}_${currMesh.uniqueId}`;
-    });
-  }
-
-  /**
-   * Restore original mesh names for meshes that were
-   * renamed with {@link setUniqueMeshNames()}
-   */
-  protected restoreOriginalMeshNames(): void {
-    this.viewer.scene.meshes.forEach(currMesh => {
-      if (has(currMesh.metadata, GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY)) {
-        currMesh.name = currMesh.metadata[GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY];
-        delete currMesh.metadata[GltfExportManager.UNIQUE_MESH_METADATA_PROPERTY];
-      }
-    });
-  }
-}
+import { Viewer } from '../classes/viewer';
+import { injectNodeMetadata } from '../util/babylonHelper';
+import { isNodeIncludedInExclusionList } from '../util/structureHelper';
+import { Engine } from '@babylonjs/core/Engines/engine';
+import { SceneLoader } from '@babylonjs/core/Loading/sceneLoader';
+import { PBRMaterial } from '@babylonjs/core/Materials/PBR/pbrMaterial';
+import { Color3 } from '@babylonjs/core/Maths/math.color';
+import { Vector3 } from '@babylonjs/core/Maths/math.vector';
+import { AbstractMesh } from '@babylonjs/core/Meshes/abstractMesh';
+import { Mesh } from '@babylonjs/core/Meshes/mesh';
+import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
+import { SceneSerializer } from '@babylonjs/core/Misc/sceneSerializer';
+import { GLTF2Export, IExportOptions } from '@babylonjs/serializers/glTF/2.0';
+import { has, merge } from 'lodash-es';
+
+type MetadataMap = { [key: string]: any };
+export class GltfExportManager {
+  protected static readonly _CLONED_FROM_MAT_METADATA_PROPERTY = 'clonedFrom';
+  public static readonly NAME_BEFORE_EXPORT_METADATA_PROPERTY = 'nameBeforeExport';
+
+  /**
+   * Constructor.
+   */
+  protected constructor(protected viewer: Viewer) {}
+
+  /**
+   * Creates an {@link GltfExportManager}.
+   */
+  public static async create(viewer: Viewer): Promise<GltfExportManager> {
+    return new GltfExportManager(viewer);
+  }
+
+  /**
+   * Exports selected nodes to a file.
+   * @param filename optional name of the exported .GLB file.
+   * @param exportOptions export options to be merged with default options.\
+   *                      `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
+   * @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
+   * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
+   */
+  public async exportGlb(
+    filename = 'glb-export.glb',
+    { exchangeRefractionMaterials = true, ...exportOptions }: IExportOptionsExtended = {},
+    optimizeForAR: boolean = false,
+    excluded?: ExcludedGeometryList
+  ): Promise<File | undefined> {
+    const { scene, sceneCopied } = await this.exportPreProcess(exchangeRefractionMaterials, optimizeForAR);
+    const glbData = await GLTF2Export.GLBAsync(scene, 'dummy', this.gltfExportOptions(exportOptions, excluded));
+    this.exportPostProcess(scene, sceneCopied);
+
+    const resBlob = glbData.glTFFiles['dummy.glb'];
+    // check if result is valid, according to the typings this could also be a string
+    if (resBlob instanceof Blob) {
+      if (!filename.endsWith('.glb')) {
+        filename += '.glb';
+      }
+      return new File([resBlob], filename);
+    } else {
+      // result was not a valid blob
+      return undefined;
+    }
+  }
+
+  /**
+   * Exports selected nodes to GLTF. This may result in more than one file, since textures are exported separately.
+   * @param filename name of the main (text-based) .GLTF file referring to separate texture files.
+   * @param exportOptions export options to be merged with default options.\
+   *                      `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
+   * @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
+   * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
+   */
+  public async exportGltfToFile(
+    filename: string,
+    { exchangeRefractionMaterials = true, ...exportOptions }: IExportOptionsExtended = {},
+    optimizeForAR: boolean = false,
+    excluded?: ExcludedGeometryList
+  ) {
+    const { scene, sceneCopied } = await this.exportPreProcess(exchangeRefractionMaterials, optimizeForAR);
+    const gltf = await GLTF2Export.GLTFAsync(scene, filename, this.gltfExportOptions(exportOptions, excluded));
+    gltf.downloadFiles();
+    this.exportPostProcess(scene, sceneCopied);
+  }
+
+  /**
+   * Exports selected nodes to GLB. This results in one binary file.
+   * @param filename name of the .GLB file.
+   * @param exportOptions export options to be merged with default options.\
+   *                      `exportOptions.exchangeRefractionMaterials` defaults to `true` if not given.
+   * @param optimizeForAR adjusts the exported GLB so that known AR issues get fixed automatically
+   * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
+   */
+  public async exportGlbToFile(
+    filename: string,
+    { exchangeRefractionMaterials = true, ...exportOptions }: IExportOptionsExtended = {},
+    optimizeForAR: boolean = false,
+    excluded?: ExcludedGeometryList
+  ) {
+    const { scene, sceneCopied } = await this.exportPreProcess(exchangeRefractionMaterials, optimizeForAR);
+    const glb = await GLTF2Export.GLBAsync(scene, filename, this.gltfExportOptions(exportOptions, excluded));
+    glb.downloadFiles();
+    this.exportPostProcess(scene, sceneCopied);
+  }
+
+  /**
+   * Gets predefined {@link IExportOptions } merged with given ones.
+   */
+  protected gltfExportOptions(mergeWithOptions: IExportOptions = {}, excluded?: ExcludedGeometryList): IExportOptions {
+    const defaultOptions: IExportOptions = {
+      shouldExportNode: function (node: any) {
+        if (!node.isEnabled()) {
+          return false;
+        }
+        if ((node.name as string).startsWith(Viewer.BOUNDING_BOX_NAME)) {
+          return false;
+        }
+        if (excluded && node instanceof TransformNode && isNodeIncludedInExclusionList(node, excluded)) {
+          return false;
+        }
+        return true;
+      },
+    };
+    return merge({}, defaultOptions, mergeWithOptions);
+  }
+
+  /**
+   * Stuff to be done before exporting to GLTF
+   *
+   * @returns Either the original scene if no adjustments have been made or a copied scene (which can be disposed after
+   * the export) if adjustments have been made
+   */
+  protected async exportPreProcess(
+    exchangeRefractionMaterials: boolean,
+    optimizeForAR: boolean
+  ): Promise<{ scene: Scene; sceneCopied: boolean }> {
+    if (!exchangeRefractionMaterials && !optimizeForAR) {
+      // no need to copy the scene if no adjustments have to be made
+      return { scene: this.viewer.scene, sceneCopied: false };
+    }
+
+    // copy the scene for the GLB export improvements, so that the original viewer scene remains untouched
+    const copiedScene = await this.copyViewerScene();
+
+    if (exchangeRefractionMaterials) {
+      this.exchangeRefractionMaterials(copiedScene);
+    }
+
+    if (optimizeForAR) {
+      this.setUniqueMeshNames(copiedScene);
+      this.bakeTransformations(copiedScene);
+    }
+
+    return { scene: copiedScene, sceneCopied: true };
+  }
+
+  /**
+   * Create a copy of the viewer scene, which can be further processed and optimized for the GLB export.
+   * There is no "scene.clone" function, therefore the scene is serialized and loaded again to achieve this result.
+   */
+  protected async copyViewerScene(): Promise<Scene> {
+    // required by the scene serializer
+    await import(/* webpackChunkName: "physicsenginecomponent" */ '@babylonjs/core/Physics/physicsEngineComponent');
+
+    // copy scene function uses scene serializer, which can't handle "complex" data like classes, function or recursive
+    // data structures in metadata
+    // it basically does a `JSON.stringify` on the metadata
+    // therefore the metadata has to be removed from the nodes before the copy process
+    const metadataArr = this.extractMetadataOfAllNodes();
+
+    // serialize the scene
+    const serializedScene = await SceneSerializer.SerializeAsync(this.viewer.scene);
+
+    // set the cropped metadata back to the viewer scene nodes
+    this.restoreMetadataOfAllNodes(metadataArr);
+
+    // load the scene into an invisible "dummy" canvas
+    const offscreenCanvas = new OffscreenCanvas(0, 0);
+    const engine = new Engine(offscreenCanvas);
+
+    SceneLoader.ShowLoadingScreen = false;
+    const newScene = await SceneLoader.LoadAsync('', 'data:' + JSON.stringify(serializedScene), engine);
+    // this is required for offscreen canvas, otherwise the scene dispose code throws when trying to remove the cursor
+    // events
+    newScene.doNotHandleCursors = true;
+
+    return newScene;
+  }
+
+  /**
+   * Stuff to be done after the GLTF export
+   */
+  protected exportPostProcess(scene: Scene, disposeScene: boolean) {
+    if (disposeScene) {
+      // copied scene for GLB export is not needed anymore, therefore it can be removed
+      scene.getEngine().dispose();
+    }
+  }
+
+  /**
+   * Remove all node metadata and return them in a map
+   */
+  protected extractMetadataOfAllNodes(): MetadataMap {
+    return this.viewer.scene.getNodes().reduce((accMetadataObj, curNode) => {
+      const metadata = curNode.metadata;
+      delete curNode.metadata;
+      return { ...accMetadataObj, [curNode.uniqueId.toString()]: metadata };
+    }, {});
+  }
+
+  /**
+   * Restore node metadata from previously cropped metadata map
+   */
+  protected restoreMetadataOfAllNodes(metadataMap: MetadataMap) {
+    this.viewer.scene.getNodes().forEach(node => {
+      const metadata = metadataMap[node.uniqueId.toString()];
+      if (metadata) {
+        node.metadata = metadata;
+      }
+    });
+  }
+
+  /**
+   * Materials with refraction set are not exported properly.
+   * Exchange all such (relevant) materials with a more export-friendly version
+   */
+  protected exchangeRefractionMaterials(scene: Scene) {
+    for (const n of scene.getNodes()) {
+      if (!(n instanceof AbstractMesh)) continue;
+      if (!(n.material instanceof PBRMaterial)) continue;
+      if (!(n.material as PBRMaterial).subSurface.isRefractionEnabled) continue;
+      if ((n.material as PBRMaterial).transparencyMode !== PBRMaterial.PBRMATERIAL_OPAQUE) continue;
+      // if we're here, we have a node holding a material with set refraction whose transparencyMode is set to
+      // PBRMATERIAL_OPAQUE
+      n.material = this.createRefractionMaterialReplacement(n.material);
+    }
+  }
+
+  /**
+   * Create an export-friendly replacement material for a material using refraction.
+   * @param mat Material to be replaced
+   */
+  protected createRefractionMaterialReplacement(mat: PBRMaterial): PBRMaterial {
+    // if we're dealing with a clone already, return it instead of cloning
+    if (this.isMaterialClonedForExport(mat)) return mat;
+
+    // change material according to https://www.notion.so/combeenation/Glas-materials-don-t-look-glasy-after-export-d5fda2c6515e4420a8772744d3e6b460
+    const clonedMaterial = mat.clone(mat.name); // clone material. clone uses same name
+    clonedMaterial.metadata = { ...mat.metadata, [GltfExportManager._CLONED_FROM_MAT_METADATA_PROPERTY]: mat.uniqueId }; // create shallow copy of metadata on clone. see https://forum.babylonjs.com/t/the-metadata-of-the-mesh-cloned-by-the-instantiatemodelstoscene-method-is-a-shallow-copy/21563
+    clonedMaterial.refractionTexture = null;
+    clonedMaterial.metallicReflectanceTexture = null; // is this the correct one for metallic roughness?
+    clonedMaterial.alpha = 0.7;
+    clonedMaterial.albedoColor = new Color3(0.3, 0.3, 0.3);
+    clonedMaterial.transparencyMode = PBRMaterial.PBRMATERIAL_ALPHABLEND;
+    clonedMaterial.metallic = 0.65;
+    clonedMaterial.roughness = 0.15;
+
+    return clonedMaterial;
+  }
+
+  /**
+   * Inspect if a material was temporarily cloned for GLB export
+   * @param mat Material to be inspected
+   */
+  protected isMaterialClonedForExport(mat: PBRMaterial): boolean {
+    return has(mat.metadata, GltfExportManager._CLONED_FROM_MAT_METADATA_PROPERTY);
+  }
+
+  /**
+   * Set unique mesh names for GLB export.
+   * Duplicate names lead to problems in AR on iOS devices.
+   */
+  protected setUniqueMeshNames(scene: Scene): void {
+    const allNodes = scene.getNodes().filter(node => node instanceof TransformNode) as TransformNode[];
+    allNodes.forEach(currMesh => {
+      injectNodeMetadata(currMesh, { [GltfExportManager.NAME_BEFORE_EXPORT_METADATA_PROPERTY]: currMesh.name }, false);
+      currMesh.name = `${currMesh.name}_${currMesh.uniqueId}`;
+    });
+  }
+
+  /**
+   * Stores the effect of all mesh transformations in their geometry and reset the transformation afterwards.
+   * In this way negative scalings which lead to problems in AR on iOS devices can be eliminated.
+   */
+  protected bakeTransformations(scene: Scene): void {
+    scene.meshes.forEach(mesh => {
+      if (mesh instanceof Mesh && mesh.geometry) {
+        // geometries can be shared across multiple meshes, first make them unique to avoid side-effects
+        mesh.makeGeometryUnique();
+        // this is the core functionality for storing the transformation data in the mesh geometry
+        mesh.bakeCurrentTransformIntoVertices();
+      }
+    });
+
+    // some nodes (mostly transform nodes), are not affected by the baking algorithm since they have no geometry
+    // => reset their transformation manually
+    const allNodes = scene.getNodes().filter(node => node instanceof TransformNode) as TransformNode[];
+    allNodes.forEach(node => {
+      node.position = new Vector3(0, 0, 0);
+      node.rotation = new Vector3(0, 0, 0);
+      node.scaling = new Vector3(1, 1, 1);
+    });
+  }
+}