@combeenation/3d-viewer 5.1.0-rc3 → 5.1.0-rc4

package/src/api/util/sceneLoaderHelper.ts

@@ -4,6 +4,9 @@ import { AssetContainer } from '@babylonjs/core/assetContainer';
 import { injectNodeMetadata } from './babylonHelper';
 import has from 'lodash-es/has';
 import { Material } from '@babylonjs/core/Materials/material';
+import { InstancedMesh } from '@babylonjs/core/Meshes/instancedMesh';
+import { Nullable } from '@babylonjs/core/types';
+import { Node as BjsNode } from '@babylonjs/core/node'; //! overload DOM API Node due to name-clash with BJS
 
 const missingMaterialMetadataName = 'missingMaterial';
 
@@ -43,7 +46,7 @@ const getCustomCbnBabylonLoaderPlugin = function (previousLoaderPlugin: ISceneLo
  */
 const getMaterialPostLoadObserver = function (targetMeshOrInstance: AbstractMesh, concerningMesh: Mesh) {
   return (_eventData: any, _eventState: any) => {
-    const hasBeenEnabled = targetMeshOrInstance.isEnabled(true);
+    const hasBeenEnabled = concerningMesh.isEnabled(true);
     const materialMissing = has(concerningMesh.metadata, missingMaterialMetadataName);
     if (!hasBeenEnabled || !materialMissing) return;
     // get id of missing material
@@ -83,6 +86,44 @@ const addMissingMaterialMetadata = function (dataParsed: any, container: AssetCo
   });
 };
 
+/**
+ * Adds an "onEnabledStateChanged" observer to the given mesh and all its parents:
+ * The added observer (`getMaterialPostLoadObserver`) handles creation of missing materials once the given node is
+ * enabled.
+ */
+const addMissingMaterialObserver = function (node: BjsNode) {
+  // set the concerning node, i.e. the node the observer should check for missing material.
+  // for instanced meshes, we want the sourcemesh here.
+  const concerningNode = node instanceof InstancedMesh ? node.sourceMesh : (node as Mesh);
+
+  // observer is pointless if concerning node has no missing material
+  if (!has(concerningNode.metadata, missingMaterialMetadataName)) return;
+
+  // for each of our AbstractMeshes, set an observer on the AbstractMesh itself and all of its parents.
+  let currNode: Nullable<BjsNode> = node;
+  while (currNode) {
+    // Note HAR: Using `addOnce` could be wrong in certain situations.
+    // E.g.:
+    //   * 2 meshes `parentMesh` & `parentMesh.concerningMesh`
+    //   * `concerningMesh` is having the missing material flag
+    //   * Both `parentMesh` & `concerningMesh` are disabled
+    //   * `parentMesh` is enabled -> material should **not** be created as `concerningMesh` is still disabled
+    //   * `parentMesh` is disabled
+    //   * `concerningMesh` is enabled -> material should **not** be created as `concerningMesh` is still invisible
+    //     because its `parentMesh` is ATM disabled
+    //   * `parentMesh` & `concerningMesh` are both enable
+    //     -> material should be created as `concerningMesh` is now actually visible but it isn't, as all observers were
+    //        only fired once 🔥
+    //
+    // However: Using `add` instead of `addOnce` requires rather complicated manual clean up work...
+
+    // add observer. needed only once per node, hence addOnce()
+    node.onEnabledStateChangedObservable.addOnce(getMaterialPostLoadObserver(currNode as AbstractMesh, concerningNode));
+    // console.log('## observer set on: ' + meshOrInstance.name);
+    currNode = currNode.parent;
+  }
+};
+
 /**
  * Look up the provided materials (see library import) and create and return one if found.
  * @param materialId BabylonJs material-id. E.g. 'concrete".
@@ -98,4 +139,9 @@ export const getMaterialFromCbnAssets = function (materialId: string, scene: Sce
   return material || null;
 };
 
-export { getCustomCbnBabylonLoaderPlugin, getMaterialPostLoadObserver, missingMaterialMetadataName };
+export {
+  getCustomCbnBabylonLoaderPlugin,
+  getMaterialPostLoadObserver,
+  missingMaterialMetadataName,
+  addMissingMaterialObserver,
+};