@combeenation/3d-viewer 12.4.0-alpha1 → 12.4.1-beta1

package/package.json

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

package/src/api/classes/viewer.ts

@@ -676,7 +676,7 @@ The inspector can only be used in development builds.`);
       engine.getCaps().maxTextureSize = (sceneJson.engine!.limitTextureSize as LimitTextureSizeConfig).size;
     }
 
-    if (!sceneJson.engine?.useParallelShaderCompile) {
+    if (sceneJson.engine?.useParallelShaderCompile === false) {
       engine.getCaps().parallelShaderCompile = undefined;
     }
 

package/src/api/manager/gltfExportManager.ts

@@ -4,6 +4,7 @@ import { getIsScaledDownDevice } from '../util/deviceHelper';
 import { bakeGeometryOfMesh, createMeshFromInstancedMesh, resetTransformation } from '../util/geometryHelper';
 import { isNodeIncludedInExclusionList } from '../util/structureHelper';
 import { PBRMaterial } from '@babylonjs/core/Materials/PBR/pbrMaterial';
+import { DynamicTexture } from '@babylonjs/core/Materials/Textures/dynamicTexture';
 import { RenderTargetTexture } from '@babylonjs/core/Materials/Textures/renderTargetTexture';
 import { Vector3 } from '@babylonjs/core/Maths/math.vector';
 import { InstancedMesh } from '@babylonjs/core/Meshes/instancedMesh';
@@ -292,20 +293,42 @@ export class GltfExportManager {
   /**
    * Creates a clone of the material which should be used for the export.
    * This is mostly required for recreating textures with lower sizes.
-   * Also refraction fixes will be applied.
+   * CAUTION: Material exchanging is not supported for materials that contain certain texture types:
+   * - Dynamic textures (Paintables): Cloning dynamic textures doesn't clone the canvas context
+   *   => so the clone is just empty
+   * - Render target textures: Disposing the clone will leave the scene in a "not ready" state
+   *   => this scenario is not fully analyzed yet, but it's not really worth the effort right now, since this kind of
+   *      of texture is not really used ATM
+   *
+   * dynamic textures (paintables) or render
+   * target textures, as there are speci
    */
   protected static _exchangeMaterial(material: Material) {
+    const baseTextures = material.getActiveTextures();
+    const hasDynamicTextures = baseTextures.some(texture => texture instanceof DynamicTexture);
+    const hasRenderTargetTextures = baseTextures.some(texture => texture instanceof RenderTargetTexture);
+    if (hasDynamicTextures || hasRenderTargetTextures) {
+      const textureTypesString = [
+        hasDynamicTextures ? 'Dynamic Textures' : '',
+        hasRenderTargetTextures ? 'Render Target Textures' : '',
+      ]
+        .filter(Boolean)
+        .join();
+      console.warn(
+        `Couldn't exchange material "${material.name}" in GLB export, as it contains unsupported texture type(s) (${textureTypesString}). The export will still work, but the textures of this material will keep their original size.`
+      );
+
+      return;
+    }
+
     const newName = `${material.name}_clone`;
     const clonedMaterial = material.clone(newName)!;
+    const clonedTextures = clonedMaterial.getActiveTextures();
 
     // mark all exported textures, so that they will be deleted after the export
-    // CAUTION: disposing `RenderTargetTextures` will leave the scene in a "not ready" state
-    // I haven't found a solution for this in a certain time, so I'd just leave the in the scene, there are not used
-    // anyway since their parent material is disposed
-    clonedMaterial
-      .getActiveTextures()
-      .filter(texture => !(texture instanceof RenderTargetTexture))
-      .forEach(texture => injectMetadata(texture, { [GltfExportManager._METADATA_PROPS.deleteAfterExport]: true }));
+    clonedTextures.forEach(texture =>
+      injectMetadata(texture, { [GltfExportManager._METADATA_PROPS.deleteAfterExport]: true })
+    );
 
     injectMetadata(material, { [GltfExportManager._METADATA_PROPS.exchangeMaterialWith]: clonedMaterial.uniqueId });
     injectMetadata(clonedMaterial, { [GltfExportManager._METADATA_PROPS.deleteAfterExport]: true });

package/src/api/util/globalTypes.ts

@@ -206,10 +206,11 @@ type SceneJson = {
     limitTextureSize?: LimitTextureSizeConfig | false;
     /**
      * See this forum entry for description of parallel shader compilition effect:
-     * https://forum.babylonjs.com/t/scene-flickering-when-turning-off-light/48733
-     * Having it deactivated tends to be benefitial when switching lights and materials in static scenarios, whereas
-     * parallel shading compilition helps when doing these kind of switches while objects are moving (eg: animations).
-     * It's deactivated by default but can be overwritten with this flag.
+     * https://forum.babylonjs.com/t/scene-flickering-when-turning-off-light/48733.
+     * Parallel shading compilition generally improves the speed of material compilition and helps when switching
+     * materials while objects are moving (eg: animations).
+     * Deactivating parallel shading compilition is benefitial when switching lights and materials in static scenarios.
+     * It's activated by default due to compatibility reasons but can be overwritten with this flag.
      */
     useParallelShaderCompile?: boolean;
   };