@combeenation/3d-viewer 9.0.0 → 9.0.1

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

@@ -1,791 +1,826 @@
-"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.drawPaintableOnMaterial = exports.reportDuplicateNodeNames = exports.duplicateNodeNames = exports.intersectingNodeNames = exports.mapTags = exports.envHelperMetadataName = exports.backgroundDomeName = exports.changeEnvironment = exports.getClientRectFromMesh = exports.removeFromShadowGenerator = exports.addToShadowGenerator = exports.setReceiveShadows = exports.removeFromHighlightLayer = exports.addToHighlightLayer = exports.setMaterialRoughness = exports.setMaterialMetallness = exports.setMaterialTexture = exports.setMaterialColor = exports.setSourceNodeMaterial = exports.setMaterial = exports.transformTransformNode = exports.disableNodeWithParents = exports.enableNodeWithParents = exports.deactivateTransformNode = exports.activateTransformNode = exports.assertMeshCapability = exports.assertTransformNode = exports.injectMetadata = exports.applyMaterial = exports.getOrCreateMaterial = exports.cloneTransformNodeMaterial = exports.cloneNodeWithParents = exports.cloneTransformNode = exports.getDottedPathForNode = exports.mapToDottedNodes = exports.isTextureWithOnLoadObservable = exports.getRootNode = void 0;
-const dottedPath_1 = require("../classes/dottedPath");
-const event_1 = require("../classes/event");
-const sceneSetup_1 = require("../internal/sceneSetup");
-const sceneLoaderHelper_1 = require("./sceneLoaderHelper");
-const photoDome_1 = require("@babylonjs/core/Helpers/photoDome");
-const light_1 = require("@babylonjs/core/Lights/light");
-const baseTexture_1 = require("@babylonjs/core/Materials/Textures/baseTexture");
-const cubeTexture_1 = require("@babylonjs/core/Materials/Textures/cubeTexture");
-const dynamicTexture_1 = require("@babylonjs/core/Materials/Textures/dynamicTexture");
-const texture_1 = require("@babylonjs/core/Materials/Textures/texture");
-const math_axis_1 = require("@babylonjs/core/Maths/math.axis");
-const math_color_1 = require("@babylonjs/core/Maths/math.color");
-const math_vector_1 = require("@babylonjs/core/Maths/math.vector");
-const abstractMesh_1 = require("@babylonjs/core/Meshes/abstractMesh");
-const instancedMesh_1 = require("@babylonjs/core/Meshes/instancedMesh");
-const transformNode_1 = require("@babylonjs/core/Meshes/transformNode");
-const tags_1 = require("@babylonjs/core/Misc/tags");
-const tools_1 = require("@babylonjs/core/Misc/tools");
-const lodash_es_1 = require("lodash-es");
-const backgroundDomeName = 'BackgroundDome_ViewerGenerated';
-exports.backgroundDomeName = backgroundDomeName;
-const envHelperMetadataName = 'viewerEnvHelper';
-exports.envHelperMetadataName = envHelperMetadataName;
-const materialWaitingToBeSetMetadataName = 'materialWaitingToBeSet';
-/**
- * @param node
- * @return Node
- */
-const getRootNode = function (node) {
-    let _node = node;
-    while (_node.parent) {
-        _node = _node.parent;
-    }
-    return _node;
-};
-exports.getRootNode = getRootNode;
-/**
- * @param nodes
- * @param predicate
- * @return Map<DottedPath, T>
- */
-const mapToDottedNodes = function (nodes, predicate) {
-    const map = new Map();
-    const addNodes = function (_node) {
-        if (predicate && predicate(_node)) {
-            map.set(_node.metadata.dottedPath, _node);
-        }
-        _node.getChildren().forEach(child => {
-            addNodes(child);
-        });
-    };
-    nodes.forEach(node => {
-        addNodes(node);
-    });
-    return map;
-};
-exports.mapToDottedNodes = mapToDottedNodes;
-/**
- * @param node
- * @return DottedPath
- */
-const getDottedPathForNode = function (node) {
-    const dottedPath = dottedPath_1.DottedPath.create(node.name);
-    let _parent = node;
-    while (_parent.parent) {
-        _parent = _parent.parent;
-        dottedPath.unshiftPart(_parent.name);
-    }
-    return dottedPath;
-};
-exports.getDottedPathForNode = getDottedPathForNode;
-/**
- * @param node
- * @param nodeNamingStrategy
- * @param predicate
- * @param deep
- * @return TransformNode | null
- */
-const cloneTransformNode = function (node, nodeNamingStrategy, predicate, deep = true) {
-    if (predicate && !predicate(node)) {
-        return null;
-    }
-    const newName = nodeNamingStrategy.handler(node, nodeNamingStrategy.payload);
-    const clone = node.clone(newName, node.parent, true);
-    if (clone) {
-        clone.id = newName;
-        clone.metadata = (0, lodash_es_1.cloneDeep)(node.metadata);
-        injectMetadata(clone, { cloneSource: node }, false);
-        // if the cloned node is of type InstancedMesh, due to a bug(?),
-        // the InstancedMesh.isEnabled state may have changed after cloning.
-        // in that case, set the clone's enabled state to the original's state
-        if (node.constructor.name === 'InstancedMesh') {
-            clone.setEnabled(node.isEnabled(false));
-        }
-        // copying tags is a temporary workaround, as it doesn't work for TransformNodes ATM
-        // see https://forum.babylonjs.com/t/transformnode-clone-doesnt-contain-original-tags/38429/1
-        if (tags_1.Tags === null || tags_1.Tags === void 0 ? void 0 : tags_1.Tags.HasTags(node)) {
-            tags_1.Tags.AddTagsTo(clone, tags_1.Tags.GetTags(node, true));
-        }
-    }
-    if (deep) {
-        const children = node.getChildTransformNodes(true);
-        children.forEach(child => {
-            const clonedChild = cloneTransformNode(child, nodeNamingStrategy, predicate, deep);
-            if (clonedChild) {
-                clonedChild.parent = clone;
-            }
-        });
-    }
-    return clone;
-};
-exports.cloneTransformNode = cloneTransformNode;
-/**
- * @param node
- */
-const cloneNodeWithParents = function (node) {
-    let clone = null;
-    if (node instanceof transformNode_1.TransformNode) {
-        clone = node.clone(node.name, cloneNodeWithParents(node.parent), true);
-    }
-    else if (node instanceof light_1.Light) {
-        clone = node.clone(node.name, cloneNodeWithParents(node.parent));
-    }
-    else if (node) {
-        throw new Error(`Cloning of "${node === null || node === void 0 ? void 0 : node.constructor.name}" is not implemented (yet).`);
-    }
-    return clone;
-};
-exports.cloneNodeWithParents = cloneNodeWithParents;
-/**
- * @param node
- * @param deep
- * @param prefix
- * @return TransformNode
- */
-const cloneTransformNodeMaterial = function (node, prefix = '', deep = true) {
-    if (node instanceof abstractMesh_1.AbstractMesh && node.material) {
-        const newMatName = dottedPath_1.DottedPath.create(prefix).addParts([node.material.name, 'clone', node.uniqueId.toString()]);
-        node.material = node.material.clone(newMatName.path);
-    }
-    if (deep) {
-        const children = node.getChildTransformNodes(true);
-        children.forEach(child => cloneTransformNodeMaterial(child, prefix, deep));
-    }
-    return node;
-};
-exports.cloneTransformNodeMaterial = cloneTransformNodeMaterial;
-/**
- * @param object
- * @param deep
- * @param metadata
- */
-const injectMetadata = function (object, metadata, deep = true) {
-    object.metadata = (0, lodash_es_1.merge)({}, object.metadata, metadata);
-    if (deep && object instanceof transformNode_1.TransformNode) {
-        const children = object.getChildTransformNodes(true);
-        children.forEach(child => injectMetadata(child, metadata, deep));
-    }
-};
-exports.injectMetadata = injectMetadata;
-/**
- * @param node
- * @param assertCallable
- * @param callableParameters
- * @param deep
- */
-const assertTransformNode = function (node, assertCallable, callableParameters = [], deep = true) {
-    assertCallable(node, ...callableParameters);
-    if (deep) {
-        const children = node.getChildTransformNodes(true);
-        children.forEach(child => assertTransformNode(child, assertCallable, callableParameters, deep));
-    }
-};
-exports.assertTransformNode = assertTransformNode;
-/**
- * @param node
- * @param parameter
- */
-const assertMeshCapability = function (node, parameter) {
-    if (!(node instanceof abstractMesh_1.AbstractMesh)) {
-        const cls = node.getClassName();
-        throw new Error(`Changing parameter "${parameter}" of a(n) ${cls} is not supported. Tried to change node "${node.id}".`);
-    }
-    if (node instanceof instancedMesh_1.InstancedMesh) {
-        throw new Error(`Changing parameter "${parameter}" of an InstancedMesh is not supported. Tried to change node "${node.id}".`);
-    }
-};
-exports.assertMeshCapability = assertMeshCapability;
-/**
- * @param node
- * @param deep
- */
-const activateTransformNode = function (node, deep = true) {
-    node.setEnabled(true);
-    /*
-      if( node instanceof AbstractMesh ) {
-          node.visibility = 1;
-          node.isPickable = true;
-      }
-      */
-    if (deep) {
-        node.getChildTransformNodes(true).forEach(child => activateTransformNode(child, deep));
-    }
-};
-exports.activateTransformNode = activateTransformNode;
-/**
- * @param node
- * @param deep
- */
-const deactivateTransformNode = function (node, deep = true) {
-    node.setEnabled(false);
-    /*
-      if( node instanceof AbstractMesh ) {
-          node.visibility = 0;
-          node.isPickable = false;
-      }
-      */
-    if (deep) {
-        node.getChildTransformNodes(true).forEach(child => deactivateTransformNode(child, deep));
-    }
-};
-exports.deactivateTransformNode = deactivateTransformNode;
-/**
- * @param node
- */
-const enableNodeWithParents = function (node) {
-    node.setEnabled(true);
-    if (node.parent) {
-        enableNodeWithParents(node.parent);
-    }
-};
-exports.enableNodeWithParents = enableNodeWithParents;
-/**
- * @param node
- */
-const disableNodeWithParents = function (node) {
-    node.setEnabled(false);
-    if (node.parent) {
-        disableNodeWithParents(node.parent);
-    }
-};
-exports.disableNodeWithParents = disableNodeWithParents;
-/**
- * Applies a {@link TransformationDefinition} consecutively to ensure dependencies in positioning etc.
- * @param node
- * @param transformation
- */
-const transformTransformNode = function (node, transformation) {
-    // scaling
-    if (!(0, lodash_es_1.has)(node.metadata, 'scaling.initial')) {
-        injectMetadata(node, { 'scaling.initial': node.scaling }, false);
-    }
-    const initialScaling = (0, lodash_es_1.get)(node.metadata, 'scaling.initial');
-    node.scaling = initialScaling.multiply(transformation.scaling);
-    // position
-    if (!(0, lodash_es_1.has)(node.metadata, 'position.initial')) {
-        injectMetadata(node, { 'position.initial': node.absolutePosition.clone() }, false);
-    }
-    const initialPosition = (0, lodash_es_1.get)(node.metadata, 'position.initial');
-    node.setAbsolutePosition(initialPosition.add(transformation.position).multiply(transformation.scaling));
-    // rotation
-    if (!(0, lodash_es_1.has)(node.metadata, 'rotation.initial')) {
-        let rotationQuaternion = node.rotationQuaternion;
-        if (!rotationQuaternion) {
-            rotationQuaternion = math_vector_1.Quaternion.RotationYawPitchRoll(node.rotation.x, node.rotation.y, node.rotation.z);
-        }
-        injectMetadata(node, { 'rotation.initial': rotationQuaternion.asArray() }, false);
-    }
-    const initialRotationQuaternion = math_vector_1.Quaternion.FromArray((0, lodash_es_1.get)(node.metadata, 'rotation.initial'));
-    node.rotationQuaternion = initialRotationQuaternion;
-    node.rotateAround(math_vector_1.Vector3.Zero(), math_axis_1.Axis.X, transformation.rotation.x);
-    node.rotateAround(math_vector_1.Vector3.Zero(), math_axis_1.Axis.Y, transformation.rotation.y);
-    node.rotateAround(math_vector_1.Vector3.Zero(), math_axis_1.Axis.Z, transformation.rotation.z);
-    node.computeWorldMatrix(true);
-};
-exports.transformTransformNode = transformTransformNode;
-/**
- * Apply changes of environment (background texture, etc.) consecutively in order to avoid dependency related issues.
- * @param scene
- * @param envDef
- */
-const changeEnvironment = function (scene, envDef) {
-    var _a;
-    // issue warning if both background texture and usedefault are set
-    if (envDef.environmentUseDefault && envDef.environmentBackground) {
-        console.warn(`!!! Warning !!! Spec parameter 'environment.usedefault' is being overruled by 'environment.background'.`);
-    }
-    const useDefaultEnv = envDef.environmentUseDefault && !envDef.environmentBackground;
-    // 1) set ENVIRONMENT_COLOR
-    const clearColorBefore = scene.clearColor.toString();
-    scene.clearColor = envDef.environmentColor
-        ? math_color_1.Color4.FromColor3(envDef.environmentColor)
-        : useDefaultEnv
-            ? sceneSetup_1.defaultEnvHelperColor
-            : sceneSetup_1.defaultSceneClearColor;
-    const clearColorChanged = clearColorBefore !== scene.clearColor.toString();
-    // 2) dispose existing & set new ENVIRONMENT (==texture)
-    const curEnvTexture = scene.environmentTexture;
-    const envTextureChanged = envDef.environment !== (curEnvTexture === null || curEnvTexture === void 0 ? void 0 : curEnvTexture.url);
-    if (curEnvTexture && (!envDef.environment || envTextureChanged)) {
-        curEnvTexture.dispose();
-    }
-    const rotation = envDef.environmentRotation !== undefined ? tools_1.Tools.ToRadians(envDef.environmentRotation) : 0;
-    if (envDef.environment && envTextureChanged) {
-        const envTexture = cubeTexture_1.CubeTexture.CreateFromPrefilteredData(envDef.environment, scene);
-        envTexture.rotationY = rotation;
-        scene.environmentTexture = envTexture;
-    }
-    else if (curEnvTexture && curEnvTexture.rotationY !== rotation) {
-        curEnvTexture.rotationY = rotation;
-    }
-    // 3) dispose existing & set new ENVIRONMENT_BACKGROUND
-    const curDome = scene.getNodeByName(backgroundDomeName);
-    const backgroundUrlChanged = envDef.environmentBackground !== (curDome === null || curDome === void 0 ? void 0 : curDome.texture.url);
-    if (curDome && (!envDef.environmentBackground || backgroundUrlChanged)) {
-        curDome.dispose();
-    }
-    const rotationPhotoDome = -1 * rotation;
-    if (envDef.environmentBackground && backgroundUrlChanged) {
-        const textureUrl = envDef.environmentBackground;
-        const dome = new photoDome_1.PhotoDome(backgroundDomeName, textureUrl, { resolution: 32, size: 450 }, scene);
-        // Rotate submesh to get them in line with environment texture
-        dome.getChildMeshes(true)[0].rotation.y = tools_1.Tools.ToRadians(90);
-        dome.rotation.y = rotationPhotoDome;
-    }
-    else if (curDome && curDome.rotation.y !== rotationPhotoDome) {
-        curDome.rotation.y = rotationPhotoDome;
-    }
-    // 4) dispose existing & set new ENVIRONMENT_USEDEFAULT (only if no background is set)
-    const curEnvHelper = (_a = scene.metadata) === null || _a === void 0 ? void 0 : _a[envHelperMetadataName];
-    if (curEnvHelper && !useDefaultEnv) {
-        curEnvHelper.dispose();
-        delete scene.metadata[envHelperMetadataName];
-    }
-    const envHelperMainColor = math_color_1.Color3.FromArray(scene.clearColor.asArray());
-    if (useDefaultEnv && !curEnvHelper) {
-        const envHelper = scene.createDefaultEnvironment({ sizeAuto: true });
-        envHelper === null || envHelper === void 0 ? void 0 : envHelper.setMainColor(envHelperMainColor);
-        if (envHelper) {
-            scene.metadata = (0, lodash_es_1.merge)({}, scene.metadata, { [envHelperMetadataName]: envHelper });
-        }
-    }
-    else if (curEnvHelper && useDefaultEnv && clearColorChanged) {
-        curEnvHelper.setMainColor(envHelperMainColor);
-    }
-    // 5) set ENVIRONMENT_INTENSITY
-    if (envDef.environmentIntensity !== undefined) {
-        scene.environmentIntensity = envDef.environmentIntensity;
-    }
-};
-exports.changeEnvironment = changeEnvironment;
-/**
- * Sets a material by a given material id as material property on the given node.
- *
- * If the material is not already available in the scene, the viewer tries to create a material based on a Combeenation
- * [material asset](https://docs.combeenation.com/docs/howto-create-and-use-babylon-and-material-asset).
- * This of course only works if the viewer is used inside a Combeenation configurator.
- *
- * Furthermore this function also defers the material creation if the node is not visible yet to improve network &
- * viewer bootstrap performance as textures are automatically being lazy loaded only when they are actually visible in
- * the scene.
- *
- * Finally the material will not be applied before all its textures have been loaded. In this way "flickering" effects
- * will be avoided, since the material would be incomplete without its loaded textures.
- */
-const setMaterial = function (node, materialId, deep = true, variant) {
-    if (node instanceof abstractMesh_1.AbstractMesh) {
-        const materialExists = node.getScene().getMaterialById(materialId);
-        const hasMissingMaterial = (0, lodash_es_1.has)(node.metadata, sceneLoaderHelper_1.missingMaterialMetadataName);
-        const deferMaterialCreation = !materialExists && !node.isEnabled();
-        if (deferMaterialCreation) {
-            // do not set the material
-            injectMetadata(node, { [sceneLoaderHelper_1.missingMaterialMetadataName]: materialId }, false);
-            // if it already had the missing material flag before, there already exists an observer...
-            if (!hasMissingMaterial) {
-                (0, sceneLoaderHelper_1.addMissingMaterialObserver)(node);
-            }
-        }
-        else {
-            // create material and apply it when textures have been loaded
-            getOrCreateMaterial(node.getScene(), materialId, variant).then(material => {
-                applyMaterial(material, node).then(() => event_1.emitter.emit(event_1.Event.MESH_MATERIAL_APPLIED, node, material));
-                if (hasMissingMaterial) {
-                    delete node.metadata[sceneLoaderHelper_1.missingMaterialMetadataName];
-                }
-            });
-        }
-    }
-    // recursively set materials on children (if desired)
-    if (deep) {
-        for (const child of node.getChildTransformNodes(true)) {
-            setMaterial(child, materialId, deep, variant);
-        }
-    }
-};
-exports.setMaterial = setMaterial;
-/**
- * Gets the Material either from the given {@link Variant}, the given scene or tries to create it from an Combeenation
- * material asset when inside a Combeenation configurator.
- */
-const getOrCreateMaterial = function (scene, materialId, variant) {
-    return __awaiter(this, void 0, void 0, function* () {
-        let chosenMaterial;
-        chosenMaterial = variant === null || variant === void 0 ? void 0 : variant.inheritedMaterials.find(mat => mat.id === materialId);
-        chosenMaterial = chosenMaterial || scene.materials.find(mat => mat.id === materialId);
-        chosenMaterial = chosenMaterial || (yield (0, sceneLoaderHelper_1.createMaterialFromCbnAssets)(materialId, scene));
-        if (chosenMaterial) {
-            return chosenMaterial;
-        }
-        // reject when material was not found
-        let rejectMessage = `Material with id "${materialId}" does not exist on scene.`;
-        if (variant) {
-            rejectMessage = `Material with id "${materialId}" does not exist for variant "${variant.id}".`;
-        }
-        throw new Error(rejectMessage);
-    });
-};
-exports.getOrCreateMaterial = getOrCreateMaterial;
-/**
- * Waits until the materials textures are loaded and shaders are compiled.
- * Then sets the material on the node if there is no newer "set material" request
- */
-const applyMaterial = function (material, node) {
-    var _a;
-    return __awaiter(this, void 0, void 0, function* () {
-        // set current material id as last valid id, in this case all previously set materials on the node will be invalidated
-        injectMetadata(node, { [materialWaitingToBeSetMetadataName]: material.id }, false);
-        const promTexturesReady = new Promise(resolve => baseTexture_1.BaseTexture.WhenAllReady(material.getActiveTextures(), resolve));
-        // 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
-        const promMaterialCompiled = material.forceCompilationAsync(node);
-        // 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([promTexturesReady, promMaterialCompiled]);
-        // textures ready, now check if the material is still up-to-date
-        if (material.id === ((_a = node.metadata) === null || _a === void 0 ? void 0 : _a[materialWaitingToBeSetMetadataName])) {
-            node.material = material;
-            delete node.metadata[materialWaitingToBeSetMetadataName];
-        }
-    });
-};
-exports.applyMaterial = applyMaterial;
-/**
- * !!! Warning !!!
- * This function is not public API. Whilst it can help solving certain problems, it only works reliably in well defined
- * situations and can cause unwanted side effects under some conditions. Use carefully at your own risk!
- *
- * See https://combeenation.myjetbrains.com/youtrack/issue/CB-5906 for further details regarding this warning.
- *
- * Set material of an instanced meshes source mesh.
- * Changes the material of all instanced meshes which have the same source mesh.
- *
- * @param node
- * @param material
- * @param deep
- *
- * @ignore
- */
-const setSourceNodeMaterial = function (node, material, deep = true) {
-    const warn = `	You're using "setSourceNodeMaterial" which is not public API.
-	Whilst it can help solving certain problems, it only works reliably in well defined situations and can cause unwanted side effects under some conditions.
-	Use carefully at your own risk!`;
-    console.warn(`!!! Warning !!!\n${warn}`);
-    if (node instanceof instancedMesh_1.InstancedMesh) {
-        node.sourceMesh.material = material;
-    }
-    if (deep) {
-        node.getChildTransformNodes(true).forEach(child => setSourceNodeMaterial(child, material, deep));
-    }
-};
-exports.setSourceNodeMaterial = setSourceNodeMaterial;
-/**
- * @param node
- * @param color
- * @param deep
- */
-const setMaterialColor = function (node, color, deep = true) {
-    if (node instanceof abstractMesh_1.AbstractMesh && node.material) {
-        const materialCls = node.material.getClassName();
-        switch (materialCls) {
-            case 'PBRMaterial':
-                node.material.albedoColor = color.toLinearSpace();
-                break;
-            case 'StandardMaterial':
-                node.material.diffuseColor = color;
-                break;
-            default:
-                throw new Error(`Setting color for material of instance "${materialCls}" not implemented (yet).`);
-        }
-        setMaterial(node, node.material.id, false);
-    }
-    if (deep) {
-        node.getChildTransformNodes(true).forEach(child => setMaterialColor(child, color, deep));
-    }
-};
-exports.setMaterialColor = setMaterialColor;
-/**
- * @param node
- * @param texture
- * @param deep
- */
-const setMaterialTexture = function (node, texture, deep = true) {
-    if (node instanceof abstractMesh_1.AbstractMesh && node.material) {
-        const materialCls = node.material.getClassName();
-        switch (materialCls) {
-            case 'PBRMaterial':
-                node.material.albedoTexture = texture;
-                break;
-            case 'StandardMaterial':
-                node.material.diffuseTexture = texture;
-                break;
-            default:
-                throw new Error(`Setting texture for material of instance "${materialCls}" not implemented (yet).`);
-        }
-        setMaterial(node, node.material.id, false);
-    }
-    if (deep) {
-        node.getChildTransformNodes(true).forEach(child => setMaterialTexture(child, texture, deep));
-    }
-};
-exports.setMaterialTexture = setMaterialTexture;
-/**
- * @param node
- * @param metallness
- * @param deep
- */
-const setMaterialMetallness = function (node, metallness, deep = true) {
-    if (node instanceof abstractMesh_1.AbstractMesh && node.material) {
-        const materialCls = node.material.getClassName();
-        switch (materialCls) {
-            case 'PBRMaterial':
-                node.material.metallic = metallness;
-                break;
-            default:
-                throw new Error(`Setting metallness for material of instance "${materialCls}" not implemented (yet).`);
-        }
-        setMaterial(node, node.material.id, false);
-    }
-    if (deep) {
-        node.getChildTransformNodes(true).forEach(child => setMaterialMetallness(child, metallness, deep));
-    }
-};
-exports.setMaterialMetallness = setMaterialMetallness;
-/**
- * @param node
- * @param roughness
- * @param deep
- */
-const setMaterialRoughness = function (node, roughness, deep = true) {
-    if (node instanceof abstractMesh_1.AbstractMesh && node.material) {
-        const materialCls = node.material.getClassName();
-        switch (materialCls) {
-            case 'PBRMaterial':
-                node.material.roughness = roughness;
-                break;
-            case 'StandardMaterial':
-                node.material.roughness = roughness;
-                break;
-            default:
-                throw new Error(`Setting roughness for material of instance "${materialCls}" not implemented (yet).`);
-        }
-        setMaterial(node, node.material.id, false);
-    }
-    if (deep) {
-        node.getChildTransformNodes(true).forEach(child => setMaterialRoughness(child, roughness, deep));
-    }
-};
-exports.setMaterialRoughness = setMaterialRoughness;
-/**
- * @param node
- * @param layer
- * @param color
- * @param deep
- */
-const addToHighlightLayer = function (layer, color, node, deep = true) {
-    if (node instanceof abstractMesh_1.AbstractMesh) {
-        layer.addMesh(node, color);
-    }
-    if (deep) {
-        node.getChildTransformNodes(true).forEach(child => addToHighlightLayer(layer, color, child, deep));
-    }
-};
-exports.addToHighlightLayer = addToHighlightLayer;
-/**
- * @param node
- * @param layer
- * @param deep
- */
-const removeFromHighlightLayer = function (layer, node, deep = true) {
-    if (node instanceof abstractMesh_1.AbstractMesh) {
-        layer.removeMesh(node);
-    }
-    if (deep) {
-        node.getChildTransformNodes(true).forEach(child => removeFromHighlightLayer(layer, child, deep));
-    }
-};
-exports.removeFromHighlightLayer = removeFromHighlightLayer;
-/**
- * @param node
- * @param receiveShadows
- * @param deep
- */
-const setReceiveShadows = function (node, receiveShadows, deep = true) {
-    if (node instanceof abstractMesh_1.AbstractMesh) {
-        node.receiveShadows = receiveShadows;
-    }
-    if (deep) {
-        node.getChildTransformNodes(true).forEach(child => setReceiveShadows(child, receiveShadows, deep));
-    }
-};
-exports.setReceiveShadows = setReceiveShadows;
-/**
- * @param node
- * @param generator
- * @param deep
- */
-const addToShadowGenerator = function (generator, node, deep = true) {
-    if (node instanceof abstractMesh_1.AbstractMesh) {
-        // We have to remove the node because there's no duplicate check in babylon
-        generator.removeShadowCaster(node, false);
-        generator.addShadowCaster(node, false);
-    }
-    if (deep) {
-        node.getChildTransformNodes(true).forEach(child => addToShadowGenerator(generator, child, deep));
-    }
-};
-exports.addToShadowGenerator = addToShadowGenerator;
-/**
- * @param node
- * @param generator
- * @param deep
- */
-const removeFromShadowGenerator = function (generator, node, deep = true) {
-    if (node instanceof abstractMesh_1.AbstractMesh) {
-        generator.removeShadowCaster(node, false);
-    }
-    if (deep) {
-        node.getChildTransformNodes(true).forEach(child => removeFromShadowGenerator(generator, child, deep));
-    }
-};
-exports.removeFromShadowGenerator = removeFromShadowGenerator;
-/**
- * https://forum.babylonjs.com/t/get-mesh-bounding-box-position-and-size-in-2d-screen-coordinates/1058/3
- * @param mesh
- * @param scene
- * @param canvas
- */
-const getClientRectFromMesh = function (mesh, scene, canvas) {
-    // get bounding box of the mesh
-    const meshVectors = mesh.getBoundingInfo().boundingBox.vectors;
-    // get the matrix and viewport needed to project the vectors onto the screen
-    const worldMatrix = mesh.getWorldMatrix();
-    const transformMatrix = scene.getTransformMatrix();
-    const viewport = scene.activeCamera.viewport;
-    // loop though all the vectors and project them against the current camera viewport to get a set of coordinates
-    const coordinates = meshVectors.map(vector => {
-        const projection = math_vector_1.Vector3.Project(vector, worldMatrix, transformMatrix, viewport);
-        projection.x = projection.x * canvas.clientWidth;
-        projection.y = projection.y * canvas.clientHeight;
-        return projection;
-    });
-    // get the min and max for all the coordinates so we can calculate the largest possible screen size
-    const maxX = Math.max(...coordinates.map(o => o.x));
-    const minX = Math.min(...coordinates.map(o => o.x));
-    const maxY = Math.max(...coordinates.map(o => o.y));
-    const minY = Math.min(...coordinates.map(o => o.y));
-    // return a ClientRect from this
-    return {
-        width: maxX - minX,
-        height: maxY - minY,
-        left: minX,
-        top: minY,
-        right: maxX,
-        bottom: maxY,
-    };
-};
-exports.getClientRectFromMesh = getClientRectFromMesh;
-/**
- * This type guard checks whether the given `BaseTextures` is any of its subtypes which comes with an
- * `onLoadObservable`.
- *
- * !!! Timing of when this function is called is important !!!
- * See the following for more details: https://forum.babylonjs.com/t/basetexture-whenallready-returns-too-early/34501/6
- */
-const isTextureWithOnLoadObservable = function (texture) {
-    return !!texture.onLoadObservable;
-};
-exports.isTextureWithOnLoadObservable = isTextureWithOnLoadObservable;
-/**
- * @param objects
- * @param tagMapping
- */
-const mapTags = function (objects, tagMapping) {
-    var _a;
-    let affectedTags = [];
-    for (const object of objects) {
-        const oldTags = Object.keys((_a = tags_1.Tags.GetTags(object, false)) !== null && _a !== void 0 ? _a : {});
-        const mappedTags = oldTags.map(t => tagMapping[t] || t);
-        tags_1.Tags.RemoveTagsFrom(object, oldTags.join(' '));
-        tags_1.Tags.AddTagsTo(object, mappedTags.join(' '));
-        affectedTags = [...affectedTags, ...mappedTags];
-    }
-    return (0, lodash_es_1.uniq)(affectedTags);
-};
-exports.mapTags = mapTags;
-/**
- * Gets an array of ids for nodeIds that exist in both TransformNode arrays.
- * @param nodes1
- * @param nodes2
- * @param predicate
- */
-const intersectingNodeNames = function (nodes1, nodes2, predicate) {
-    const nodeNames1 = nodes1.filter(n => !predicate || predicate(n)).map(n => n.name);
-    const nodesNames2 = nodes2.filter(n => !predicate || predicate(n)).map(n => n.name);
-    return nodeNames1.filter(n1 => nodesNames2.includes(n1));
-};
-exports.intersectingNodeNames = intersectingNodeNames;
-/**
- * Gets an array of ids for duplicate nodeIds in given node array.
- * @param nodes
- * @param predicate
- */
-const duplicateNodeNames = function (nodes, predicate) {
-    const nodeNames = nodes.filter(n => !predicate || predicate(n)).map(n => n.name);
-    return nodeNames.filter((v, i, self) => self.indexOf(v) !== i);
-};
-exports.duplicateNodeNames = duplicateNodeNames;
-/**
- * Reports duplicate nodeIds.
- * @param nodeNames
- */
-const reportDuplicateNodeNames = function (nodeNames) {
-    var _a;
-    if (nodeNames.length > 0) {
-        const warn = `There are duplicate nodeNames: ${nodeNames.join(', ')}`;
-        console.warn(`!!! Warning !!!\n${warn}`);
-        (_a = window.Cbn) === null || _a === void 0 ? void 0 : _a.Assets.reportDuplicateNodeName(nodeNames);
-    }
-};
-exports.reportDuplicateNodeNames = reportDuplicateNodeNames;
-const drawPaintableOnMaterial = function (material, imageSource, scene, options) {
-    var _a, _b, _c, _d;
-    // always take width and height from image source, scaling is done with uvScale properties
-    const widthAndHeight = {
-        width: imageSource.width,
-        height: imageSource.height,
-    };
-    const texture = new dynamicTexture_1.DynamicTexture(`${material.id}.paintable_texture`, widthAndHeight, scene);
-    // draw image on texture
-    const ctx = texture.getContext();
-    ctx.drawImage(imageSource, 0, 0);
-    texture.update();
-    // apply settings from paintable options to tweak position and scaling of image on the texture
-    texture.uScale = (_a = options === null || options === void 0 ? void 0 : options.uScale) !== null && _a !== void 0 ? _a : texture.uScale;
-    texture.vScale = (_b = options === null || options === void 0 ? void 0 : options.vScale) !== null && _b !== void 0 ? _b : texture.vScale;
-    texture.uOffset = (_c = options === null || options === void 0 ? void 0 : options.uOffset) !== null && _c !== void 0 ? _c : texture.uOffset;
-    texture.vOffset = (_d = options === null || options === void 0 ? void 0 : options.vOffset) !== null && _d !== void 0 ? _d : texture.vOffset;
-    // wrap mode is preferred, as it will always show the texture, no matter which position offset is currently chosen
-    // clamp mode requires more knowledge (and patience) when adjusting the uv scale and offset values
-    texture.wrapU = texture_1.Texture.WRAP_ADDRESSMODE;
-    texture.wrapV = texture_1.Texture.WRAP_ADDRESSMODE;
-    // apply the paintable texture on the dedicated material type
-    const materialCls = material.getClassName();
-    switch (materialCls) {
-        case 'PBRMaterial':
-            material.albedoTexture = texture;
-            break;
-        case 'StandardMaterial':
-            material.diffuseTexture = texture;
-            break;
-        default:
-            throw new Error(`Setting paintable texture for material of instance "${materialCls}" not implemented (yet).`);
-    }
-};
-exports.drawPaintableOnMaterial = drawPaintableOnMaterial;
+"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.drawPaintableOnMaterial = exports.reportDuplicateNodeNames = exports.duplicateNodeNames = exports.intersectingNodeNames = exports.mapTags = exports.envHelperMetadataName = exports.backgroundDomeName = exports.changeEnvironment = exports.getClientRectFromMesh = exports.removeFromShadowGenerator = exports.addToShadowGenerator = exports.setReceiveShadows = exports.removeFromHighlightLayer = exports.addToHighlightLayer = exports.setMaterialRoughness = exports.setMaterialMetallness = exports.setMaterialTexture = exports.setMaterialColor = exports.setSourceNodeMaterial = exports.setMaterial = exports.transformTransformNode = exports.disableNodeWithParents = exports.enableNodeWithParents = exports.deactivateTransformNode = exports.activateTransformNode = exports.assertMeshCapability = exports.assertTransformNode = exports.injectMetadata = exports.applyMaterial = exports.getOrCreateMaterial = exports.cloneTransformNodeMaterial = exports.cloneNodeWithParents = exports.cloneTransformNode = exports.getDottedPathForNode = exports.mapToDottedNodes = exports.isTextureWithOnLoadObservable = exports.getRootNode = void 0;
+const dottedPath_1 = require("../classes/dottedPath");
+const event_1 = require("../classes/event");
+const sceneSetup_1 = require("../internal/sceneSetup");
+const sceneLoaderHelper_1 = require("./sceneLoaderHelper");
+const photoDome_1 = require("@babylonjs/core/Helpers/photoDome");
+const light_1 = require("@babylonjs/core/Lights/light");
+const baseTexture_1 = require("@babylonjs/core/Materials/Textures/baseTexture");
+const cubeTexture_1 = require("@babylonjs/core/Materials/Textures/cubeTexture");
+const dynamicTexture_1 = require("@babylonjs/core/Materials/Textures/dynamicTexture");
+const texture_1 = require("@babylonjs/core/Materials/Textures/texture");
+const math_axis_1 = require("@babylonjs/core/Maths/math.axis");
+const math_color_1 = require("@babylonjs/core/Maths/math.color");
+const math_vector_1 = require("@babylonjs/core/Maths/math.vector");
+const abstractMesh_1 = require("@babylonjs/core/Meshes/abstractMesh");
+const instancedMesh_1 = require("@babylonjs/core/Meshes/instancedMesh");
+const transformNode_1 = require("@babylonjs/core/Meshes/transformNode");
+const tags_1 = require("@babylonjs/core/Misc/tags");
+const tools_1 = require("@babylonjs/core/Misc/tools");
+const lodash_es_1 = require("lodash-es");
+const backgroundDomeName = 'BackgroundDome_ViewerGenerated';
+exports.backgroundDomeName = backgroundDomeName;
+const envHelperMetadataName = 'viewerEnvHelper';
+exports.envHelperMetadataName = envHelperMetadataName;
+const materialWaitingToBeSetMetadataName = 'materialWaitingToBeSet';
+// Holds pending `createMaterialFromCbnAssets` promises for dedicated material ids
+// In this case we can make sure that a single material is not requested multiple times if used in various nodes
+const getMaterialPromises = new Map();
+/**
+ * @param node
+ * @return Node
+ */
+const getRootNode = function (node) {
+    let _node = node;
+    while (_node.parent) {
+        _node = _node.parent;
+    }
+    return _node;
+};
+exports.getRootNode = getRootNode;
+/**
+ * @param nodes
+ * @param predicate
+ * @return Map<DottedPath, T>
+ */
+const mapToDottedNodes = function (nodes, predicate) {
+    const map = new Map();
+    const addNodes = function (_node) {
+        if (predicate && predicate(_node)) {
+            map.set(_node.metadata.dottedPath, _node);
+        }
+        _node.getChildren().forEach(child => {
+            addNodes(child);
+        });
+    };
+    nodes.forEach(node => {
+        addNodes(node);
+    });
+    return map;
+};
+exports.mapToDottedNodes = mapToDottedNodes;
+/**
+ * @param node
+ * @return DottedPath
+ */
+const getDottedPathForNode = function (node) {
+    const dottedPath = dottedPath_1.DottedPath.create(node.name);
+    let _parent = node;
+    while (_parent.parent) {
+        _parent = _parent.parent;
+        dottedPath.unshiftPart(_parent.name);
+    }
+    return dottedPath;
+};
+exports.getDottedPathForNode = getDottedPathForNode;
+/**
+ * @param node
+ * @param nodeNamingStrategy
+ * @param predicate
+ * @param deep
+ * @return TransformNode | null
+ */
+const cloneTransformNode = function (node, nodeNamingStrategy, predicate, deep = true) {
+    if (predicate && !predicate(node)) {
+        return null;
+    }
+    const newName = nodeNamingStrategy.handler(node, nodeNamingStrategy.payload);
+    const clone = node.clone(newName, node.parent, true);
+    if (clone) {
+        clone.id = newName;
+        clone.metadata = (0, lodash_es_1.cloneDeep)(node.metadata);
+        injectMetadata(clone, { cloneSource: node }, false);
+        // if the cloned node is of type InstancedMesh, due to a bug(?),
+        // the InstancedMesh.isEnabled state may have changed after cloning.
+        // in that case, set the clone's enabled state to the original's state
+        if (node.constructor.name === 'InstancedMesh') {
+            clone.setEnabled(node.isEnabled(false));
+        }
+        // copying tags is a temporary workaround, as it doesn't work for TransformNodes ATM
+        // see https://forum.babylonjs.com/t/transformnode-clone-doesnt-contain-original-tags/38429/1
+        if (tags_1.Tags === null || tags_1.Tags === void 0 ? void 0 : tags_1.Tags.HasTags(node)) {
+            tags_1.Tags.AddTagsTo(clone, tags_1.Tags.GetTags(node, true));
+        }
+    }
+    if (deep) {
+        const children = node.getChildTransformNodes(true);
+        children.forEach(child => {
+            const clonedChild = cloneTransformNode(child, nodeNamingStrategy, predicate, deep);
+            if (clonedChild) {
+                clonedChild.parent = clone;
+            }
+        });
+    }
+    return clone;
+};
+exports.cloneTransformNode = cloneTransformNode;
+/**
+ * @param node
+ */
+const cloneNodeWithParents = function (node) {
+    let clone = null;
+    if (node instanceof transformNode_1.TransformNode) {
+        clone = node.clone(node.name, cloneNodeWithParents(node.parent), true);
+    }
+    else if (node instanceof light_1.Light) {
+        clone = node.clone(node.name, cloneNodeWithParents(node.parent));
+    }
+    else if (node) {
+        throw new Error(`Cloning of "${node === null || node === void 0 ? void 0 : node.constructor.name}" is not implemented (yet).`);
+    }
+    return clone;
+};
+exports.cloneNodeWithParents = cloneNodeWithParents;
+/**
+ * @param node
+ * @param deep
+ * @param prefix
+ * @return TransformNode
+ */
+const cloneTransformNodeMaterial = function (node, prefix = '', deep = true) {
+    if (node instanceof abstractMesh_1.AbstractMesh && node.material) {
+        const newMatName = dottedPath_1.DottedPath.create(prefix).addParts([node.material.name, 'clone', node.uniqueId.toString()]);
+        node.material = node.material.clone(newMatName.path);
+    }
+    if (deep) {
+        const children = node.getChildTransformNodes(true);
+        children.forEach(child => cloneTransformNodeMaterial(child, prefix, deep));
+    }
+    return node;
+};
+exports.cloneTransformNodeMaterial = cloneTransformNodeMaterial;
+/**
+ * @param object
+ * @param deep
+ * @param metadata
+ */
+const injectMetadata = function (object, metadata, deep = true) {
+    object.metadata = (0, lodash_es_1.merge)({}, object.metadata, metadata);
+    if (deep && object instanceof transformNode_1.TransformNode) {
+        const children = object.getChildTransformNodes(true);
+        children.forEach(child => injectMetadata(child, metadata, deep));
+    }
+};
+exports.injectMetadata = injectMetadata;
+/**
+ * @param node
+ * @param assertCallable
+ * @param callableParameters
+ * @param deep
+ */
+const assertTransformNode = function (node, assertCallable, callableParameters = [], deep = true) {
+    assertCallable(node, ...callableParameters);
+    if (deep) {
+        const children = node.getChildTransformNodes(true);
+        children.forEach(child => assertTransformNode(child, assertCallable, callableParameters, deep));
+    }
+};
+exports.assertTransformNode = assertTransformNode;
+/**
+ * @param node
+ * @param parameter
+ */
+const assertMeshCapability = function (node, parameter) {
+    if (!(node instanceof abstractMesh_1.AbstractMesh)) {
+        const cls = node.getClassName();
+        throw new Error(`Changing parameter "${parameter}" of a(n) ${cls} is not supported. Tried to change node "${node.id}".`);
+    }
+    if (node instanceof instancedMesh_1.InstancedMesh) {
+        throw new Error(`Changing parameter "${parameter}" of an InstancedMesh is not supported. Tried to change node "${node.id}".`);
+    }
+};
+exports.assertMeshCapability = assertMeshCapability;
+/**
+ * @param node
+ * @param deep
+ */
+const activateTransformNode = function (node, deep = true) {
+    node.setEnabled(true);
+    /*
+      if( node instanceof AbstractMesh ) {
+          node.visibility = 1;
+          node.isPickable = true;
+      }
+      */
+    if (deep) {
+        node.getChildTransformNodes(true).forEach(child => activateTransformNode(child, deep));
+    }
+};
+exports.activateTransformNode = activateTransformNode;
+/**
+ * @param node
+ * @param deep
+ */
+const deactivateTransformNode = function (node, deep = true) {
+    node.setEnabled(false);
+    /*
+      if( node instanceof AbstractMesh ) {
+          node.visibility = 0;
+          node.isPickable = false;
+      }
+      */
+    if (deep) {
+        node.getChildTransformNodes(true).forEach(child => deactivateTransformNode(child, deep));
+    }
+};
+exports.deactivateTransformNode = deactivateTransformNode;
+/**
+ * @param node
+ */
+const enableNodeWithParents = function (node) {
+    node.setEnabled(true);
+    if (node.parent) {
+        enableNodeWithParents(node.parent);
+    }
+};
+exports.enableNodeWithParents = enableNodeWithParents;
+/**
+ * @param node
+ */
+const disableNodeWithParents = function (node) {
+    node.setEnabled(false);
+    if (node.parent) {
+        disableNodeWithParents(node.parent);
+    }
+};
+exports.disableNodeWithParents = disableNodeWithParents;
+/**
+ * Applies a {@link TransformationDefinition} consecutively to ensure dependencies in positioning etc.
+ * @param node
+ * @param transformation
+ */
+const transformTransformNode = function (node, transformation) {
+    // scaling
+    if (!(0, lodash_es_1.has)(node.metadata, 'scaling.initial')) {
+        injectMetadata(node, { 'scaling.initial': node.scaling }, false);
+    }
+    const initialScaling = (0, lodash_es_1.get)(node.metadata, 'scaling.initial');
+    node.scaling = initialScaling.multiply(transformation.scaling);
+    // position
+    if (!(0, lodash_es_1.has)(node.metadata, 'position.initial')) {
+        injectMetadata(node, { 'position.initial': node.absolutePosition.clone() }, false);
+    }
+    const initialPosition = (0, lodash_es_1.get)(node.metadata, 'position.initial');
+    node.setAbsolutePosition(initialPosition.add(transformation.position).multiply(transformation.scaling));
+    // rotation
+    if (!(0, lodash_es_1.has)(node.metadata, 'rotation.initial')) {
+        let rotationQuaternion = node.rotationQuaternion;
+        if (!rotationQuaternion) {
+            rotationQuaternion = math_vector_1.Quaternion.RotationYawPitchRoll(node.rotation.x, node.rotation.y, node.rotation.z);
+        }
+        injectMetadata(node, { 'rotation.initial': rotationQuaternion.asArray() }, false);
+    }
+    const initialRotationQuaternion = math_vector_1.Quaternion.FromArray((0, lodash_es_1.get)(node.metadata, 'rotation.initial'));
+    node.rotationQuaternion = initialRotationQuaternion;
+    node.rotateAround(math_vector_1.Vector3.Zero(), math_axis_1.Axis.X, transformation.rotation.x);
+    node.rotateAround(math_vector_1.Vector3.Zero(), math_axis_1.Axis.Y, transformation.rotation.y);
+    node.rotateAround(math_vector_1.Vector3.Zero(), math_axis_1.Axis.Z, transformation.rotation.z);
+    node.computeWorldMatrix(true);
+};
+exports.transformTransformNode = transformTransformNode;
+/**
+ * Apply changes of environment (background texture, etc.) consecutively in order to avoid dependency related issues.
+ * @param scene
+ * @param envDef
+ */
+const changeEnvironment = function (scene, envDef) {
+    var _a;
+    // issue warning if both background texture and usedefault are set
+    if (envDef.environmentUseDefault && envDef.environmentBackground) {
+        console.warn(`!!! Warning !!! Spec parameter 'environment.usedefault' is being overruled by 'environment.background'.`);
+    }
+    const useDefaultEnv = envDef.environmentUseDefault && !envDef.environmentBackground;
+    // 1) set ENVIRONMENT_COLOR
+    const clearColorBefore = scene.clearColor.toString();
+    scene.clearColor = envDef.environmentColor
+        ? math_color_1.Color4.FromColor3(envDef.environmentColor)
+        : useDefaultEnv
+            ? sceneSetup_1.defaultEnvHelperColor
+            : sceneSetup_1.defaultSceneClearColor;
+    const clearColorChanged = clearColorBefore !== scene.clearColor.toString();
+    // 2) dispose existing & set new ENVIRONMENT (==texture)
+    const curEnvTexture = scene.environmentTexture;
+    const envTextureChanged = envDef.environment !== (curEnvTexture === null || curEnvTexture === void 0 ? void 0 : curEnvTexture.url);
+    if (curEnvTexture && (!envDef.environment || envTextureChanged)) {
+        curEnvTexture.dispose();
+    }
+    const rotation = envDef.environmentRotation !== undefined ? tools_1.Tools.ToRadians(envDef.environmentRotation) : 0;
+    if (envDef.environment && envTextureChanged) {
+        const envTexture = cubeTexture_1.CubeTexture.CreateFromPrefilteredData(envDef.environment, scene);
+        envTexture.rotationY = rotation;
+        scene.environmentTexture = envTexture;
+    }
+    else if (curEnvTexture && curEnvTexture.rotationY !== rotation) {
+        curEnvTexture.rotationY = rotation;
+    }
+    // 3) dispose existing & set new ENVIRONMENT_BACKGROUND
+    const curDome = scene.getNodeByName(backgroundDomeName);
+    const backgroundUrlChanged = envDef.environmentBackground !== (curDome === null || curDome === void 0 ? void 0 : curDome.texture.url);
+    if (curDome && (!envDef.environmentBackground || backgroundUrlChanged)) {
+        curDome.dispose();
+    }
+    const rotationPhotoDome = -1 * rotation;
+    if (envDef.environmentBackground && backgroundUrlChanged) {
+        const textureUrl = envDef.environmentBackground;
+        const dome = new photoDome_1.PhotoDome(backgroundDomeName, textureUrl, { resolution: 32, size: 450 }, scene);
+        // Rotate submesh to get them in line with environment texture
+        dome.getChildMeshes(true)[0].rotation.y = tools_1.Tools.ToRadians(90);
+        dome.rotation.y = rotationPhotoDome;
+    }
+    else if (curDome && curDome.rotation.y !== rotationPhotoDome) {
+        curDome.rotation.y = rotationPhotoDome;
+    }
+    // 4) dispose existing & set new ENVIRONMENT_USEDEFAULT (only if no background is set)
+    const curEnvHelper = (_a = scene.metadata) === null || _a === void 0 ? void 0 : _a[envHelperMetadataName];
+    if (curEnvHelper && !useDefaultEnv) {
+        curEnvHelper.dispose();
+        delete scene.metadata[envHelperMetadataName];
+    }
+    const envHelperMainColor = math_color_1.Color3.FromArray(scene.clearColor.asArray());
+    if (useDefaultEnv && !curEnvHelper) {
+        const envHelper = scene.createDefaultEnvironment({ sizeAuto: true });
+        envHelper === null || envHelper === void 0 ? void 0 : envHelper.setMainColor(envHelperMainColor);
+        if (envHelper) {
+            scene.metadata = (0, lodash_es_1.merge)({}, scene.metadata, { [envHelperMetadataName]: envHelper });
+        }
+    }
+    else if (curEnvHelper && useDefaultEnv && clearColorChanged) {
+        curEnvHelper.setMainColor(envHelperMainColor);
+    }
+    // 5) set ENVIRONMENT_INTENSITY
+    if (envDef.environmentIntensity !== undefined) {
+        scene.environmentIntensity = envDef.environmentIntensity;
+    }
+};
+exports.changeEnvironment = changeEnvironment;
+/**
+ * Sets a material by a given material id as material property on the given node.
+ *
+ * If the material is not already available in the scene, the viewer tries to create a material based on a Combeenation
+ * [material asset](https://docs.combeenation.com/docs/howto-create-and-use-babylon-and-material-asset).
+ * This of course only works if the viewer is used inside a Combeenation configurator.
+ *
+ * Furthermore this function also defers the material creation if the node is not visible yet to improve network &
+ * viewer bootstrap performance as textures are automatically being lazy loaded only when they are actually visible in
+ * the scene.
+ *
+ * Finally the material will not be applied before all its textures have been loaded. In this way "flickering" effects
+ * will be avoided, since the material would be incomplete without its loaded textures.
+ */
+const setMaterial = function (node, materialId, deep = true, variant) {
+    if (node instanceof abstractMesh_1.AbstractMesh) {
+        const materialExists = node.getScene().getMaterialById(materialId);
+        const hasMissingMaterial = (0, lodash_es_1.has)(node.metadata, sceneLoaderHelper_1.missingMaterialMetadataName);
+        const deferMaterialCreation = !materialExists && !node.isEnabled();
+        if (deferMaterialCreation) {
+            // do not set the material
+            injectMetadata(node, { [sceneLoaderHelper_1.missingMaterialMetadataName]: materialId }, false);
+            // if it already had the missing material flag before, there already exists an observer...
+            if (!hasMissingMaterial) {
+                (0, sceneLoaderHelper_1.addMissingMaterialObserver)(node);
+            }
+        }
+        else {
+            // create material and apply it when textures have been loaded
+            getOrCreateMaterial(node.getScene(), materialId, variant).then(material => {
+                applyMaterial(material, node).then(() => event_1.emitter.emit(event_1.Event.MESH_MATERIAL_APPLIED, node, material));
+                if (hasMissingMaterial) {
+                    delete node.metadata[sceneLoaderHelper_1.missingMaterialMetadataName];
+                }
+            });
+        }
+    }
+    // recursively set materials on children (if desired)
+    if (deep) {
+        for (const child of node.getChildTransformNodes(true)) {
+            setMaterial(child, materialId, deep, variant);
+        }
+    }
+};
+exports.setMaterial = setMaterial;
+/**
+ * Removes material from promise map once it has been added to the scene, because we can be sure that the material will
+ * be taken from the scene directly, the next time it is requested
+ */
+const onNewMaterialAddedCb = (material) => {
+    if (getMaterialPromises.has(material.id)) {
+        getMaterialPromises.delete(material.id);
+    }
+};
+/**
+ * Responsible for adding the `onNewMaterialAddedCb` only once
+ */
+const registerOnNewMaterialAddedCbOnce = (scene) => {
+    const observerAlreadyAssigned = scene.onNewMaterialAddedObservable.observers.find(observer => observer.callback === onNewMaterialAddedCb);
+    if (!observerAlreadyAssigned) {
+        scene.onNewMaterialAddedObservable.add(onNewMaterialAddedCb);
+    }
+};
+/**
+ * Gets the Material either from the given {@link Variant}, the given scene or tries to create it from an Combeenation
+ * material asset when inside a Combeenation configurator.
+ */
+const getOrCreateMaterial = function (scene, materialId, variant) {
+    return __awaiter(this, void 0, void 0, function* () {
+        registerOnNewMaterialAddedCbOnce(scene);
+        let chosenMaterial;
+        chosenMaterial = variant === null || variant === void 0 ? void 0 : variant.inheritedMaterials.find(mat => mat.id === materialId);
+        chosenMaterial = chosenMaterial || scene.materials.find(mat => mat.id === materialId);
+        if (!chosenMaterial) {
+            // material not available yet, request it from Combeenation assets
+            if (getMaterialPromises.has(materialId)) {
+                // request is already pending, just wait for the result
+                chosenMaterial = yield getMaterialPromises.get(materialId);
+            }
+            else {
+                // request not pending, call the dedicated function
+                const getMaterialProm = (0, sceneLoaderHelper_1.createMaterialFromCbnAssets)(materialId, scene);
+                // store the promise in a global map, so that subsequent requests can reference it
+                getMaterialPromises.set(materialId, getMaterialProm);
+                chosenMaterial = yield getMaterialProm;
+            }
+        }
+        if (chosenMaterial) {
+            return chosenMaterial;
+        }
+        // reject when material was not found
+        let rejectMessage = `Material with id "${materialId}" does not exist on scene.`;
+        if (variant) {
+            rejectMessage = `Material with id "${materialId}" does not exist for variant "${variant.id}".`;
+        }
+        throw new Error(rejectMessage);
+    });
+};
+exports.getOrCreateMaterial = getOrCreateMaterial;
+/**
+ * Waits until the materials textures are loaded and shaders are compiled.
+ * Then sets the material on the node if there is no newer "set material" request
+ */
+const applyMaterial = function (material, node) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        // set current material id as last valid id, in this case all previously set materials on the node will be invalidated
+        injectMetadata(node, { [materialWaitingToBeSetMetadataName]: material.id }, false);
+        const promTexturesReady = new Promise(resolve => baseTexture_1.BaseTexture.WhenAllReady(material.getActiveTextures(), resolve));
+        // 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
+        const promMaterialCompiled = material.forceCompilationAsync(node);
+        // 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([promTexturesReady, promMaterialCompiled]);
+        // textures ready, now check if the material is still up-to-date
+        if (material.id === ((_a = node.metadata) === null || _a === void 0 ? void 0 : _a[materialWaitingToBeSetMetadataName])) {
+            node.material = material;
+            delete node.metadata[materialWaitingToBeSetMetadataName];
+        }
+    });
+};
+exports.applyMaterial = applyMaterial;
+/**
+ * !!! Warning !!!
+ * This function is not public API. Whilst it can help solving certain problems, it only works reliably in well defined
+ * situations and can cause unwanted side effects under some conditions. Use carefully at your own risk!
+ *
+ * See https://combeenation.myjetbrains.com/youtrack/issue/CB-5906 for further details regarding this warning.
+ *
+ * Set material of an instanced meshes source mesh.
+ * Changes the material of all instanced meshes which have the same source mesh.
+ *
+ * @param node
+ * @param material
+ * @param deep
+ *
+ * @ignore
+ */
+const setSourceNodeMaterial = function (node, material, deep = true) {
+    const warn = `	You're using "setSourceNodeMaterial" which is not public API.
+	Whilst it can help solving certain problems, it only works reliably in well defined situations and can cause unwanted side effects under some conditions.
+	Use carefully at your own risk!`;
+    console.warn(`!!! Warning !!!\n${warn}`);
+    if (node instanceof instancedMesh_1.InstancedMesh) {
+        node.sourceMesh.material = material;
+    }
+    if (deep) {
+        node.getChildTransformNodes(true).forEach(child => setSourceNodeMaterial(child, material, deep));
+    }
+};
+exports.setSourceNodeMaterial = setSourceNodeMaterial;
+/**
+ * @param node
+ * @param color
+ * @param deep
+ */
+const setMaterialColor = function (node, color, deep = true) {
+    if (node instanceof abstractMesh_1.AbstractMesh && node.material) {
+        const materialCls = node.material.getClassName();
+        switch (materialCls) {
+            case 'PBRMaterial':
+                node.material.albedoColor = color.toLinearSpace();
+                break;
+            case 'StandardMaterial':
+                node.material.diffuseColor = color;
+                break;
+            default:
+                throw new Error(`Setting color for material of instance "${materialCls}" not implemented (yet).`);
+        }
+        setMaterial(node, node.material.id, false);
+    }
+    if (deep) {
+        node.getChildTransformNodes(true).forEach(child => setMaterialColor(child, color, deep));
+    }
+};
+exports.setMaterialColor = setMaterialColor;
+/**
+ * @param node
+ * @param texture
+ * @param deep
+ */
+const setMaterialTexture = function (node, texture, deep = true) {
+    if (node instanceof abstractMesh_1.AbstractMesh && node.material) {
+        const materialCls = node.material.getClassName();
+        switch (materialCls) {
+            case 'PBRMaterial':
+                node.material.albedoTexture = texture;
+                break;
+            case 'StandardMaterial':
+                node.material.diffuseTexture = texture;
+                break;
+            default:
+                throw new Error(`Setting texture for material of instance "${materialCls}" not implemented (yet).`);
+        }
+        setMaterial(node, node.material.id, false);
+    }
+    if (deep) {
+        node.getChildTransformNodes(true).forEach(child => setMaterialTexture(child, texture, deep));
+    }
+};
+exports.setMaterialTexture = setMaterialTexture;
+/**
+ * @param node
+ * @param metallness
+ * @param deep
+ */
+const setMaterialMetallness = function (node, metallness, deep = true) {
+    if (node instanceof abstractMesh_1.AbstractMesh && node.material) {
+        const materialCls = node.material.getClassName();
+        switch (materialCls) {
+            case 'PBRMaterial':
+                node.material.metallic = metallness;
+                break;
+            default:
+                throw new Error(`Setting metallness for material of instance "${materialCls}" not implemented (yet).`);
+        }
+        setMaterial(node, node.material.id, false);
+    }
+    if (deep) {
+        node.getChildTransformNodes(true).forEach(child => setMaterialMetallness(child, metallness, deep));
+    }
+};
+exports.setMaterialMetallness = setMaterialMetallness;
+/**
+ * @param node
+ * @param roughness
+ * @param deep
+ */
+const setMaterialRoughness = function (node, roughness, deep = true) {
+    if (node instanceof abstractMesh_1.AbstractMesh && node.material) {
+        const materialCls = node.material.getClassName();
+        switch (materialCls) {
+            case 'PBRMaterial':
+                node.material.roughness = roughness;
+                break;
+            case 'StandardMaterial':
+                node.material.roughness = roughness;
+                break;
+            default:
+                throw new Error(`Setting roughness for material of instance "${materialCls}" not implemented (yet).`);
+        }
+        setMaterial(node, node.material.id, false);
+    }
+    if (deep) {
+        node.getChildTransformNodes(true).forEach(child => setMaterialRoughness(child, roughness, deep));
+    }
+};
+exports.setMaterialRoughness = setMaterialRoughness;
+/**
+ * @param node
+ * @param layer
+ * @param color
+ * @param deep
+ */
+const addToHighlightLayer = function (layer, color, node, deep = true) {
+    if (node instanceof abstractMesh_1.AbstractMesh) {
+        layer.addMesh(node, color);
+    }
+    if (deep) {
+        node.getChildTransformNodes(true).forEach(child => addToHighlightLayer(layer, color, child, deep));
+    }
+};
+exports.addToHighlightLayer = addToHighlightLayer;
+/**
+ * @param node
+ * @param layer
+ * @param deep
+ */
+const removeFromHighlightLayer = function (layer, node, deep = true) {
+    if (node instanceof abstractMesh_1.AbstractMesh) {
+        layer.removeMesh(node);
+    }
+    if (deep) {
+        node.getChildTransformNodes(true).forEach(child => removeFromHighlightLayer(layer, child, deep));
+    }
+};
+exports.removeFromHighlightLayer = removeFromHighlightLayer;
+/**
+ * @param node
+ * @param receiveShadows
+ * @param deep
+ */
+const setReceiveShadows = function (node, receiveShadows, deep = true) {
+    if (node instanceof abstractMesh_1.AbstractMesh) {
+        node.receiveShadows = receiveShadows;
+    }
+    if (deep) {
+        node.getChildTransformNodes(true).forEach(child => setReceiveShadows(child, receiveShadows, deep));
+    }
+};
+exports.setReceiveShadows = setReceiveShadows;
+/**
+ * @param node
+ * @param generator
+ * @param deep
+ */
+const addToShadowGenerator = function (generator, node, deep = true) {
+    if (node instanceof abstractMesh_1.AbstractMesh) {
+        // We have to remove the node because there's no duplicate check in babylon
+        generator.removeShadowCaster(node, false);
+        generator.addShadowCaster(node, false);
+    }
+    if (deep) {
+        node.getChildTransformNodes(true).forEach(child => addToShadowGenerator(generator, child, deep));
+    }
+};
+exports.addToShadowGenerator = addToShadowGenerator;
+/**
+ * @param node
+ * @param generator
+ * @param deep
+ */
+const removeFromShadowGenerator = function (generator, node, deep = true) {
+    if (node instanceof abstractMesh_1.AbstractMesh) {
+        generator.removeShadowCaster(node, false);
+    }
+    if (deep) {
+        node.getChildTransformNodes(true).forEach(child => removeFromShadowGenerator(generator, child, deep));
+    }
+};
+exports.removeFromShadowGenerator = removeFromShadowGenerator;
+/**
+ * https://forum.babylonjs.com/t/get-mesh-bounding-box-position-and-size-in-2d-screen-coordinates/1058/3
+ * @param mesh
+ * @param scene
+ * @param canvas
+ */
+const getClientRectFromMesh = function (mesh, scene, canvas) {
+    // get bounding box of the mesh
+    const meshVectors = mesh.getBoundingInfo().boundingBox.vectors;
+    // get the matrix and viewport needed to project the vectors onto the screen
+    const worldMatrix = mesh.getWorldMatrix();
+    const transformMatrix = scene.getTransformMatrix();
+    const viewport = scene.activeCamera.viewport;
+    // loop though all the vectors and project them against the current camera viewport to get a set of coordinates
+    const coordinates = meshVectors.map(vector => {
+        const projection = math_vector_1.Vector3.Project(vector, worldMatrix, transformMatrix, viewport);
+        projection.x = projection.x * canvas.clientWidth;
+        projection.y = projection.y * canvas.clientHeight;
+        return projection;
+    });
+    // get the min and max for all the coordinates so we can calculate the largest possible screen size
+    const maxX = Math.max(...coordinates.map(o => o.x));
+    const minX = Math.min(...coordinates.map(o => o.x));
+    const maxY = Math.max(...coordinates.map(o => o.y));
+    const minY = Math.min(...coordinates.map(o => o.y));
+    // return a ClientRect from this
+    return {
+        width: maxX - minX,
+        height: maxY - minY,
+        left: minX,
+        top: minY,
+        right: maxX,
+        bottom: maxY,
+    };
+};
+exports.getClientRectFromMesh = getClientRectFromMesh;
+/**
+ * This type guard checks whether the given `BaseTextures` is any of its subtypes which comes with an
+ * `onLoadObservable`.
+ *
+ * !!! Timing of when this function is called is important !!!
+ * See the following for more details: https://forum.babylonjs.com/t/basetexture-whenallready-returns-too-early/34501/6
+ */
+const isTextureWithOnLoadObservable = function (texture) {
+    return !!texture.onLoadObservable;
+};
+exports.isTextureWithOnLoadObservable = isTextureWithOnLoadObservable;
+/**
+ * @param objects
+ * @param tagMapping
+ */
+const mapTags = function (objects, tagMapping) {
+    var _a;
+    let affectedTags = [];
+    for (const object of objects) {
+        const oldTags = Object.keys((_a = tags_1.Tags.GetTags(object, false)) !== null && _a !== void 0 ? _a : {});
+        const mappedTags = oldTags.map(t => tagMapping[t] || t);
+        tags_1.Tags.RemoveTagsFrom(object, oldTags.join(' '));
+        tags_1.Tags.AddTagsTo(object, mappedTags.join(' '));
+        affectedTags = [...affectedTags, ...mappedTags];
+    }
+    return (0, lodash_es_1.uniq)(affectedTags);
+};
+exports.mapTags = mapTags;
+/**
+ * Gets an array of ids for nodeIds that exist in both TransformNode arrays.
+ * @param nodes1
+ * @param nodes2
+ * @param predicate
+ */
+const intersectingNodeNames = function (nodes1, nodes2, predicate) {
+    const nodeNames1 = nodes1.filter(n => !predicate || predicate(n)).map(n => n.name);
+    const nodesNames2 = nodes2.filter(n => !predicate || predicate(n)).map(n => n.name);
+    return nodeNames1.filter(n1 => nodesNames2.includes(n1));
+};
+exports.intersectingNodeNames = intersectingNodeNames;
+/**
+ * Gets an array of ids for duplicate nodeIds in given node array.
+ * @param nodes
+ * @param predicate
+ */
+const duplicateNodeNames = function (nodes, predicate) {
+    const nodeNames = nodes.filter(n => !predicate || predicate(n)).map(n => n.name);
+    return nodeNames.filter((v, i, self) => self.indexOf(v) !== i);
+};
+exports.duplicateNodeNames = duplicateNodeNames;
+/**
+ * Reports duplicate nodeIds.
+ * @param nodeNames
+ */
+const reportDuplicateNodeNames = function (nodeNames) {
+    var _a;
+    if (nodeNames.length > 0) {
+        const warn = `There are duplicate nodeNames: ${nodeNames.join(', ')}`;
+        console.warn(`!!! Warning !!!\n${warn}`);
+        (_a = window.Cbn) === null || _a === void 0 ? void 0 : _a.Assets.reportDuplicateNodeName(nodeNames);
+    }
+};
+exports.reportDuplicateNodeNames = reportDuplicateNodeNames;
+const drawPaintableOnMaterial = function (material, imageSource, scene, options) {
+    var _a, _b, _c, _d;
+    // always take width and height from image source, scaling is done with uvScale properties
+    const widthAndHeight = {
+        width: imageSource.width,
+        height: imageSource.height,
+    };
+    const texture = new dynamicTexture_1.DynamicTexture(`${material.id}.paintable_texture`, widthAndHeight, scene);
+    // draw image on texture
+    const ctx = texture.getContext();
+    ctx.drawImage(imageSource, 0, 0);
+    texture.update();
+    // apply settings from paintable options to tweak position and scaling of image on the texture
+    texture.uScale = (_a = options === null || options === void 0 ? void 0 : options.uScale) !== null && _a !== void 0 ? _a : texture.uScale;
+    texture.vScale = (_b = options === null || options === void 0 ? void 0 : options.vScale) !== null && _b !== void 0 ? _b : texture.vScale;
+    texture.uOffset = (_c = options === null || options === void 0 ? void 0 : options.uOffset) !== null && _c !== void 0 ? _c : texture.uOffset;
+    texture.vOffset = (_d = options === null || options === void 0 ? void 0 : options.vOffset) !== null && _d !== void 0 ? _d : texture.vOffset;
+    // wrap mode is preferred, as it will always show the texture, no matter which position offset is currently chosen
+    // clamp mode requires more knowledge (and patience) when adjusting the uv scale and offset values
+    texture.wrapU = texture_1.Texture.WRAP_ADDRESSMODE;
+    texture.wrapV = texture_1.Texture.WRAP_ADDRESSMODE;
+    // apply the paintable texture on the dedicated material type
+    const materialCls = material.getClassName();
+    switch (materialCls) {
+        case 'PBRMaterial':
+            material.albedoTexture = texture;
+            break;
+        case 'StandardMaterial':
+            material.diffuseTexture = texture;
+            break;
+        default:
+            throw new Error(`Setting paintable texture for material of instance "${materialCls}" not implemented (yet).`);
+    }
+};
+exports.drawPaintableOnMaterial = drawPaintableOnMaterial;
 //# sourceMappingURL=babylonHelper.js.map