@combeenation/3d-viewer 12.4.1 → 13.0.0

package/dist/lib-cjs/{api/manager → manager}/gltfExportManager.js

@@ -10,29 +10,89 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GltfExportManager = void 0;
-const babylonHelper_1 = require("../util/babylonHelper");
-const deviceHelper_1 = require("../util/deviceHelper");
-const geometryHelper_1 = require("../util/geometryHelper");
-const structureHelper_1 = require("../util/structureHelper");
-const pbrMaterial_1 = require("@babylonjs/core/Materials/PBR/pbrMaterial");
-const dynamicTexture_1 = require("@babylonjs/core/Materials/Textures/dynamicTexture");
-const renderTargetTexture_1 = require("@babylonjs/core/Materials/Textures/renderTargetTexture");
-const math_vector_1 = require("@babylonjs/core/Maths/math.vector");
-const instancedMesh_1 = require("@babylonjs/core/Meshes/instancedMesh");
-const mesh_1 = require("@babylonjs/core/Meshes/mesh");
-const transformNode_1 = require("@babylonjs/core/Meshes/transformNode");
-require("@babylonjs/serializers/glTF/2.0/Extensions/KHR_texture_transform");
-const glTFSerializer_1 = require("@babylonjs/serializers/glTF/2.0/glTFSerializer");
+const index_1 = require("../index");
+const deviceHelper_1 = require("../internal/deviceHelper");
+const geometryHelper_1 = require("../internal/geometryHelper");
+const geometryHelper_2 = require("../internal/geometryHelper");
+const metadataHelper_1 = require("../internal/metadataHelper");
+/**
+ * Manager for gltf export and augmented reality features
+ */
 class GltfExportManager {
+    /** @internal */
     constructor(viewer) {
         this.viewer = viewer;
         // store initial max texture size, so that we can restore it in the post processing
         this._maxTextureSize = viewer.engine.getCaps().maxTextureSize;
     }
-    static create(viewer) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return new GltfExportManager(viewer);
-        });
+    /**
+     * Defines options for the export.
+     * We don't allow the user to overwrite certain settings, since we rely on properties like `removeNoopRootNodes` to
+     * stay `true` in order to make the AR export work.
+     * We could theoretically allow it if AR optimization is not desired, but this may confuse the user.
+     */
+    static _gltfExportOptions(optimizeForAR, excluded) {
+        return {
+            shouldExportNode: function (node) {
+                if (optimizeForAR) {
+                    // we explicitely marked nodes, that should be exported in AR mode
+                    return (0, metadataHelper_1.getInternalMetadataValue)(node, 'exportNode');
+                }
+                else {
+                    // use the default export node check (enabled state, exclusion list, etc...)
+                    return GltfExportManager._shouldExportNode(node, excluded);
+                }
+            },
+        };
+    }
+    /**
+     * Checks if a node should be available in the export
+     */
+    static _shouldExportNode(node, excluded) {
+        if (!(node instanceof index_1.TransformNode)) {
+            return false;
+        }
+        // TODO WTT: think of adding "BackgroundHelper" and nodes with "infiniteDistance" here as well, at least in AR mode
+        if (!node.isEnabled()) {
+            return false;
+        }
+        if (excluded && (0, geometryHelper_2.isNodeExcluded)(node, excluded)) {
+            return false;
+        }
+        return true;
+    }
+    /**
+     * Creates a clone of the material which should be used for the export.
+     * This is mostly required for recreating textures with lower sizes.
+     * 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
+     */
+    static _exchangeMaterial(material) {
+        const baseTextures = material.getActiveTextures();
+        const hasDynamicTextures = baseTextures.some(texture => texture instanceof index_1.DynamicTexture);
+        const hasRenderTargetTextures = baseTextures.some(texture => texture instanceof index_1.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);
+        (0, metadataHelper_1.cloneInternalMetadata)(material, clonedMaterial);
+        const clonedTextures = clonedMaterial.getActiveTextures();
+        // mark all exported textures, so that they will be deleted after the export
+        clonedTextures.forEach(texture => (0, metadataHelper_1.setInternalMetadataValue)(texture, 'deleteAfterExport', true));
+        (0, metadataHelper_1.setInternalMetadataValue)(material, 'exchangeMaterialWith', clonedMaterial.uniqueId);
+        (0, metadataHelper_1.setInternalMetadataValue)(clonedMaterial, 'deleteAfterExport', true);
     }
     /**
      * Exports selected nodes to a file.
@@ -44,7 +104,7 @@ class GltfExportManager {
     exportGlb(filename = 'glb-export.glb', optimizeForAR = false, excluded) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this._exportPreProcess(optimizeForAR, excluded);
-            const glbData = yield glTFSerializer_1.GLTF2Export.GLBAsync(this.viewer.scene, 'dummy', GltfExportManager._gltfExportOptions(optimizeForAR, excluded));
+            const glbData = yield index_1.GLTF2Export.GLBAsync(this.viewer.scene, 'dummy', GltfExportManager._gltfExportOptions(optimizeForAR, excluded));
             yield this._exportPostProcess(optimizeForAR);
             const resBlob = glbData.glTFFiles['dummy.glb'];
             // check if result is valid, according to the typings this could also be a string
@@ -70,7 +130,7 @@ class GltfExportManager {
     exportGltfToFile(filename, optimizeForAR = false, excluded) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this._exportPreProcess(optimizeForAR, excluded);
-            const gltf = yield glTFSerializer_1.GLTF2Export.GLTFAsync(this.viewer.scene, filename, GltfExportManager._gltfExportOptions(optimizeForAR, excluded));
+            const gltf = yield index_1.GLTF2Export.GLTFAsync(this.viewer.scene, filename, GltfExportManager._gltfExportOptions(optimizeForAR, excluded));
             gltf.downloadFiles();
             this._exportPostProcess(optimizeForAR);
         });
@@ -85,7 +145,7 @@ class GltfExportManager {
     exportGlbToFile(filename, optimizeForAR = false, excluded) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this._exportPreProcess(optimizeForAR, excluded);
-            const glb = yield glTFSerializer_1.GLTF2Export.GLBAsync(this.viewer.scene, filename, GltfExportManager._gltfExportOptions(optimizeForAR, excluded));
+            const glb = yield index_1.GLTF2Export.GLBAsync(this.viewer.scene, filename, GltfExportManager._gltfExportOptions(optimizeForAR, excluded));
             glb.downloadFiles();
             yield this._exportPostProcess(optimizeForAR);
         });
@@ -110,14 +170,14 @@ class GltfExportManager {
             // we don't have to rescale anything if are already on a downscaled device, since the textures are already <= 1024
             // also we have to be very cautios with copying textures on these devices, since we are potentially very limited
             // with the available memory
-            const isScaledDownDevice = (0, deviceHelper_1.getIsScaledDownDevice)();
+            const isScaledDownDevice = (0, deviceHelper_1.getIsScaledDownDevice)(this.viewer.viewerSettings.limitTextureSize);
             if (!isScaledDownDevice) {
                 // the idea is to re-create all textures with a smaller texture size
                 // we have to exchange all materials for this to work
                 this.viewer.engine.clearInternalTexturesCache();
                 this.viewer.engine.getCaps().maxTextureSize = 1024;
                 this.viewer.scene.materials
-                    .filter(material => material instanceof pbrMaterial_1.PBRMaterial)
+                    .filter(material => material instanceof index_1.PBRMaterial)
                     .forEach(material => GltfExportManager._exchangeMaterial(material));
             }
             // since Babylon.js v6 the conversion to right handed GLB coordinate system is done differently
@@ -128,12 +188,10 @@ class GltfExportManager {
             // the exporter just removes this node as he detects a "noop root node" (implementation details of Babylon.js)
             // everything beneath this node remains untouched
             // TODO BJS Update: Test AR export on iPhones as well and double check if we still need this special logic
-            const exportRootNode = new transformNode_1.TransformNode(GltfExportManager._EXPORT_ROOT_NAME, this.viewer.scene);
-            exportRootNode.scaling = new math_vector_1.Vector3(-1, 1, 1);
-            (0, babylonHelper_1.injectMetadata)(exportRootNode, {
-                [GltfExportManager._METADATA_PROPS.exportNode]: true,
-                [GltfExportManager._METADATA_PROPS.deleteAfterExport]: true,
-            });
+            const exportRootNode = new index_1.TransformNode(GltfExportManager._EXPORT_ROOT_NAME, this.viewer.scene);
+            exportRootNode.scaling = new index_1.Vector3(-1, 1, 1);
+            (0, metadataHelper_1.setInternalMetadataValue)(exportRootNode, 'exportNode', true);
+            (0, metadataHelper_1.setInternalMetadataValue)(exportRootNode, 'deleteAfterExport', true);
             // create clones of each node (recursively), optionally exchange with cloned materials and mark these nodes for the
             // export
             this.viewer.scene.rootNodes
@@ -158,13 +216,13 @@ class GltfExportManager {
             }
             // dispose all nodes, materials and textures that have only been created for the export
             this.viewer.scene.rootNodes
-                .filter(rootNode => { var _a; return (_a = rootNode.metadata) === null || _a === void 0 ? void 0 : _a[GltfExportManager._METADATA_PROPS.deleteAfterExport]; })
+                .filter(rootNode => (0, metadataHelper_1.getInternalMetadataValue)(rootNode, 'deleteAfterExport'))
                 .forEach(rootNode => rootNode.dispose());
             this.viewer.scene.materials
-                .filter(mat => { var _a; return !!((_a = mat.metadata) === null || _a === void 0 ? void 0 : _a[GltfExportManager._METADATA_PROPS.deleteAfterExport]); })
+                .filter(mat => (0, metadataHelper_1.getInternalMetadataValue)(mat, 'deleteAfterExport'))
                 .forEach(material => material.dispose(false, false));
             this.viewer.scene.textures
-                .filter(texture => { var _a; return !!((_a = texture.metadata) === null || _a === void 0 ? void 0 : _a[GltfExportManager._METADATA_PROPS.deleteAfterExport]); })
+                .filter(texture => (0, metadataHelper_1.getInternalMetadataValue)(texture, 'deleteAfterExport'))
                 .forEach(texture => texture.dispose());
             // reset engines max texture size and resume rendering
             this.viewer.engine.getCaps().maxTextureSize = this._maxTextureSize;
@@ -176,7 +234,6 @@ class GltfExportManager {
      * Also switches to the cloned material if required.
      */
     _prepareNodeForExport(node, clonedParent, excluded) {
-        var _a, _b;
         if (!GltfExportManager._shouldExportNode(node, excluded)) {
             return;
         }
@@ -184,21 +241,20 @@ class GltfExportManager {
         const transformNode = node;
         // clone original node and create unique name (via uniqueId) for the export
         const clonedNodeName = `${transformNode.name}_${transformNode.uniqueId}`;
-        const clonedNode = transformNode instanceof instancedMesh_1.InstancedMesh
+        const clonedNode = transformNode instanceof index_1.InstancedMesh
             ? (0, geometryHelper_1.createMeshFromInstancedMesh)(transformNode, clonedNodeName, clonedParent)
             : transformNode.clone(clonedNodeName, clonedParent, true);
+        (0, metadataHelper_1.cloneInternalMetadata)(transformNode, clonedNode);
         // exchange material
-        if (clonedNode instanceof mesh_1.Mesh) {
-            const exchangeWithMaterial = (_b = (_a = clonedNode.material) === null || _a === void 0 ? void 0 : _a.metadata) === null || _b === void 0 ? void 0 : _b[GltfExportManager._METADATA_PROPS.exchangeMaterialWith];
+        if (clonedNode instanceof index_1.Mesh) {
+            const exchangeWithMaterial = clonedNode.material && (0, metadataHelper_1.getInternalMetadataValue)(clonedNode.material, 'exchangeMaterialWith');
             if (exchangeWithMaterial) {
                 clonedNode.material = this.viewer.scene.getMaterialByUniqueID(exchangeWithMaterial);
             }
         }
         // signalize that this is a cloned node
-        (0, babylonHelper_1.injectMetadata)(clonedNode, {
-            [GltfExportManager._METADATA_PROPS.exportNode]: true,
-            [GltfExportManager._METADATA_PROPS.deleteAfterExport]: true,
-        });
+        (0, metadataHelper_1.setInternalMetadataValue)(clonedNode, 'exportNode', true);
+        (0, metadataHelper_1.setInternalMetadataValue)(clonedNode, 'deleteAfterExport', true);
         // handle children
         const childs = transformNode.getChildTransformNodes(true);
         childs.forEach(child => this._prepareNodeForExport(child, clonedNode, excluded));
@@ -211,90 +267,13 @@ class GltfExportManager {
         if (!meshesOnly) {
             nodes.push(...this.viewer.scene.transformNodes);
         }
-        const filteredNodes = nodes.filter(node => {
-            var _a;
-            return !!((_a = node.metadata) === null || _a === void 0 ? void 0 : _a[GltfExportManager._METADATA_PROPS.exportNode]) &&
-                // in the desired use cases we want to exclude the export root node
-                // maybe add a parameter if we have to include it in certain scenarios in the future
-                node.name !== GltfExportManager._EXPORT_ROOT_NAME;
-        });
+        const filteredNodes = nodes.filter(node => (0, metadataHelper_1.getInternalMetadataValue)(node, 'exportNode') &&
+            // in the desired use cases we want to exclude the export root node
+            // maybe add a parameter if we have to include it in certain scenarios in the future
+            node.name !== GltfExportManager._EXPORT_ROOT_NAME);
         return filteredNodes;
     }
-    /**
-     * Defines options for the export.
-     * We don't allow the user to overwrite certain settings, since we rely on properties like `removeNoopRootNodes` to
-     * stay `true` in order to make the AR export work.
-     * We could theoretically allow it if AR optimization is not desired, but this may confuse the user.
-     */
-    static _gltfExportOptions(optimizeForAR, excluded) {
-        return {
-            shouldExportNode: function (node) {
-                var _a;
-                if (optimizeForAR) {
-                    // we explicitely marked nodes, that should be exported in AR mode
-                    return !!((_a = node.metadata) === null || _a === void 0 ? void 0 : _a[GltfExportManager._METADATA_PROPS.exportNode]);
-                }
-                else {
-                    // use the default export node check (enabled state, exclusion list, etc...)
-                    return GltfExportManager._shouldExportNode(node, excluded);
-                }
-            },
-        };
-    }
-    /**
-     * Checks if a node should be available in the export
-     */
-    static _shouldExportNode(node, excluded) {
-        if (!(node instanceof transformNode_1.TransformNode)) {
-            return false;
-        }
-        // TODO: think of adding "BackgroundHelper" and nodes with "infiniteDistance" here as well, at least in AR mode
-        if (!node.isEnabled()) {
-            return false;
-        }
-        if (excluded && (0, structureHelper_1.isNodeIncludedInExclusionList)(node, excluded)) {
-            return false;
-        }
-        return true;
-    }
-    /**
-     * Creates a clone of the material which should be used for the export.
-     * This is mostly required for recreating textures with lower sizes.
-     * 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
-     */
-    static _exchangeMaterial(material) {
-        const baseTextures = material.getActiveTextures();
-        const hasDynamicTextures = baseTextures.some(texture => texture instanceof dynamicTexture_1.DynamicTexture);
-        const hasRenderTargetTextures = baseTextures.some(texture => texture instanceof renderTargetTexture_1.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
-        clonedTextures.forEach(texture => (0, babylonHelper_1.injectMetadata)(texture, { [GltfExportManager._METADATA_PROPS.deleteAfterExport]: true }));
-        (0, babylonHelper_1.injectMetadata)(material, { [GltfExportManager._METADATA_PROPS.exchangeMaterialWith]: clonedMaterial.uniqueId });
-        (0, babylonHelper_1.injectMetadata)(clonedMaterial, { [GltfExportManager._METADATA_PROPS.deleteAfterExport]: true });
-    }
 }
 exports.GltfExportManager = GltfExportManager;
-GltfExportManager._METADATA_PROPS = {
-    exportNode: 'exportNode',
-    deleteAfterExport: 'deleteAfterExport',
-    exchangeMaterialWith: 'exchangeMaterialWith',
-};
 GltfExportManager._EXPORT_ROOT_NAME = '__export_root__';
 //# sourceMappingURL=gltfExportManager.js.map

package/dist/lib-cjs/manager/gltfExportManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gltfExportManager.js","sourceRoot":"","sources":["../../../src/manager/gltfExportManager.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAckB;AAClB,2DAAiE;AACjE,+DAAkH;AAClH,+DAA4D;AAC5D,+DAAuH;AAEvH;;GAEG;AACH,MAAa,iBAAiB;IAmF5B,gBAAgB;IAChB,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QACzC,mFAAmF;QACnF,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,cAAc,CAAC;IAChE,CAAC;IAlFD;;;;;OAKG;IACO,MAAM,CAAC,kBAAkB,CAAC,aAAsB,EAAE,QAA+B;QACzF,OAAO;YACL,gBAAgB,EAAE,UAAU,IAAU;gBACpC,IAAI,aAAa,EAAE;oBACjB,kEAAkE;oBAClE,OAAO,IAAA,yCAAwB,EAAC,IAAI,EAAE,YAAY,CAAY,CAAC;iBAChE;qBAAM;oBACL,4EAA4E;oBAC5E,OAAO,iBAAiB,CAAC,iBAAiB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;iBAC5D;YACH,CAAC;SACF,CAAC;IACJ,CAAC;IAED;;OAEG;IACO,MAAM,CAAC,iBAAiB,CAAC,IAAU,EAAE,QAA+B;QAC5E,IAAI,CAAC,CAAC,IAAI,YAAY,qBAAa,CAAC,EAAE;YACpC,OAAO,KAAK,CAAC;SACd;QACD,mHAAmH;QACnH,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE;YACrB,OAAO,KAAK,CAAC;SACd;QACD,IAAI,QAAQ,IAAI,IAAA,+BAAc,EAAC,IAAI,EAAE,QAAQ,CAAC,EAAE;YAC9C,OAAO,KAAK,CAAC;SACd;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACO,MAAM,CAAC,iBAAiB,CAAC,QAAkB;QACnD,MAAM,YAAY,GAAG,QAAQ,CAAC,iBAAiB,EAAE,CAAC;QAClD,MAAM,kBAAkB,GAAG,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,YAAY,sBAAc,CAAC,CAAC;QAC3F,MAAM,uBAAuB,GAAG,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,YAAY,2BAAmB,CAAC,CAAC;QACrG,IAAI,kBAAkB,IAAI,uBAAuB,EAAE;YACjD,MAAM,kBAAkB,GAAG;gBACzB,kBAAkB,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE;gBAC5C,uBAAuB,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,EAAE;aACxD;iBACE,MAAM,CAAC,OAAO,CAAC;iBACf,IAAI,EAAE,CAAC;YACV,OAAO,CAAC,IAAI,CACV,+BAA+B,QAAQ,CAAC,IAAI,gEAAgE,kBAAkB,iGAAiG,CAChO,CAAC;YAEF,OAAO;SACR;QAED,MAAM,OAAO,GAAG,GAAG,QAAQ,CAAC,IAAI,QAAQ,CAAC;QACzC,MAAM,cAAc,GAAG,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAE,CAAC;QAChD,IAAA,sCAAqB,EAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAChD,MAAM,cAAc,GAAG,cAAc,CAAC,iBAAiB,EAAE,CAAC;QAE1D,4EAA4E;QAC5E,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,IAAA,yCAAwB,EAAC,OAAO,EAAE,mBAAmB,EAAE,IAAI,CAAC,CAAC,CAAC;QAEhG,IAAA,yCAAwB,EAAC,QAAQ,EAAE,sBAAsB,EAAE,cAAc,CAAC,QAAQ,CAAC,CAAC;QACpF,IAAA,yCAAwB,EAAC,cAAc,EAAE,mBAAmB,EAAE,IAAI,CAAC,CAAC;IACtE,CAAC;IAQD;;;;;;OAMG;IACU,SAAS,CACpB,QAAQ,GAAG,gBAAgB,EAC3B,gBAAyB,KAAK,EAC9B,QAA+B;;YAE/B,MAAM,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;YAEtD,MAAM,OAAO,GAAG,MAAM,mBAAW,CAAC,QAAQ,CACxC,IAAI,CAAC,MAAM,CAAC,KAAK,EACjB,OAAO,EACP,iBAAiB,CAAC,kBAAkB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAC9D,CAAC;YAEF,MAAM,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAC;YAE7C,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YAC/C,iFAAiF;YACjF,IAAI,OAAO,YAAY,IAAI,EAAE;gBAC3B,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;oBAC9B,QAAQ,IAAI,MAAM,CAAC;iBACpB;gBACD,OAAO,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;aACtC;iBAAM;gBACL,8BAA8B;gBAC9B,OAAO,SAAS,CAAC;aAClB;QACH,CAAC;KAAA;IAED;;;;;;OAMG;IACU,gBAAgB,CAC3B,QAAgB,EAChB,gBAAyB,KAAK,EAC9B,QAA+B;;YAE/B,MAAM,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;YAEtD,MAAM,IAAI,GAAG,MAAM,mBAAW,CAAC,SAAS,CACtC,IAAI,CAAC,MAAM,CAAC,KAAK,EACjB,QAAQ,EACR,iBAAiB,CAAC,kBAAkB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAC9D,CAAC;YACF,IAAI,CAAC,aAAa,EAAE,CAAC;YAErB,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAC;QACzC,CAAC;KAAA;IAED;;;;;;OAMG;IACU,eAAe,CAC1B,QAAgB,EAChB,gBAAyB,KAAK,EAC9B,QAA+B;;YAE/B,MAAM,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;YAEtD,MAAM,GAAG,GAAG,MAAM,mBAAW,CAAC,QAAQ,CACpC,IAAI,CAAC,MAAM,CAAC,KAAK,EACjB,QAAQ,EACR,iBAAiB,CAAC,kBAAkB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAC9D,CAAC;YACF,GAAG,CAAC,aAAa,EAAE,CAAC;YAEpB,MAAM,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAC;QAC/C,CAAC;KAAA;IAED;;;OAGG;IACa,iBAAiB,CAAC,aAAsB,EAAE,QAA+B;;YACvF,IAAI,CAAC,aAAa,EAAE;gBAClB,4DAA4D;gBAC5D,OAAO;aACR;YAED,mGAAmG;YACnG,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;YAE7B,iCAAiC;YACjC,mEAAmE;YACnE,0FAA0F;YAC1F,mEAAmE;YACnE,qEAAqE;YACrE,kHAAkH;YAClH,gHAAgH;YAChH,4BAA4B;YAC5B,MAAM,kBAAkB,GAAG,IAAA,oCAAqB,EAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;YAC9F,IAAI,CAAC,kBAAkB,EAAE;gBACvB,oEAAoE;gBACpE,qDAAqD;gBACrD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,0BAA0B,EAAE,CAAC;gBAChD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,cAAc,GAAG,IAAI,CAAC;gBAEnD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS;qBACxB,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,YAAY,mBAAW,CAAC;qBACnD,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,QAAuB,CAAC,CAAC,CAAC;aACtF;YAED,+FAA+F;YAC/F,iGAAiG;YACjG,kHAAkH;YAClH,iBAAiB;YACjB,8EAA8E;YAC9E,8GAA8G;YAC9G,iDAAiD;YACjD,0GAA0G;YAC1G,MAAM,cAAc,GAAG,IAAI,qBAAa,CAAC,iBAAiB,CAAC,iBAAiB,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACjG,cAAc,CAAC,OAAO,GAAG,IAAI,eAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;YAC/C,IAAA,yCAAwB,EAAC,cAAc,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;YAC7D,IAAA,yCAAwB,EAAC,cAAc,EAAE,mBAAmB,EAAE,IAAI,CAAC,CAAC;YAEpE,mHAAmH;YACnH,SAAS;YACT,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS;iBACxB,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,iBAAiB,CAAC,iBAAiB,CAAC;iBACzE,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC,CAAC;YAEvF,2EAA2E;YAC3E,sGAAsG;YACtG,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,IAAA,mCAAkB,EAAC,IAAY,CAAC,CAAC,CAAC;YAEtF,2GAA2G;YAC3G,wEAAwE;YACxE,IAAI,CAAC,wBAAwB,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,IAAA,oCAAmB,EAAC,IAAqB,CAAC,CAAC,CAAC;QAC9F,CAAC;KAAA;IAED;;OAEG;IACa,kBAAkB,CAAC,aAAsB;;YACvD,IAAI,CAAC,aAAa,EAAE;gBAClB,0EAA0E;gBAC1E,OAAO;aACR;YAED,uFAAuF;YACvF,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS;iBACxB,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAA,yCAAwB,EAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC;iBAC3E,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;YAE3C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS;iBACxB,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,IAAA,yCAAwB,EAAC,GAAG,EAAE,mBAAmB,CAAC,CAAC;iBACjE,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;YAEvD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ;iBACvB,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,IAAA,yCAAwB,EAAC,OAAO,EAAE,mBAAmB,CAAC,CAAC;iBACzE,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;YAEzC,sDAAsD;YACtD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC;YACnE,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;QAChC,CAAC;KAAA;IAED;;;OAGG;IACO,qBAAqB,CAAC,IAAU,EAAE,YAA2B,EAAE,QAA+B;QACtG,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE;YACxD,OAAO;SACR;QAED,2CAA2C;QAC3C,MAAM,aAAa,GAAG,IAAqB,CAAC;QAE5C,2EAA2E;QAC3E,MAAM,cAAc,GAAG,GAAG,aAAa,CAAC,IAAI,IAAI,aAAa,CAAC,QAAQ,EAAE,CAAC;QACzE,MAAM,UAAU,GACd,aAAa,YAAY,qBAAa;YACpC,CAAC,CAAC,IAAA,4CAA2B,EAAC,aAAa,EAAE,cAAc,EAAE,YAAY,CAAC;YAC1E,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,cAAc,EAAE,YAAY,EAAE,IAAI,CAAE,CAAC;QAC/D,IAAA,sCAAqB,EAAC,aAAa,EAAE,UAAU,CAAC,CAAC;QAEjD,oBAAoB;QACpB,IAAI,UAAU,YAAY,YAAI,EAAE;YAC9B,MAAM,oBAAoB,GACxB,UAAU,CAAC,QAAQ,IAAI,IAAA,yCAAwB,EAAC,UAAU,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;YAC/F,IAAI,oBAAoB,EAAE;gBACxB,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,oBAA8B,CAAC,CAAC;aAC/F;SACF;QAED,uCAAuC;QACvC,IAAA,yCAAwB,EAAC,UAAU,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC;QACzD,IAAA,yCAAwB,EAAC,UAAU,EAAE,mBAAmB,EAAE,IAAI,CAAC,CAAC;QAEhE,kBAAkB;QAClB,MAAM,MAAM,GAAG,aAAa,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC;IACnF,CAAC;IAED;;OAEG;IACO,wBAAwB,CAAC,UAAoB;QACrD,MAAM,KAAK,GAAoB,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7D,IAAI,CAAC,UAAU,EAAE;YACf,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;SACjD;QAED,MAAM,aAAa,GAAG,KAAK,CAAC,MAAM,CAChC,IAAI,CAAC,EAAE,CACL,IAAA,yCAAwB,EAAC,IAAI,EAAE,YAAY,CAAC;YAC5C,mEAAmE;YACnE,oFAAoF;YACpF,IAAI,CAAC,IAAI,KAAK,iBAAiB,CAAC,iBAAiB,CACpD,CAAC;QAEF,OAAO,aAAa,CAAC;IACvB,CAAC;;AA5TH,8CA6TC;AA5T2B,mCAAiB,GAAG,iBAAiB,CAAC"}

package/dist/lib-cjs/manager/materialManager.d.ts

@@ -0,0 +1,35 @@
+import { AbstractMesh, Material, Viewer } from '../index';
+/**
+ * Manager for material related tasks
+ */
+export declare class MaterialManager {
+    protected viewer: Viewer;
+    /**
+     * CAUTION: this has to be in sync with the Combeenation backend!
+     * @internal
+     */
+    static readonly CBN_FALLBACK_MATERIAL_NAME = "$fallback";
+    protected _createMaterialPromises: {
+        [materialId: string]: Promise<Material | null>;
+    };
+    /** @internal */
+    constructor(viewer: Viewer);
+    /**
+     * Assigns material with certain id to desired mesh.\
+     * Creates the material if not already available (see {@link getOrCreateMaterial}).
+     */
+    setMaterialOnMesh(materialId: string, mesh: AbstractMesh): Promise<void>;
+    /**
+     * Returns material with certain id if already available in the scene.\
+     * If this is not the case material is created from a
+     * "[Material asset](https://docs.combeenation.com/docs/howto-create-and-use-babylon-and-material-asset)"
+     * on the Combeenation server.\
+     * Waits until textures of material are fully loaded and shader is compiled. In this way "flickering" effects
+     * will be avoided, since the material would be incomplete without its loaded textures.
+     *
+     * @param mesh Required for shader compilation check, can be omitted if this check should not be done.\
+     * Use {@link setMaterialOnMesh} instead if the material should be applied on the mesh immediately.
+     */
+    getOrCreateMaterial(materialId: string, mesh?: AbstractMesh): Promise<Material>;
+    protected _createMaterial(materialId: string, mesh?: AbstractMesh): Promise<Material>;
+}

package/dist/lib-cjs/manager/materialManager.js

@@ -0,0 +1,126 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MaterialManager = void 0;
+const index_1 = require("../index");
+const metadataHelper_1 = require("../internal/metadataHelper");
+/**
+ * Manager for material related tasks
+ */
+class MaterialManager {
+    /** @internal */
+    constructor(viewer) {
+        this.viewer = viewer;
+        this._createMaterialPromises = {};
+    }
+    /**
+     * Assigns material with certain id to desired mesh.\
+     * Creates the material if not already available (see {@link getOrCreateMaterial}).
+     */
+    setMaterialOnMesh(materialId, mesh) {
+        return __awaiter(this, void 0, void 0, function* () {
+            (0, metadataHelper_1.setInternalMetadataValue)(mesh, 'materialToBeSet', materialId);
+            const material = yield this.getOrCreateMaterial(materialId, mesh);
+            // there may have been later "setMaterialOnMesh" calls with faster material creation
+            // make sure to assign the latest material!
+            if ((0, metadataHelper_1.getInternalMetadataValue)(mesh, 'materialToBeSet') === materialId) {
+                mesh.material = material;
+                (0, metadataHelper_1.clearInternalMetadataValue)(mesh, 'materialToBeSet');
+                (0, metadataHelper_1.clearInternalMetadataValue)(mesh, 'deferredMaterial');
+            }
+        });
+    }
+    /**
+     * Returns material with certain id if already available in the scene.\
+     * If this is not the case material is created from a
+     * "[Material asset](https://docs.combeenation.com/docs/howto-create-and-use-babylon-and-material-asset)"
+     * on the Combeenation server.\
+     * Waits until textures of material are fully loaded and shader is compiled. In this way "flickering" effects
+     * will be avoided, since the material would be incomplete without its loaded textures.
+     *
+     * @param mesh Required for shader compilation check, can be omitted if this check should not be done.\
+     * Use {@link setMaterialOnMesh} instead if the material should be applied on the mesh immediately.
+     */
+    getOrCreateMaterial(materialId, mesh) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            let chosenMaterial = (_a = this.viewer.scene.materials.find(mat => mat.id === materialId)) !== null && _a !== void 0 ? _a : null;
+            if (!chosenMaterial) {
+                // material not available yet, request it from Combeenation assets
+                const existingCreationProm = this._createMaterialPromises[materialId];
+                if (existingCreationProm !== undefined) {
+                    // request is already pending, just wait for the result
+                    chosenMaterial = yield existingCreationProm;
+                }
+                else {
+                    this.viewer.eventManager.fireEvent(index_1.ViewerEvent.MaterialCreationStart, materialId);
+                    // request not pending, call the dedicated function
+                    const newCreationProm = this._createMaterial(materialId, mesh);
+                    // store the promise in a global map, so that subsequent requests can reference it
+                    this._createMaterialPromises[materialId] = newCreationProm;
+                    chosenMaterial = yield newCreationProm;
+                    delete this._createMaterialPromises[materialId];
+                    const allMaterialsCreated = !Object.entries(this._createMaterialPromises).length;
+                    // signalize event system that material is created now
+                    // also check if there are other material creation processes still pending, as this is an important information
+                    // e.g. for showing load masks
+                    this.viewer.eventManager.fireEvent(index_1.ViewerEvent.MaterialCreationEnd, materialId, allMaterialsCreated);
+                }
+            }
+            return chosenMaterial;
+        });
+    }
+    _createMaterial(materialId, mesh) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            if (materialId === MaterialManager.CBN_FALLBACK_MATERIAL_NAME) {
+                const fallbackMaterial = new index_1.StandardMaterial(MaterialManager.CBN_FALLBACK_MATERIAL_NAME, this.viewer.scene);
+                fallbackMaterial.disableLighting = true;
+                return fallbackMaterial;
+            }
+            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 && index_1.Material.Parse(materialDefinition, this.viewer.scene, '');
+            if (!material) {
+                throw new index_1.ViewerError({
+                    id: index_1.ViewerErrorIds.MaterialCouldNotBeParsed,
+                    message: `Material with id "${materialId}" could not be parsed`,
+                });
+            }
+            yield this.viewer.parameterManager.applyParameterValuesToMaterial(material);
+            const matReadyProms = [
+                new Promise(resolve => index_1.BaseTexture.WhenAllReady(material.getActiveTextures(), resolve)),
+            ];
+            if (mesh) {
+                // this promise should only take some time on the first call of the corresponding shader (eg: PBRMaterial shader)
+                // on each other call of the same material/shader type there should be not be a waiting time, or at maximum one
+                // frame
+                // https://forum.babylonjs.com/t/mesh-flickering-when-setting-material-initially/37312
+                matReadyProms.push(material.forceCompilationAsync(mesh));
+            }
+            // material needs to fulfill 2 criterias before it's ready to use
+            // - textures need to be "ready" => downloaded
+            // - dedicated shader needs to be compiled
+            // if this would not be the case you can see some "flickering" when setting the material
+            yield Promise.all(matReadyProms);
+            return material;
+        });
+    }
+}
+exports.MaterialManager = MaterialManager;
+/**
+ * CAUTION: this has to be in sync with the Combeenation backend!
+ * @internal
+ */
+MaterialManager.CBN_FALLBACK_MATERIAL_NAME = '$fallback';
+//# sourceMappingURL=materialManager.js.map

package/dist/lib-cjs/manager/materialManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"materialManager.js","sourceRoot":"","sources":["../../../src/manager/materialManager.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCASkB;AAClB,+DAIoC;AAEpC;;GAEG;AACH,MAAa,eAAe;IAS1B,gBAAgB;IAChB,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QAHjC,4BAAuB,GAAuD,EAAE,CAAC;IAG7C,CAAC;IAE/C;;;OAGG;IACU,iBAAiB,CAAC,UAAkB,EAAE,IAAkB;;YACnE,IAAA,yCAAwB,EAAC,IAAI,EAAE,iBAAiB,EAAE,UAAU,CAAC,CAAC;YAE9D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAElE,oFAAoF;YACpF,2CAA2C;YAC3C,IAAI,IAAA,yCAAwB,EAAC,IAAI,EAAE,iBAAiB,CAAC,KAAK,UAAU,EAAE;gBACpE,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;gBACzB,IAAA,2CAA0B,EAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;gBACpD,IAAA,2CAA0B,EAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;aACtD;QACH,CAAC;KAAA;IAED;;;;;;;;;;OAUG;IACU,mBAAmB,CAAC,UAAkB,EAAE,IAAmB;;;YACtE,IAAI,cAAc,GAAoB,MAAA,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,UAAU,CAAC,mCAAI,IAAI,CAAC;YAE7G,IAAI,CAAC,cAAc,EAAE;gBACnB,kEAAkE;gBAClE,MAAM,oBAAoB,GAAG,IAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;gBACtE,IAAI,oBAAoB,KAAK,SAAS,EAAE;oBACtC,uDAAuD;oBACvD,cAAc,GAAG,MAAM,oBAAoB,CAAC;iBAC7C;qBAAM;oBACL,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,mBAAW,CAAC,qBAAqB,EAAE,UAAU,CAAC,CAAC;oBAElF,mDAAmD;oBACnD,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;oBAC/D,kFAAkF;oBAClF,IAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,GAAG,eAAe,CAAC;oBAC3D,cAAc,GAAG,MAAM,eAAe,CAAC;oBAEvC,OAAO,IAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC;oBAEhD,MAAM,mBAAmB,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,MAAM,CAAC;oBACjF,sDAAsD;oBACtD,+GAA+G;oBAC/G,8BAA8B;oBAC9B,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,mBAAW,CAAC,mBAAmB,EAAE,UAAU,EAAE,mBAAmB,CAAC,CAAC;iBACtG;aACF;YAED,OAAO,cAA0B,CAAC;;KACnC;IAEe,eAAe,CAAC,UAAkB,EAAE,IAAmB;;;YACrE,IAAI,UAAU,KAAK,eAAe,CAAC,0BAA0B,EAAE;gBAC7D,MAAM,gBAAgB,GAAG,IAAI,wBAAgB,CAAC,eAAe,CAAC,0BAA0B,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC7G,gBAAgB,CAAC,eAAe,GAAG,IAAI,CAAC;gBAExC,OAAO,gBAAgB,CAAC;aACzB;YAED,MAAM,kBAAkB,GAAG,MAAM,CAAA,MAAA,MAAM,CAAC,GAAG,0CAAE,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAA,CAAC;YAC5E,0GAA0G;YAC1G,kHAAkH;YAClH,sCAAsC;YACtC,MAAM,QAAQ,GAAG,kBAAkB,IAAI,gBAAQ,CAAC,KAAK,CAAC,kBAAkB,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAEjG,IAAI,CAAC,QAAQ,EAAE;gBACb,MAAM,IAAI,mBAAW,CAAC;oBACpB,EAAE,EAAE,sBAAc,CAAC,wBAAwB;oBAC3C,OAAO,EAAE,qBAAqB,UAAU,uBAAuB;iBAChE,CAAC,CAAC;aACJ;YAED,MAAM,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,8BAA8B,CAAC,QAAQ,CAAC,CAAC;YAE5E,MAAM,aAAa,GAAG;gBACpB,IAAI,OAAO,CAAO,OAAO,CAAC,EAAE,CAAC,mBAAW,CAAC,YAAY,CAAC,QAAQ,CAAC,iBAAiB,EAAE,EAAE,OAAO,CAAC,CAAC;aAC9F,CAAC;YAEF,IAAI,IAAI,EAAE;gBACR,iHAAiH;gBACjH,+GAA+G;gBAC/G,QAAQ;gBACR,sFAAsF;gBACtF,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC;aAC1D;YAED,iEAAiE;YACjE,8CAA8C;YAC9C,0CAA0C;YAC1C,wFAAwF;YACxF,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;YAEjC,OAAO,QAAQ,CAAC;;KACjB;;AAlHH,0CAmHC;AAlHC;;;GAGG;AACoB,0CAA0B,GAAG,WAAW,CAAC"}

package/dist/lib-cjs/manager/modelManager.d.ts

@@ -0,0 +1,145 @@
+import { AssetContainer, TransformNode, Viewer } from '../index';
+export declare type ModelAssetDefinition = {
+    name: string;
+    url: string;
+};
+export declare type ModelVisibilityEntry = {
+    name: string;
+    visible: boolean;
+};
+/**
+ * Callback for renaming nodes when cloning nodes in a model
+ */
+export declare type NodeNamingStrategy = (node: TransformNode, newModelName: string) => string;
+/**
+ * Callback for renaming tags when cloning nodes in a model
+ */
+export declare type TagNamingStrategy = (tag: string, newModelName: string) => string;
+export declare type ModelCloneOptions = {
+    nodeNamingStrategy: NodeNamingStrategy;
+    tagNamingStrategy: TagNamingStrategy;
+};
+declare type Model = {
+    name: string;
+    url: string;
+    state: ModelAssetState;
+    assetContainer: AssetContainer;
+    isClone: boolean;
+    visibilityCallId?: number;
+};
+declare type ModelAssetState = 'notLoaded' | 'loading' | 'loaded' | 'inScene';
+/**
+ * Manager for handling 3d models.\
+ * Responsible for loading models and handling their visibility.\
+ * Also contains advanced features like model cloning.
+ */
+export declare class ModelManager {
+    protected viewer: Viewer;
+    /**
+     * CAUTION: this has to be in sync with the Combeenation backend!
+     * @internal
+     */
+    static readonly CBN_FALLBACK_MODEL_ASSET_NAME = "$fallback";
+    protected _modelAssets: {
+        [name: string]: Model;
+    };
+    protected _fallbackModelAsset: Model;
+    protected _loadModelPromises: {
+        [modelName: string]: Promise<void>;
+    };
+    get modelNames(): string[];
+    /**
+     * Nested models were targeted with slash notation previously, as Spec couldn't work with dots.
+     * Dots were interpreted as inherited model.
+     * Now the Hive viewer parameters are returning slash notated asset names, whereas the asset names from the
+     * prepacked asset manager are dot notated.
+     * This function converts slash to dot notation, so that models can be target with slash and dot notation alike.
+     */
+    protected static _replaceSlashes(inputStr: string): string;
+    constructor(viewer: Viewer);
+    /**
+     * Creates content for the fallback model, which is actually just a black cube.
+     * This is used for 3d assets that are linked in a data source but not available (yet).
+     * The Combeenation backend exchanges the missing 3d asset name with "$fallback", which indicates that we shouldn't
+     * throw an error but just show the fallback model instead.
+     *
+     * @internal
+     */
+    createFallbackModel(): void;
+    /**
+     * Register models for 3d viewer, this is required for each model before it can be loaded/shown.\
+     * The "viewer control" inside the Combeenation framework calls this function automatically with all assigned
+     * 3d assets.
+     */
+    registerModels(modelAssets: ModelAssetDefinition[]): void;
+    /**
+     * Loads the model and all it's assigned materials.\
+     * This function should be used for "eager loading" of models, so that model switching will be instant in the
+     * process.\
+     * If you don't plan to do this, just use {@link setModelVisibility} as this function will load the model under the
+     * hood the first time the model gets visible.
+     */
+    loadModel(name: string): Promise<void>;
+    /**
+     * Enables/disables multiple one or multiple models simultaniously.\
+     * All required models are loaded before adjusting the visibility to avoid flashing in the 3d scene.
+     *
+     * @returns Array of changed visibility status, combined with the corresponding model name
+     */
+    setModelVisibility(modelVisibility: ModelVisibilityEntry | ModelVisibilityEntry[]): Promise<ModelVisibilityEntry[]>;
+    /**
+     * Create a clone of an existing model.\
+     * Only the geometry (meshes, transform nodes) gets cloned, as materials are typically shared across the whole scene.
+     *
+     * @param show show model immediately after cloning
+     * @param options additional options for the cloning procedure, like renaming algorithms
+     */
+    cloneModel(name: string, newModelName: string, show?: boolean, options?: ModelCloneOptions): Promise<void>;
+    /**
+     * Removes a cloned model from the scene and from the internal model storage.\
+     * Deleted clones can not be shown again.
+     */
+    deleteClonedModel(name: string): void;
+    /**
+     * Removes all cloned models from the scene and the internal model storage.
+     */
+    deleteAllClonedModels(): void;
+    /**
+     * Loads and returns the asset container of a certain model.\
+     * This can be used to access the models content without having to add it to the scene.\
+     * A typical use case is to clone or instantiate a node from a "library" model.
+     */
+    getAssetContainerOfModel(name: string): Promise<AssetContainer>;
+    /**
+     * Get model by name
+     */
+    protected _getModel(name: string): Model | undefined;
+    /**
+     * Load model into scene, but don't show it immediately
+     */
+    protected _loadModel(model: Model): Promise<void>;
+    /**
+     * Apply parameter to the model in the asset container.
+     * This is typically done before the model is added to the scene to avoid changes on the visible model, which ensures
+     * a smooth model switch behaviour.
+     */
+    protected _prepareModelForScene(model: Model): Promise<void>;
+    /**
+     * Add assets of asset container to scene, do the scene preparation if required.
+     * CAUTION: model is expected to be in the correct loading state already.
+     *
+     * @param skipPreparation optionally skip applying parameter values to model before showing it
+     *                        (see {@link _prepareModelForScene})
+     */
+    protected _showModel(model: Model, skipPreparation?: boolean): Promise<void>;
+    /**
+     * Remove assets of asset container from scene
+     */
+    protected _hideModel(model: Model): void;
+    /**
+     * Creates and assigns each "deferred" material to the corresponding mesh, if the mesh is visible.
+     * Model should be ready to use immediately after this function has done it's job.
+     */
+    protected _applyDeferredMaterialsForAllVisibleMeshes(model: Model): Promise<void>;
+}
+export {};