@combeenation/3d-viewer 9.0.2-alpha2 → 9.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@combeenation/3d-viewer",
-  "version": "9.0.2-alpha2",
+  "version": "9.1.0",
   "description": "Combeenation 3D Viewer",
   "homepage": "https://github.com/Combeenation/3d-viewer#readme",
   "bugs": {

package/src/api/manager/gltfExportManager.ts

@@ -34,17 +34,22 @@ export class GltfExportManager {
    * 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.
+   *                      `exportOptions.exchangeRefractionMaterials` and `exportOptions.limitTextureSize`
+   *                      default 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 = {},
+    { exchangeRefractionMaterials = true, limitTextureSize = true, ...exportOptions }: IExportOptionsExtended = {},
     optimizeForAR: boolean = false,
     excluded?: ExcludedGeometryList
   ): Promise<File | undefined> {
-    const { scene, sceneCopied } = await this.exportPreProcess(exchangeRefractionMaterials, optimizeForAR);
+    const { scene, sceneCopied } = await this.exportPreProcess(
+      exchangeRefractionMaterials,
+      limitTextureSize,
+      optimizeForAR
+    );
     const glbData = await GLTF2Export.GLBAsync(scene, 'dummy', this.gltfExportOptions(exportOptions, excluded));
     this.exportPostProcess(scene, sceneCopied);
 
@@ -65,17 +70,22 @@ export class GltfExportManager {
    * 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.
+   *                      `exportOptions.exchangeRefractionMaterials` and `exportOptions.limitTextureSize`
+   *                      default 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 = {},
+    { exchangeRefractionMaterials = true, limitTextureSize = true, ...exportOptions }: IExportOptionsExtended = {},
     optimizeForAR: boolean = false,
     excluded?: ExcludedGeometryList
   ) {
-    const { scene, sceneCopied } = await this.exportPreProcess(exchangeRefractionMaterials, optimizeForAR);
+    const { scene, sceneCopied } = await this.exportPreProcess(
+      exchangeRefractionMaterials,
+      limitTextureSize,
+      optimizeForAR
+    );
     const gltf = await GLTF2Export.GLTFAsync(scene, filename, this.gltfExportOptions(exportOptions, excluded));
     gltf.downloadFiles();
     this.exportPostProcess(scene, sceneCopied);
@@ -85,17 +95,22 @@ export class GltfExportManager {
    * 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.
+   *                      `exportOptions.exchangeRefractionMaterials` and `exportOptions.limitTextureSize`
+   *                      default 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 = {},
+    { exchangeRefractionMaterials = true, limitTextureSize = true, ...exportOptions }: IExportOptionsExtended = {},
     optimizeForAR: boolean = false,
     excluded?: ExcludedGeometryList
   ) {
-    const { scene, sceneCopied } = await this.exportPreProcess(exchangeRefractionMaterials, optimizeForAR);
+    const { scene, sceneCopied } = await this.exportPreProcess(
+      exchangeRefractionMaterials,
+      limitTextureSize,
+      optimizeForAR
+    );
     const glb = await GLTF2Export.GLBAsync(scene, filename, this.gltfExportOptions(exportOptions, excluded));
     glb.downloadFiles();
     this.exportPostProcess(scene, sceneCopied);
@@ -130,15 +145,16 @@ export class GltfExportManager {
    */
   protected async exportPreProcess(
     exchangeRefractionMaterials: boolean,
+    limitTextureSize: boolean,
     optimizeForAR: boolean
   ): Promise<{ scene: Scene; sceneCopied: boolean }> {
-    if (!exchangeRefractionMaterials && !optimizeForAR) {
+    if (!exchangeRefractionMaterials && !optimizeForAR && !limitTextureSize) {
       // 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();
+    const copiedScene = await this.copyViewerScene(limitTextureSize);
 
     if (exchangeRefractionMaterials) {
       this.exchangeRefractionMaterials(copiedScene);
@@ -156,7 +172,7 @@ export class GltfExportManager {
    * 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> {
+  protected async copyViewerScene(limitTextureSize: boolean): Promise<Scene> {
     // required by the scene serializer
     await import(/* webpackChunkName: "physicsenginecomponent" */ '@babylonjs/core/Physics/physicsEngineComponent');
 
@@ -173,11 +189,14 @@ export class GltfExportManager {
     this.restoreMetadataOfAllNodes(metadataArr);
 
     // load the scene into an invisible "dummy" canvas
-    const offscreenCanvas = new HTMLCanvasElement();
-    const engine = new Engine(offscreenCanvas);
+    const dummyCanvas = document.createElement('canvas');
+    const engine = new Engine(dummyCanvas);
 
-    // engine.getCaps().maxTextureSize = 1024;
-    console.log('!!! using HTML Canvas for Export !!!');
+    if (limitTextureSize) {
+      // according to some tests iOS devices break when exporting a scene with textures above 1024
+      // this only affects the scene clone for the export
+      engine.getCaps().maxTextureSize = 1024;
+    }
 
     SceneLoader.ShowLoadingScreen = false;
     const newScene = await SceneLoader.LoadAsync('', 'data:' + JSON.stringify(serializedScene), engine);
@@ -185,11 +204,6 @@ export class GltfExportManager {
     // events
     newScene.doNotHandleCursors = true;
 
-    console.log('old scene');
-    this.viewer.scene.textures.map(texture => console.log(texture._texture?.width));
-    console.log('new scene');
-    newScene.textures.map(texture => console.log(texture._texture?.width));
-
     return newScene;
   }
 

package/src/api/util/globalTypes.ts

@@ -480,6 +480,11 @@ interface IExportOptionsExtended extends IExportOptions {
    * mode settings.
    */
   exchangeRefractionMaterials?: boolean;
+  /**
+   * iOS devices crash when exporting textures which are larger than 1024.\
+   * If this flag is set, then all textures will be limited to a maximum texture size of 1024.
+   */
+  limitTextureSize?: boolean;
 }
 
 type SpecGenerationData = {