@combeenation/3d-viewer 14.0.1-rc1 → 15.0.0

package/src/internal/cbn-custom-babylon-loader-plugin.ts

@@ -1,159 +1,159 @@
-import { AssetContainer, ISceneLoaderPlugin, InstancedMesh, Scene, SceneLoader } from '../index';
-import { cloneMorphTargetManager } from './cloning-helper';
-import { setInternalMetadataValue } from './metadata-helper';
-import { deleteAllTags, getTags, setTagsAsString } from './tags-helper';
-import { isArray, isString } from 'lodash-es';
-
-/**
- * Create and return a custom loader plugin to be registered with SceneLoader, that allows
- * us to run our own code against the input data before using the standard procedure to
- * import.
- * The main use case is to mark missing material in meshes, which will get loaded on demand at the first time the
- * dedicated mesh gets visible.
- * This is the case if the babylon file is a Combeenation "3d asset" which comes without materials, as the materials
- * are defined as "material assets".
- */
-export function registerCustomCbnBabylonLoaderPlugin(): void {
-  // get original plugin for babylon files
-  // we only want to manipulate Combeenation 3d assets, which are represented as babylon files
-  // the plugin is not used for GLB files, "local" babylon are also not really affected by this plugin
-  const previousLoaderPlugin = SceneLoader.GetPluginForExtension('.babylon') as ISceneLoaderPlugin;
-
-  const customLoader: ISceneLoaderPlugin = {
-    name: 'cbnCustomBabylonLoader',
-    extensions: '.babylon',
-    importMesh: previousLoaderPlugin.importMesh,
-    load: previousLoaderPlugin.load,
-    loadAssetContainer: function (scene, data, rootUrl, onError) {
-      // temporarily remove all morph target managers from scene before loading the model to avoid clashes with existing
-      // unique ids => see CB-9928
-      // NOTE: morph target managers still exist on the dedicated mesh when getting removed from the scene, only
-      // `scene.getMorphTargetManagerById` is affected, which is used internally in the `loadAssetContainer` function
-      const curMorphTargetManagers = scene.morphTargetManagers;
-      scene.morphTargetManagers = [];
-
-      const dataParsed = JSON.parse(data);
-      const importedContainer = previousLoaderPlugin.loadAssetContainer(scene, data, rootUrl);
-
-      _addMissingMaterialMetadata(dataParsed, importedContainer);
-      _reconstructTagsForInstancedMeshes(dataParsed, importedContainer);
-      _unifyMorphTargetManagerIds(importedContainer, scene);
-
-      // restore existing morph target managers
-      scene.morphTargetManagers.push(...curMorphTargetManagers);
-
-      return importedContainer;
-    },
-  };
-
-  SceneLoader.RegisterPlugin(customLoader);
-}
-
-type InstanceData = {
-  name: string;
-  tags?: string;
-};
-
-function _isMeshInstanceData(data: any): data is InstanceData {
-  const hasName = isString(data.name);
-  const hasValidTags = !data.tags || isString(data.tags);
-  return hasName && hasValidTags;
-}
-
-type MeshData = {
-  name: string;
-  materialId?: string;
-  instances?: unknown[];
-};
-
-function _isMeshData(data: any): data is MeshData {
-  const hasName = isString(data.name);
-  const hasValidMaterialId = !data.materialId || isString(data.materialId);
-
-  return hasName && hasValidMaterialId;
-}
-
-type DataWithMeshes = { meshes: unknown[] };
-
-function _isDataWithMeshes(data: any): data is DataWithMeshes {
-  return data && isArray(data.meshes);
-}
-
-/**
- * Internal function that compares the original meshes on a .babylon file with what was loaded,
- * and tags missing materials with respective metadata on respective meshes.
- * @param dataParsed original data
- * @param container  loaded data
- */
-function _addMissingMaterialMetadata(dataParsed: unknown, container: AssetContainer): void {
-  if (!_isDataWithMeshes(dataParsed)) return;
-
-  const validatedMeshes = dataParsed.meshes.filter(_isMeshData);
-
-  container.meshes.forEach(importedMesh => {
-    const parsedMesh = validatedMeshes.find(mesh => mesh.name === importedMesh.name);
-
-    const materialOnImportedMesh = importedMesh.material?.id;
-    const materialOnOriginalMesh = parsedMesh?.materialId;
-
-    if (materialOnOriginalMesh && materialOnImportedMesh !== materialOnOriginalMesh) {
-      window.Cbn?.Assets.assertMaterialExists(materialOnOriginalMesh);
-      setInternalMetadataValue(importedMesh, 'deferredMaterial', materialOnOriginalMesh);
-    }
-  });
-}
-
-/**
- * Help function for manipulating tags of instances meshes after parsing.
- * Per default babylon attaches the tags of the source mesh to the instance, **but only** if no tags are set for the
- * instanced mesh. If the instanced mesh has dedicated tags set, the ones from the source mesh are **not** copied over.
- * In this case it's not possible to have tags on the source mesh but not on the instance, which is a problem with our
- * tagging system in the viewer and the Combeenation asset editor as well.
- * This function rejects the default tag import algorithm and just copies the tags of the original parsed node without
- * any parent synchronization.
- *
- * @param dataParsed original data
- * @param container  loaded data
- */
-function _reconstructTagsForInstancedMeshes(dataParsed: unknown, container: AssetContainer): void {
-  if (!_isDataWithMeshes(dataParsed)) return;
-
-  const validatedMeshes = dataParsed.meshes.filter(_isMeshData);
-
-  container.meshes.forEach(importedMesh => {
-    if (importedMesh instanceof InstancedMesh) {
-      // remove all tags from the imported mesh if there are some, since these tags are probably coming from the
-      // source mesh, if no tags are set there is no need for further operation though
-      const hasTags = getTags(importedMesh);
-      if (hasTags) {
-        deleteAllTags(importedMesh);
-
-        // get tags of parsed instanced mesh and set them on the imported instanced mesh
-        const parsedSourceMesh = validatedMeshes.find(mesh => mesh.name === importedMesh.sourceMesh.name);
-        const validatedSourceMeshInstances = parsedSourceMesh?.instances?.filter(_isMeshInstanceData);
-        const parsedInstancedMesh = validatedSourceMeshInstances?.find(mesh => mesh.name === importedMesh.name);
-        const parsedTags = parsedInstancedMesh?.tags;
-        if (parsedTags) {
-          setTagsAsString(importedMesh, parsedTags);
-        }
-      }
-    }
-  });
-}
-
-/**
- * Morph target managers from different assets may receive the same id, which leads to erroneous morph target
- * assignments. We can't change the id, but we can create a clone which then creates a new unique id.
- */
-function _unifyMorphTargetManagerIds(container: AssetContainer, scene: Scene): void {
-  [...container.morphTargetManagers].forEach(sourceMTM => {
-    const clonedMTM = cloneMorphTargetManager(sourceMTM, container);
-
-    // clone function adds morph target manager to scene right, which we don't want here as we are only loading the
-    // asset container
-    scene.removeMorphTargetManager(clonedMTM);
-
-    // original morph target manager with bad id is not needed anymore and can be disposed
-    sourceMTM.dispose();
-  });
-}
+import { AssetContainer, ISceneLoaderPlugin, InstancedMesh, Scene, SceneLoader } from '../index';
+import { cloneMorphTargetManager } from './cloning-helper';
+import { setInternalMetadataValue } from './metadata-helper';
+import { deleteAllTags, getTags, setTagsAsString } from './tags-helper';
+import { isArray, isString } from 'lodash-es';
+
+/**
+ * Create and return a custom loader plugin to be registered with SceneLoader, that allows
+ * us to run our own code against the input data before using the standard procedure to
+ * import.
+ * The main use case is to mark missing material in meshes, which will get loaded on demand at the first time the
+ * dedicated mesh gets visible.
+ * This is the case if the babylon file is a Combeenation "3d asset" which comes without materials, as the materials
+ * are defined as "material assets".
+ */
+export function registerCustomCbnBabylonLoaderPlugin(): void {
+  // get original plugin for babylon files
+  // we only want to manipulate Combeenation 3d assets, which are represented as babylon files
+  // the plugin is not used for GLB files, "local" babylon are also not really affected by this plugin
+  const previousLoaderPlugin = SceneLoader.GetPluginForExtension('.babylon') as ISceneLoaderPlugin;
+
+  const customLoader: ISceneLoaderPlugin = {
+    name: 'cbnCustomBabylonLoader',
+    extensions: '.babylon',
+    importMesh: previousLoaderPlugin.importMesh,
+    load: previousLoaderPlugin.load,
+    loadAssetContainer: function (scene, data, rootUrl, onError) {
+      // temporarily remove all morph target managers from scene before loading the model to avoid clashes with existing
+      // unique ids => see CB-9928
+      // NOTE: morph target managers still exist on the dedicated mesh when getting removed from the scene, only
+      // `scene.getMorphTargetManagerById` is affected, which is used internally in the `loadAssetContainer` function
+      const curMorphTargetManagers = scene.morphTargetManagers;
+      scene.morphTargetManagers = [];
+
+      const dataParsed = JSON.parse(data as string);
+      const importedContainer = previousLoaderPlugin.loadAssetContainer(scene, data, rootUrl);
+
+      _addMissingMaterialMetadata(dataParsed, importedContainer);
+      _reconstructTagsForInstancedMeshes(dataParsed, importedContainer);
+      _unifyMorphTargetManagerIds(importedContainer, scene);
+
+      // restore existing morph target managers
+      scene.morphTargetManagers.push(...curMorphTargetManagers);
+
+      return importedContainer;
+    },
+  };
+
+  SceneLoader.RegisterPlugin(customLoader);
+}
+
+type InstanceData = {
+  name: string;
+  tags?: string;
+};
+
+function _isMeshInstanceData(data: any): data is InstanceData {
+  const hasName = isString(data.name);
+  const hasValidTags = !data.tags || isString(data.tags);
+  return hasName && hasValidTags;
+}
+
+type MeshData = {
+  name: string;
+  materialId?: string;
+  instances?: unknown[];
+};
+
+function _isMeshData(data: any): data is MeshData {
+  const hasName = isString(data.name);
+  const hasValidMaterialId = !data.materialId || isString(data.materialId);
+
+  return hasName && hasValidMaterialId;
+}
+
+type DataWithMeshes = { meshes: unknown[] };
+
+function _isDataWithMeshes(data: any): data is DataWithMeshes {
+  return data && isArray(data.meshes);
+}
+
+/**
+ * Internal function that compares the original meshes on a .babylon file with what was loaded,
+ * and tags missing materials with respective metadata on respective meshes.
+ * @param dataParsed original data
+ * @param container  loaded data
+ */
+function _addMissingMaterialMetadata(dataParsed: unknown, container: AssetContainer): void {
+  if (!_isDataWithMeshes(dataParsed)) return;
+
+  const validatedMeshes = dataParsed.meshes.filter(_isMeshData);
+
+  container.meshes.forEach(importedMesh => {
+    const parsedMesh = validatedMeshes.find(mesh => mesh.name === importedMesh.name);
+
+    const materialOnImportedMesh = importedMesh.material?.id;
+    const materialOnOriginalMesh = parsedMesh?.materialId;
+
+    if (materialOnOriginalMesh && materialOnImportedMesh !== materialOnOriginalMesh) {
+      window.Cbn?.Assets.assertMaterialExists(materialOnOriginalMesh);
+      setInternalMetadataValue(importedMesh, 'deferredMaterial', materialOnOriginalMesh);
+    }
+  });
+}
+
+/**
+ * Help function for manipulating tags of instances meshes after parsing.
+ * Per default babylon attaches the tags of the source mesh to the instance, **but only** if no tags are set for the
+ * instanced mesh. If the instanced mesh has dedicated tags set, the ones from the source mesh are **not** copied over.
+ * In this case it's not possible to have tags on the source mesh but not on the instance, which is a problem with our
+ * tagging system in the viewer and the Combeenation asset editor as well.
+ * This function rejects the default tag import algorithm and just copies the tags of the original parsed node without
+ * any parent synchronization.
+ *
+ * @param dataParsed original data
+ * @param container  loaded data
+ */
+function _reconstructTagsForInstancedMeshes(dataParsed: unknown, container: AssetContainer): void {
+  if (!_isDataWithMeshes(dataParsed)) return;
+
+  const validatedMeshes = dataParsed.meshes.filter(_isMeshData);
+
+  container.meshes.forEach(importedMesh => {
+    if (importedMesh instanceof InstancedMesh) {
+      // remove all tags from the imported mesh if there are some, since these tags are probably coming from the
+      // source mesh, if no tags are set there is no need for further operation though
+      const hasTags = getTags(importedMesh);
+      if (hasTags) {
+        deleteAllTags(importedMesh);
+
+        // get tags of parsed instanced mesh and set them on the imported instanced mesh
+        const parsedSourceMesh = validatedMeshes.find(mesh => mesh.name === importedMesh.sourceMesh.name);
+        const validatedSourceMeshInstances = parsedSourceMesh?.instances?.filter(_isMeshInstanceData);
+        const parsedInstancedMesh = validatedSourceMeshInstances?.find(mesh => mesh.name === importedMesh.name);
+        const parsedTags = parsedInstancedMesh?.tags;
+        if (parsedTags) {
+          setTagsAsString(importedMesh, parsedTags);
+        }
+      }
+    }
+  });
+}
+
+/**
+ * Morph target managers from different assets may receive the same id, which leads to erroneous morph target
+ * assignments. We can't change the id, but we can create a clone which then creates a new unique id.
+ */
+function _unifyMorphTargetManagerIds(container: AssetContainer, scene: Scene): void {
+  [...container.morphTargetManagers].forEach(sourceMTM => {
+    const clonedMTM = cloneMorphTargetManager(sourceMTM, container);
+
+    // clone function adds morph target manager to scene right, which we don't want here as we are only loading the
+    // asset container
+    scene.removeMorphTargetManager(clonedMTM);
+
+    // original morph target manager with bad id is not needed anymore and can be disposed
+    sourceMTM.dispose();
+  });
+}