@combeenation/3d-viewer 12.4.1 → 12.4.3

package/dist/lib-cjs/api/util/sceneLoaderHelper.d.ts

@@ -1,58 +1,58 @@
-import { ISceneLoaderPlugin } from '@babylonjs/core/Loading/sceneLoader';
-import { Material } from '@babylonjs/core/Materials/material';
-import { AssetContainer } from '@babylonjs/core/assetContainer';
-import { Node as BjsNode } from '@babylonjs/core/node';
-import { Scene } from '@babylonjs/core/scene';
-export declare const missingMaterialMetadataName = "missingMaterial";
-export declare const parsedMaterialIdMetadataName = "parsedMaterialId";
-/**
- * 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.
- * @param previousLoaderPlugin the actual loader that's executed after manipulating the input data
- * @returns Custom loader plugin to be registered with SceneLoader.RegisterPlugin()
- */
-export declare const getCustomCbnBabylonLoaderPlugin: (previousLoaderPlugin: ISceneLoaderPlugin) => ISceneLoaderPlugin;
-/**
- * Return an observer to be applied to meshes in order to post-load missing materials
- * upon set enabled/visible.
- *
- * @param concerningMesh Mesh to look for missing materials on, and create/apply to (when found).
- * @returns observer
- */
-export declare const getMaterialPostLoadObserver: (concerningMesh: Mesh) => () => Promise<void>;
-/**
- * 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
- */
-export declare const addMissingMaterialMetadata: (dataParsed: unknown, container: AssetContainer) => void;
-/**
- * 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
- */
-export declare const reconstructTagsForInstancedMeshes: (dataParsed: unknown, container: AssetContainer) => void;
-/**
- * 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.
- */
-export declare const addMissingMaterialObserver: (node: BjsNode) => void;
-export declare const removeMissingMaterialObserver: (node: BjsNode) => void;
-/**
- * Look up the provided materials (see library import) and create and return one if found.
- *
- * @param materialId Babylon.js material-id. E.g. 'concrete".
- * @param scene Babylon.js scene
- * @returns PBRMaterial | null
- */
-export declare const createMaterialFromCbnAssets: (materialId: string, scene: Scene) => Promise<Material | null>;
+import { ISceneLoaderPlugin } from '@babylonjs/core/Loading/sceneLoader';
+import { Material } from '@babylonjs/core/Materials/material';
+import { AssetContainer } from '@babylonjs/core/assetContainer';
+import { Node as BjsNode } from '@babylonjs/core/node';
+import { Scene } from '@babylonjs/core/scene';
+export declare const missingMaterialMetadataName = "missingMaterial";
+export declare const parsedMaterialIdMetadataName = "parsedMaterialId";
+/**
+ * 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.
+ * @param previousLoaderPlugin the actual loader that's executed after manipulating the input data
+ * @returns Custom loader plugin to be registered with SceneLoader.RegisterPlugin()
+ */
+export declare const getCustomCbnBabylonLoaderPlugin: (previousLoaderPlugin: ISceneLoaderPlugin) => ISceneLoaderPlugin;
+/**
+ * Return an observer to be applied to meshes in order to post-load missing materials
+ * upon set enabled/visible.
+ *
+ * @param concerningMesh Mesh to look for missing materials on, and create/apply to (when found).
+ * @returns observer
+ */
+export declare const getMaterialPostLoadObserver: (concerningMesh: Mesh) => () => Promise<void>;
+/**
+ * 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
+ */
+export declare const addMissingMaterialMetadata: (dataParsed: unknown, container: AssetContainer) => void;
+/**
+ * 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
+ */
+export declare const reconstructTagsForInstancedMeshes: (dataParsed: unknown, container: AssetContainer) => void;
+/**
+ * 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.
+ */
+export declare const addMissingMaterialObserver: (node: BjsNode) => void;
+export declare const removeMissingMaterialObserver: (node: BjsNode) => void;
+/**
+ * Look up the provided materials (see library import) and create and return one if found.
+ *
+ * @param materialId Babylon.js material-id. E.g. 'concrete".
+ * @param scene Babylon.js scene
+ * @returns PBRMaterial | null
+ */
+export declare const createMaterialFromCbnAssets: (materialId: string, scene: Scene) => Promise<Material | null>;

package/dist/lib-cjs/api/util/sceneLoaderHelper.js

@@ -1,229 +1,229 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createMaterialFromCbnAssets = exports.removeMissingMaterialObserver = exports.addMissingMaterialObserver = exports.reconstructTagsForInstancedMeshes = exports.addMissingMaterialMetadata = exports.getMaterialPostLoadObserver = exports.getCustomCbnBabylonLoaderPlugin = exports.parsedMaterialIdMetadataName = exports.missingMaterialMetadataName = void 0;
-const event_1 = require("../classes/event");
-const babylonHelper_1 = require("./babylonHelper");
-const resourceHelper_1 = require("./resourceHelper");
-const material_1 = require("@babylonjs/core/Materials/material");
-const instancedMesh_1 = require("@babylonjs/core/Meshes/instancedMesh");
-const tags_1 = require("@babylonjs/core/Misc/tags");
-const lodash_es_1 = require("lodash-es");
-const has_1 = __importDefault(require("lodash-es/has"));
-// map for keeping track of active "node enable" observers
-const enableObserverMap = {};
-exports.missingMaterialMetadataName = 'missingMaterial';
-exports.parsedMaterialIdMetadataName = 'parsedMaterialId';
-/**
- * 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.
- * @param previousLoaderPlugin the actual loader that's executed after manipulating the input data
- * @returns Custom loader plugin to be registered with SceneLoader.RegisterPlugin()
- */
-const getCustomCbnBabylonLoaderPlugin = function (previousLoaderPlugin) {
-    const customLoader = {
-        name: 'cbnCustomBabylonLoader',
-        extensions: '.babylon',
-        importMesh: previousLoaderPlugin.importMesh,
-        load: previousLoaderPlugin.load,
-        loadAssetContainer: function (scene, data, rootUrl, onError) {
-            //* 1) --- manipulate ORIGINAL data
-            const dataParsed = JSON.parse(data);
-            //* 2) --- call default (non-custom) loading method
-            const importedContainer = previousLoaderPlugin.loadAssetContainer(scene, data, rootUrl);
-            //* 3) --- manipulate IMPORTED data
-            (0, exports.addMissingMaterialMetadata)(dataParsed, importedContainer);
-            (0, exports.reconstructTagsForInstancedMeshes)(dataParsed, importedContainer);
-            //* 4) --- return imported data
-            return importedContainer;
-        },
-    };
-    return customLoader;
-};
-exports.getCustomCbnBabylonLoaderPlugin = getCustomCbnBabylonLoaderPlugin;
-/**
- * Return an observer to be applied to meshes in order to post-load missing materials
- * upon set enabled/visible.
- *
- * @param concerningMesh Mesh to look for missing materials on, and create/apply to (when found).
- * @returns observer
- */
-const getMaterialPostLoadObserver = function (concerningMesh) {
-    return () => __awaiter(this, void 0, void 0, function* () {
-        var _a;
-        const scene = concerningMesh.getScene();
-        // can't check `isEnabled` immediatly, since the enabled state of parents and childs is not synced yet
-        // postpone one cycle to ensure a correct parent-child enable relation
-        yield (0, resourceHelper_1.sleep)(0);
-        const hasBeenEnabled = concerningMesh.isEnabled(true);
-        const materialMissing = (0, has_1.default)(concerningMesh.metadata, exports.missingMaterialMetadataName);
-        if (!hasBeenEnabled || !materialMissing)
-            return;
-        // get id of missing material
-        const missingMatId = concerningMesh.metadata[exports.missingMaterialMetadataName];
-        // get material and apply it on the concerning mesh after all textures have been loaded
-        const material = yield (0, babylonHelper_1.getOrCreateMaterial)(concerningMesh.getScene(), missingMatId);
-        (0, babylonHelper_1.applyMaterial)(material, concerningMesh).then(() => event_1.emitter.emit(event_1.Event.MESH_MATERIAL_APPLIED, concerningMesh, material));
-        // since the material is there now, we do not need the related metadata tag anymore
-        delete concerningMesh.metadata[exports.missingMaterialMetadataName];
-        // remove all "enable" observers that were assigned to the concerning mesh
-        // the mesh got visible and therefore the observers are not needed anymore
-        (_a = enableObserverMap[concerningMesh.id]) === null || _a === void 0 ? void 0 : _a.forEach(entry => {
-            const currNode = scene.getMeshById(entry.currNodeId);
-            currNode === null || currNode === void 0 ? void 0 : currNode.onEnabledStateChangedObservable.remove(entry.observer);
-        });
-        // also remove from the local observer map
-        delete enableObserverMap[concerningMesh.id];
-    });
-};
-exports.getMaterialPostLoadObserver = getMaterialPostLoadObserver;
-function _isMeshInstanceData(data) {
-    const hasName = (0, lodash_es_1.isString)(data.name);
-    const hasValidTags = !data.tags || (0, lodash_es_1.isString)(data.tags);
-    return hasName && hasValidTags;
-}
-function _isMeshData(data) {
-    const hasName = (0, lodash_es_1.isString)(data.name);
-    const hasValidMaterialId = !data.materialId || (0, lodash_es_1.isString)(data.materialId);
-    return hasName && hasValidMaterialId;
-}
-function _isDataWithMeshes(data) {
-    return data && (0, lodash_es_1.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
- */
-const addMissingMaterialMetadata = function (dataParsed, container) {
-    if (!_isDataWithMeshes(dataParsed))
-        return;
-    const validatedMeshes = dataParsed.meshes.filter(_isMeshData);
-    container.meshes.forEach(importedMesh => {
-        var _a, _b;
-        const parsedMesh = validatedMeshes.find(mesh => mesh.name === importedMesh.name);
-        // save original material id of the imported babylon or GLB file
-        (0, babylonHelper_1.injectMetadata)(importedMesh, { [exports.parsedMaterialIdMetadataName]: parsedMesh === null || parsedMesh === void 0 ? void 0 : parsedMesh.materialId }, false);
-        const materialOnImportedMesh = (_a = importedMesh.material) === null || _a === void 0 ? void 0 : _a.id;
-        const materialOnOriginalMesh = parsedMesh === null || parsedMesh === void 0 ? void 0 : parsedMesh.materialId;
-        if (materialOnOriginalMesh && materialOnImportedMesh !== materialOnOriginalMesh) {
-            (_b = window.Cbn) === null || _b === void 0 ? void 0 : _b.Assets.assertMaterialExists(materialOnOriginalMesh);
-            (0, babylonHelper_1.injectMetadata)(importedMesh, { [exports.missingMaterialMetadataName]: materialOnOriginalMesh }, false);
-        }
-    });
-};
-exports.addMissingMaterialMetadata = addMissingMaterialMetadata;
-/**
- * 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
- */
-const reconstructTagsForInstancedMeshes = function (dataParsed, container) {
-    if (!_isDataWithMeshes(dataParsed))
-        return;
-    const validatedMeshes = dataParsed.meshes.filter(_isMeshData);
-    container.meshes.forEach(importedMesh => {
-        var _a;
-        if (importedMesh instanceof instancedMesh_1.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 importedTags = tags_1.Tags.GetTags(importedMesh);
-            if (importedTags) {
-                tags_1.Tags.RemoveTagsFrom(importedMesh, importedTags);
-                // 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 = (_a = parsedSourceMesh === null || parsedSourceMesh === void 0 ? void 0 : parsedSourceMesh.instances) === null || _a === void 0 ? void 0 : _a.filter(_isMeshInstanceData);
-                const parsedInstancedMesh = validatedSourceMeshInstances === null || validatedSourceMeshInstances === void 0 ? void 0 : validatedSourceMeshInstances.find(mesh => mesh.name === importedMesh.name);
-                const parsedTags = parsedInstancedMesh === null || parsedInstancedMesh === void 0 ? void 0 : parsedInstancedMesh.tags;
-                if (parsedTags) {
-                    tags_1.Tags.AddTagsTo(importedMesh, parsedTags);
-                }
-            }
-        }
-    });
-};
-exports.reconstructTagsForInstancedMeshes = reconstructTagsForInstancedMeshes;
-/**
- * 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) {
-    // 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_1.InstancedMesh ? node.sourceMesh : node;
-    // observer is pointless if concerning node has no missing material
-    if (!(0, has_1.default)(concerningNode.metadata, exports.missingMaterialMetadataName))
-        return;
-    // for each of our AbstractMeshes, set an observer on the AbstractMesh itself and all of its parents.
-    let currNode = node;
-    while (currNode) {
-        const callback = (0, exports.getMaterialPostLoadObserver)(concerningNode);
-        const observer = currNode.onEnabledStateChangedObservable.add(callback);
-        // store the observer in a local map to keep track of the active "enable" observers
-        // observers will be removed when the concerning node gets enabled
-        if (!enableObserverMap[concerningNode.id]) {
-            enableObserverMap[concerningNode.id] = [];
-        }
-        enableObserverMap[concerningNode.id].push({ currNodeId: currNode.id, observer });
-        currNode = currNode.parent;
-    }
-};
-exports.addMissingMaterialObserver = addMissingMaterialObserver;
-const removeMissingMaterialObserver = function (node) {
-    var _a;
-    // 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_1.InstancedMesh ? node.sourceMesh : node;
-    let currNode = node;
-    while (currNode) {
-        (_a = enableObserverMap[concerningNode.id]) === null || _a === void 0 ? void 0 : _a.forEach(entry => {
-            if (entry.currNodeId === (currNode === null || currNode === void 0 ? void 0 : currNode.id)) {
-                currNode.onEnabledStateChangedObservable.remove(entry.observer);
-            }
-        });
-        currNode = currNode.parent;
-    }
-    delete enableObserverMap[concerningNode.id];
-};
-exports.removeMissingMaterialObserver = removeMissingMaterialObserver;
-/**
- * Look up the provided materials (see library import) and create and return one if found.
- *
- * @param materialId Babylon.js material-id. E.g. 'concrete".
- * @param scene Babylon.js scene
- * @returns PBRMaterial | null
- */
-const createMaterialFromCbnAssets = function (materialId, scene) {
-    var _a;
-    return __awaiter(this, void 0, void 0, function* () {
-        const materialDefinition = yield ((_a = window.Cbn) === null || _a === void 0 ? void 0 : _a.Assets.getMaterial(materialId));
-        // The generic `Material.Parse` actually returns a more specific material like `BABYLON.StandardMaterial`,
-        // `BABYLON.PBRMaterial` or stuff like `BABYLON.PBRMetallicRoughnessMaterial` etc. based on the given `customType`
-        // within the material JSON definition
-        const material = materialDefinition && material_1.Material.Parse(materialDefinition, scene, '');
-        return material || null;
-    });
-};
-exports.createMaterialFromCbnAssets = createMaterialFromCbnAssets;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMaterialFromCbnAssets = exports.removeMissingMaterialObserver = exports.addMissingMaterialObserver = exports.reconstructTagsForInstancedMeshes = exports.addMissingMaterialMetadata = exports.getMaterialPostLoadObserver = exports.getCustomCbnBabylonLoaderPlugin = exports.parsedMaterialIdMetadataName = exports.missingMaterialMetadataName = void 0;
+const event_1 = require("../classes/event");
+const babylonHelper_1 = require("./babylonHelper");
+const resourceHelper_1 = require("./resourceHelper");
+const material_1 = require("@babylonjs/core/Materials/material");
+const instancedMesh_1 = require("@babylonjs/core/Meshes/instancedMesh");
+const tags_1 = require("@babylonjs/core/Misc/tags");
+const lodash_es_1 = require("lodash-es");
+const has_1 = __importDefault(require("lodash-es/has"));
+// map for keeping track of active "node enable" observers
+const enableObserverMap = {};
+exports.missingMaterialMetadataName = 'missingMaterial';
+exports.parsedMaterialIdMetadataName = 'parsedMaterialId';
+/**
+ * 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.
+ * @param previousLoaderPlugin the actual loader that's executed after manipulating the input data
+ * @returns Custom loader plugin to be registered with SceneLoader.RegisterPlugin()
+ */
+const getCustomCbnBabylonLoaderPlugin = function (previousLoaderPlugin) {
+    const customLoader = {
+        name: 'cbnCustomBabylonLoader',
+        extensions: '.babylon',
+        importMesh: previousLoaderPlugin.importMesh,
+        load: previousLoaderPlugin.load,
+        loadAssetContainer: function (scene, data, rootUrl, onError) {
+            //* 1) --- manipulate ORIGINAL data
+            const dataParsed = JSON.parse(data);
+            //* 2) --- call default (non-custom) loading method
+            const importedContainer = previousLoaderPlugin.loadAssetContainer(scene, data, rootUrl);
+            //* 3) --- manipulate IMPORTED data
+            (0, exports.addMissingMaterialMetadata)(dataParsed, importedContainer);
+            (0, exports.reconstructTagsForInstancedMeshes)(dataParsed, importedContainer);
+            //* 4) --- return imported data
+            return importedContainer;
+        },
+    };
+    return customLoader;
+};
+exports.getCustomCbnBabylonLoaderPlugin = getCustomCbnBabylonLoaderPlugin;
+/**
+ * Return an observer to be applied to meshes in order to post-load missing materials
+ * upon set enabled/visible.
+ *
+ * @param concerningMesh Mesh to look for missing materials on, and create/apply to (when found).
+ * @returns observer
+ */
+const getMaterialPostLoadObserver = function (concerningMesh) {
+    return () => __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        const scene = concerningMesh.getScene();
+        // can't check `isEnabled` immediatly, since the enabled state of parents and childs is not synced yet
+        // postpone one cycle to ensure a correct parent-child enable relation
+        yield (0, resourceHelper_1.sleep)(0);
+        const hasBeenEnabled = concerningMesh.isEnabled(true);
+        const materialMissing = (0, has_1.default)(concerningMesh.metadata, exports.missingMaterialMetadataName);
+        if (!hasBeenEnabled || !materialMissing)
+            return;
+        // get id of missing material
+        const missingMatId = concerningMesh.metadata[exports.missingMaterialMetadataName];
+        // get material and apply it on the concerning mesh after all textures have been loaded
+        const material = yield (0, babylonHelper_1.getOrCreateMaterial)(concerningMesh.getScene(), missingMatId);
+        (0, babylonHelper_1.applyMaterial)(material, concerningMesh).then(() => event_1.emitter.emit(event_1.Event.MESH_MATERIAL_APPLIED, concerningMesh, material));
+        // since the material is there now, we do not need the related metadata tag anymore
+        delete concerningMesh.metadata[exports.missingMaterialMetadataName];
+        // remove all "enable" observers that were assigned to the concerning mesh
+        // the mesh got visible and therefore the observers are not needed anymore
+        (_a = enableObserverMap[concerningMesh.id]) === null || _a === void 0 ? void 0 : _a.forEach(entry => {
+            const currNode = scene.getMeshById(entry.currNodeId);
+            currNode === null || currNode === void 0 ? void 0 : currNode.onEnabledStateChangedObservable.remove(entry.observer);
+        });
+        // also remove from the local observer map
+        delete enableObserverMap[concerningMesh.id];
+    });
+};
+exports.getMaterialPostLoadObserver = getMaterialPostLoadObserver;
+function _isMeshInstanceData(data) {
+    const hasName = (0, lodash_es_1.isString)(data.name);
+    const hasValidTags = !data.tags || (0, lodash_es_1.isString)(data.tags);
+    return hasName && hasValidTags;
+}
+function _isMeshData(data) {
+    const hasName = (0, lodash_es_1.isString)(data.name);
+    const hasValidMaterialId = !data.materialId || (0, lodash_es_1.isString)(data.materialId);
+    return hasName && hasValidMaterialId;
+}
+function _isDataWithMeshes(data) {
+    return data && (0, lodash_es_1.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
+ */
+const addMissingMaterialMetadata = function (dataParsed, container) {
+    if (!_isDataWithMeshes(dataParsed))
+        return;
+    const validatedMeshes = dataParsed.meshes.filter(_isMeshData);
+    container.meshes.forEach(importedMesh => {
+        var _a, _b;
+        const parsedMesh = validatedMeshes.find(mesh => mesh.name === importedMesh.name);
+        // save original material id of the imported babylon or GLB file
+        (0, babylonHelper_1.injectMetadata)(importedMesh, { [exports.parsedMaterialIdMetadataName]: parsedMesh === null || parsedMesh === void 0 ? void 0 : parsedMesh.materialId }, false);
+        const materialOnImportedMesh = (_a = importedMesh.material) === null || _a === void 0 ? void 0 : _a.id;
+        const materialOnOriginalMesh = parsedMesh === null || parsedMesh === void 0 ? void 0 : parsedMesh.materialId;
+        if (materialOnOriginalMesh && materialOnImportedMesh !== materialOnOriginalMesh) {
+            (_b = window.Cbn) === null || _b === void 0 ? void 0 : _b.Assets.assertMaterialExists(materialOnOriginalMesh);
+            (0, babylonHelper_1.injectMetadata)(importedMesh, { [exports.missingMaterialMetadataName]: materialOnOriginalMesh }, false);
+        }
+    });
+};
+exports.addMissingMaterialMetadata = addMissingMaterialMetadata;
+/**
+ * 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
+ */
+const reconstructTagsForInstancedMeshes = function (dataParsed, container) {
+    if (!_isDataWithMeshes(dataParsed))
+        return;
+    const validatedMeshes = dataParsed.meshes.filter(_isMeshData);
+    container.meshes.forEach(importedMesh => {
+        var _a;
+        if (importedMesh instanceof instancedMesh_1.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 importedTags = tags_1.Tags.GetTags(importedMesh);
+            if (importedTags) {
+                tags_1.Tags.RemoveTagsFrom(importedMesh, importedTags);
+                // 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 = (_a = parsedSourceMesh === null || parsedSourceMesh === void 0 ? void 0 : parsedSourceMesh.instances) === null || _a === void 0 ? void 0 : _a.filter(_isMeshInstanceData);
+                const parsedInstancedMesh = validatedSourceMeshInstances === null || validatedSourceMeshInstances === void 0 ? void 0 : validatedSourceMeshInstances.find(mesh => mesh.name === importedMesh.name);
+                const parsedTags = parsedInstancedMesh === null || parsedInstancedMesh === void 0 ? void 0 : parsedInstancedMesh.tags;
+                if (parsedTags) {
+                    tags_1.Tags.AddTagsTo(importedMesh, parsedTags);
+                }
+            }
+        }
+    });
+};
+exports.reconstructTagsForInstancedMeshes = reconstructTagsForInstancedMeshes;
+/**
+ * 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) {
+    // 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_1.InstancedMesh ? node.sourceMesh : node;
+    // observer is pointless if concerning node has no missing material
+    if (!(0, has_1.default)(concerningNode.metadata, exports.missingMaterialMetadataName))
+        return;
+    // for each of our AbstractMeshes, set an observer on the AbstractMesh itself and all of its parents.
+    let currNode = node;
+    while (currNode) {
+        const callback = (0, exports.getMaterialPostLoadObserver)(concerningNode);
+        const observer = currNode.onEnabledStateChangedObservable.add(callback);
+        // store the observer in a local map to keep track of the active "enable" observers
+        // observers will be removed when the concerning node gets enabled
+        if (!enableObserverMap[concerningNode.id]) {
+            enableObserverMap[concerningNode.id] = [];
+        }
+        enableObserverMap[concerningNode.id].push({ currNodeId: currNode.id, observer });
+        currNode = currNode.parent;
+    }
+};
+exports.addMissingMaterialObserver = addMissingMaterialObserver;
+const removeMissingMaterialObserver = function (node) {
+    var _a;
+    // 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_1.InstancedMesh ? node.sourceMesh : node;
+    let currNode = node;
+    while (currNode) {
+        (_a = enableObserverMap[concerningNode.id]) === null || _a === void 0 ? void 0 : _a.forEach(entry => {
+            if (entry.currNodeId === (currNode === null || currNode === void 0 ? void 0 : currNode.id)) {
+                currNode.onEnabledStateChangedObservable.remove(entry.observer);
+            }
+        });
+        currNode = currNode.parent;
+    }
+    delete enableObserverMap[concerningNode.id];
+};
+exports.removeMissingMaterialObserver = removeMissingMaterialObserver;
+/**
+ * Look up the provided materials (see library import) and create and return one if found.
+ *
+ * @param materialId Babylon.js material-id. E.g. 'concrete".
+ * @param scene Babylon.js scene
+ * @returns PBRMaterial | null
+ */
+const createMaterialFromCbnAssets = function (materialId, scene) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const materialDefinition = yield ((_a = window.Cbn) === null || _a === void 0 ? void 0 : _a.Assets.getMaterial(materialId));
+        // The generic `Material.Parse` actually returns a more specific material like `BABYLON.StandardMaterial`,
+        // `BABYLON.PBRMaterial` or stuff like `BABYLON.PBRMetallicRoughnessMaterial` etc. based on the given `customType`
+        // within the material JSON definition
+        const material = materialDefinition && material_1.Material.Parse(materialDefinition, scene, '');
+        return material || null;
+    });
+};
+exports.createMaterialFromCbnAssets = createMaterialFromCbnAssets;
 //# sourceMappingURL=sceneLoaderHelper.js.map

package/dist/lib-cjs/api/util/stringHelper.d.ts

@@ -1,13 +1,13 @@
-/**
- * Creates a random uuidv4.
- */
-declare const uuidv4: () => string;
-/**
- * Converts a string from camel case to snake case.
- */
-declare const camelToSnakeCase: (str: string) => string;
-/**
- * Replaces all dots from the input string with a desired character ('/' by default)
- */
-declare const replaceDots: (str: string, replaceChar?: string) => string;
-export { uuidv4, camelToSnakeCase, replaceDots };
+/**
+ * Creates a random uuidv4.
+ */
+declare const uuidv4: () => string;
+/**
+ * Converts a string from camel case to snake case.
+ */
+declare const camelToSnakeCase: (str: string) => string;
+/**
+ * Replaces all dots from the input string with a desired character ('/' by default)
+ */
+declare const replaceDots: (str: string, replaceChar?: string) => string;
+export { uuidv4, camelToSnakeCase, replaceDots };