@combeenation/3d-viewer 5.1.2 → 5.2.0-alpha1

package/dist/lib-cjs/src/api/manager/gltfExportManager.js

@@ -0,0 +1,197 @@
+"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.GltfExportManager = void 0;
+const structureHelper_1 = require("../util/structureHelper");
+const pbrMaterial_1 = require("@babylonjs/core/Materials/PBR/pbrMaterial");
+const math_color_1 = require("@babylonjs/core/Maths/math.color");
+const abstractMesh_1 = require("@babylonjs/core/Meshes/abstractMesh");
+const mesh_1 = require("@babylonjs/core/Meshes/mesh");
+const _2_0_1 = require("@babylonjs/serializers/glTF/2.0");
+const lodash_es_1 = require("lodash-es");
+class GltfExportManager {
+    /**
+     * Constructor.
+     */
+    constructor(viewer) {
+        this.viewer = viewer;
+    }
+    /**
+     * Creates an {@link GltfExportManager}.
+     */
+    static create(viewer) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return new GltfExportManager(viewer);
+        });
+    }
+    /**
+     * Exports selected nodes to a file.
+     * @param filename optional name of the exported .GLB file.
+     * @param exportOptions export options to be merged with default options.
+     * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export.
+     */
+    exportGlb(filename = 'glb-export.glb', exportOptions = {}, excluded) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.exportPreProcess();
+            const glbData = yield _2_0_1.GLTF2Export.GLBAsync(this.viewer.scene, 'dummy', this.gltfExportOptions(exportOptions, excluded));
+            this.exportPostProcess();
+            const resBlob = glbData.glTFFiles['dummy.glb']; // should be only one file for glb
+            // check if result is valid, according to the typings this could also be a string
+            if (resBlob instanceof Blob) {
+                if (!filename.endsWith('.glb')) {
+                    filename += '.glb';
+                }
+                return new File([resBlob], filename);
+            }
+            else {
+                // result was not a valid blob
+                return undefined;
+            }
+        });
+    }
+    /**
+     * Exports selected nodes to GLTF. This may result in more than one file, since textures are exported separately.
+     * @param filename name of the main (text-based) .GLTF file referring to separate texture files.
+     * @param exportOptions export options to be merged with default options.
+     * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export.
+     */
+    exportGltfToFile(filename, exportOptions = {}, excluded) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.exportPreProcess();
+            yield _2_0_1.GLTF2Export.GLTFAsync(this.viewer.scene, filename, this.gltfExportOptions(exportOptions, excluded)).then(glb => {
+                glb.downloadFiles();
+            });
+            this.exportPostProcess();
+        });
+    }
+    /**
+     * Exports selected nodes to GLB. This results in one binary file.
+     * @param filename name of the .GLB file.
+     * @param exportOptions export options to be merged with default options.
+     * @param excluded optional list of geometry (meshes, elements, variants, variantInstances) to be excluded from export
+     */
+    exportGlbToFile(filename, exportOptions = {}, excluded) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.exportPreProcess();
+            yield _2_0_1.GLTF2Export.GLBAsync(this.viewer.scene, filename, this.gltfExportOptions(exportOptions, excluded)).then(glb => {
+                glb.downloadFiles();
+            });
+            this.exportPostProcess();
+        });
+    }
+    /**
+     * Gets predefined {@link IExportOptions } merged with given ones.
+     */
+    gltfExportOptions(mergeWithOptions = {}, excluded) {
+        const defaultOptions = {
+            // includeCoordinateSystemConversionNodes: true,
+            shouldExportNode: function (node) {
+                if (!node.isEnabled()) {
+                    return false;
+                }
+                if (node.isVisible === false) {
+                    return false;
+                }
+                if (node.name === '__bounding_box__') {
+                    return false;
+                }
+                if (excluded && node instanceof mesh_1.Mesh && (0, structureHelper_1.isMeshIncludedInExclusionList)(node, excluded)) {
+                    return false;
+                }
+                return true;
+            },
+        };
+        return (0, lodash_es_1.merge)({}, defaultOptions, mergeWithOptions);
+    }
+    /**
+     * Stuff to be done before exporting to GLTF
+     */
+    exportPreProcess() {
+        this.viewer.pauseRendering();
+        this.exchangeRefractionMaterials();
+    }
+    /**
+     * Stuff to be done after the GLTF export
+     */
+    exportPostProcess() {
+        this.restoreRefractionMaterials();
+        this.viewer.resumeRendering();
+    }
+    /**
+     * Materials with refraction set are not exported properly.
+     * Exchange all such (relevant) materials with a more export-friendly version
+     */
+    exchangeRefractionMaterials() {
+        for (const n of this.viewer.scene.getNodes()) {
+            if (!(n instanceof abstractMesh_1.AbstractMesh))
+                continue;
+            if (!(n.material instanceof pbrMaterial_1.PBRMaterial))
+                continue;
+            if (!n.material.subSurface.isRefractionEnabled)
+                continue;
+            if (n.material.transparencyMode !== pbrMaterial_1.PBRMaterial.PBRMATERIAL_OPAQUE)
+                continue;
+            // if we're here, we have a node holding a material with set refraction whose transparencyMode is set to PBRMATERIAL_OPAQUE
+            n.material = this.createRefractionMaterialReplacement(n.material);
+        }
+    }
+    /**
+     * Restore original materials with set refraction.
+     */
+    restoreRefractionMaterials() {
+        for (const n of this.viewer.scene.getNodes()) {
+            if (!(n instanceof abstractMesh_1.AbstractMesh))
+                continue;
+            if (!(n.material instanceof pbrMaterial_1.PBRMaterial))
+                continue;
+            if (!this.isMaterialClonedForExport(n.material))
+                continue;
+            // at this point we have a pbrmaterial tagged as cloned in its metadata that's set on a mesh
+            // restore and dispose
+            const currMaterial = n.material;
+            const prevMaterial = this.viewer.scene.getMaterialByUniqueID(n.material.metadata.clonedFrom);
+            if (prevMaterial) {
+                n.material = prevMaterial; // restore previous material
+                currMaterial.dispose(false, true); // dispose of clone
+            }
+        }
+    }
+    /**
+     * Create an export-friendly replacement material for a material using refraction.
+     * @param mat Material to be replaced
+     */
+    createRefractionMaterialReplacement(mat) {
+        // if we're dealing with a clone already, return it instead of cloning
+        if (this.isMaterialClonedForExport(mat))
+            return mat;
+        // change material according to https://www.notion.so/combeenation/Glas-materials-don-t-look-glasy-after-export-d5fda2c6515e4420a8772744d3e6b460
+        let clonedMaterial = mat.clone(mat.name); // clone material. clone uses same name
+        clonedMaterial.metadata = Object.assign(Object.assign({}, mat.metadata), { clonedFrom: mat.uniqueId }); // create shallow copy of metadata on clone. see https://forum.babylonjs.com/t/the-metadata-of-the-mesh-cloned-by-the-instantiatemodelstoscene-method-is-a-shallow-copy/21563
+        clonedMaterial.refractionTexture = null;
+        clonedMaterial.metallicReflectanceTexture = null; // is this the correct one for metallic roughness?
+        clonedMaterial.alpha = 0.7;
+        clonedMaterial.albedoColor = new math_color_1.Color3(0.3, 0.3, 0.3);
+        clonedMaterial.transparencyMode = pbrMaterial_1.PBRMaterial.PBRMATERIAL_ALPHABLEND;
+        clonedMaterial.metallic = 0.65;
+        clonedMaterial.roughness = 0.15;
+        return clonedMaterial;
+    }
+    /**
+     * Inspect if a material was temporarily cloned for GLB export
+     * @param mat Material to be inspected
+     */
+    isMaterialClonedForExport(mat) {
+        var _a;
+        return !!((_a = mat.metadata) === null || _a === void 0 ? void 0 : _a.clonedFrom);
+    }
+}
+exports.GltfExportManager = GltfExportManager;
+//# sourceMappingURL=gltfExportManager.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"gltfExportManager.js","sourceRoot":"","sources":["../../../../../src/api/manager/gltfExportManager.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,6DAAwE;AACxE,2EAAwE;AACxE,iEAA0D;AAC1D,sEAAmE;AACnE,sDAAmD;AACnD,0DAA8E;AAC9E,yCAAkC;AAElC,MAAa,iBAAiB;IAC5B;;OAEG;IACH,YAAgC,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;IAAG,CAAC;IAElD;;OAEG;IACI,MAAM,CAAO,MAAM,CAAC,MAAc;;YACvC,OAAO,IAAI,iBAAiB,CAAC,MAAM,CAAC,CAAC;QACvC,CAAC;KAAA;IAED;;;;;OAKG;IACU,SAAS,CACpB,QAAQ,GAAG,gBAAgB,EAC3B,gBAAgC,EAAE,EAClC,QAA+B;;YAE/B,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,MAAM,kBAAW,CAAC,QAAQ,CACxC,IAAI,CAAC,MAAM,CAAC,KAAK,EACjB,OAAO,EACP,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAChD,CAAC;YACF,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACzB,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,kCAAkC;YAElF,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;;;;;OAKG;IACU,gBAAgB,CAAC,QAAgB,EAAE,gBAAgC,EAAE,EAAE,QAA+B;;YACjH,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxB,MAAM,kBAAW,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAC5G,GAAG,CAAC,EAAE;gBACJ,GAAG,CAAC,aAAa,EAAE,CAAC;YACtB,CAAC,CACF,CAAC;YACF,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,CAAC;KAAA;IAED;;;;;OAKG;IACU,eAAe,CAAC,QAAgB,EAAE,gBAAgC,EAAE,EAAE,QAA+B;;YAChH,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxB,MAAM,kBAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAC3G,GAAG,CAAC,EAAE;gBACJ,GAAG,CAAC,aAAa,EAAE,CAAC;YACtB,CAAC,CACF,CAAC;YACF,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC3B,CAAC;KAAA;IAED;;OAEG;IACO,iBAAiB,CAAC,mBAAmC,EAAE,EAAE,QAA+B;QAChG,MAAM,cAAc,GAAG;YACrB,gDAAgD;YAChD,gBAAgB,EAAE,UAAU,IAAS;gBACnC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE;oBACrB,OAAO,KAAK,CAAC;iBACd;gBACD,IAAI,IAAI,CAAC,SAAS,KAAK,KAAK,EAAE;oBAC5B,OAAO,KAAK,CAAC;iBACd;gBACD,IAAI,IAAI,CAAC,IAAI,KAAK,kBAAkB,EAAE;oBACpC,OAAO,KAAK,CAAC;iBACd;gBACD,IAAI,QAAQ,IAAI,IAAI,YAAY,WAAI,IAAI,IAAA,+CAA6B,EAAC,IAAI,EAAE,QAAQ,CAAC,EAAE;oBACrF,OAAO,KAAK,CAAC;iBACd;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;SACF,CAAC;QACF,OAAO,IAAA,iBAAK,EAAC,EAAE,EAAE,cAAc,EAAE,gBAAgB,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACO,gBAAgB;QACxB,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;QAC7B,IAAI,CAAC,2BAA2B,EAAE,CAAC;IACrC,CAAC;IAED;;OAEG;IACO,iBAAiB;QACzB,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAClC,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;IAChC,CAAC;IAED;;;OAGG;IACO,2BAA2B;QACnC,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE;YAC5C,IAAI,CAAC,CAAC,CAAC,YAAY,2BAAY,CAAC;gBAAE,SAAS;YAC3C,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,YAAY,yBAAW,CAAC;gBAAE,SAAS;YACnD,IAAI,CAAE,CAAC,CAAC,QAAwB,CAAC,UAAU,CAAC,mBAAmB;gBAAE,SAAS;YAC1E,IAAK,CAAC,CAAC,QAAwB,CAAC,gBAAgB,KAAK,yBAAW,CAAC,kBAAkB;gBAAE,SAAS;YAC9F,2HAA2H;YAC3H,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC,mCAAmC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;SACnE;IACH,CAAC;IAED;;OAEG;IACO,0BAA0B;QAClC,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE;YAC5C,IAAI,CAAC,CAAC,CAAC,YAAY,2BAAY,CAAC;gBAAE,SAAS;YAC3C,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,YAAY,yBAAW,CAAC;gBAAE,SAAS;YACnD,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,QAAQ,CAAC;gBAAE,SAAS;YAC1D,4FAA4F;YAE5F,sBAAsB;YACtB,MAAM,YAAY,GAAG,CAAC,CAAC,QAAQ,CAAC;YAChC,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;YAC7F,IAAI,YAAY,EAAE;gBAChB,CAAC,CAAC,QAAQ,GAAG,YAAY,CAAC,CAAC,4BAA4B;gBACvD,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,mBAAmB;aACvD;SACF;IACH,CAAC;IAED;;;OAGG;IACO,mCAAmC,CAAC,GAAgB;QAC5D,sEAAsE;QACtE,IAAI,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC;YAAE,OAAO,GAAG,CAAC;QAEpD,gJAAgJ;QAChJ,IAAI,cAAc,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,uCAAuC;QACjF,cAAc,CAAC,QAAQ,mCAAQ,GAAG,CAAC,QAAQ,KAAE,UAAU,EAAE,GAAG,CAAC,QAAQ,GAAE,CAAC,CAAC,6KAA6K;QACtP,cAAc,CAAC,iBAAiB,GAAG,IAAI,CAAC;QACxC,cAAc,CAAC,0BAA0B,GAAG,IAAI,CAAC,CAAC,kDAAkD;QACpG,cAAc,CAAC,KAAK,GAAG,GAAG,CAAC;QAC3B,cAAc,CAAC,WAAW,GAAG,IAAI,mBAAM,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QACvD,cAAc,CAAC,gBAAgB,GAAG,yBAAW,CAAC,sBAAsB,CAAC;QACrE,cAAc,CAAC,QAAQ,GAAG,IAAI,CAAC;QAC/B,cAAc,CAAC,SAAS,GAAG,IAAI,CAAC;QAEhC,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;OAGG;IACO,yBAAyB,CAAC,GAAgB;;QAClD,OAAO,CAAC,CAAC,CAAA,MAAA,GAAG,CAAC,QAAQ,0CAAE,UAAU,CAAA,CAAC;IACpC,CAAC;CACF;AAtLD,8CAsLC"}

package/dist/lib-cjs/{api → src/api}/manager/sceneManager.d.ts

@@ -1,31 +1,31 @@
-import { Camera } from '@babylonjs/core/Cameras/camera';
-import { Scene as BabylonScene } from '@babylonjs/core/scene';
-import { ParameterObservable } from '../classes/parameterObservable';
-export declare class SceneManager extends ParameterObservable {
-    scene: BabylonScene;
-    protected readonly _parameterObservers: Map<string, ParameterObserver[]>;
-    /**
-     * Constructor.
-     */
-    protected constructor(scene: BabylonScene);
-    /**
-     * Creates a {@link SceneManager} based on given BabylonJS scene.
-     */
-    static create(scene: BabylonScene): Promise<SceneManager>;
-    /**
-     * The active `Camera`.
-     */
-    get activeCamera(): Camera;
-    /**
-     * Places the given {@link ParameterBag} in the {@link SceneManager}'s parameters, replaces all patterns in the
-     * {@link StructureJson} and broadcasts all {@link ParameterObserver}s.
-     *
-     * @emit {@link Event.SCENE_PARAMETER_COMMITTED}
-     */
-    commitParameters(parameters?: ParameterBag): Promise<SceneManager>;
-    protected addParameterObservers(): SceneManager;
-    /**
-     * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
-     */
-    protected bootstrapParameters(parameters?: ParameterBag): Promise<SceneManager>;
-}
+import { ParameterObservable } from '../classes/parameterObservable';
+import { Camera } from '@babylonjs/core/Cameras/camera';
+import { Scene as BabylonScene } from '@babylonjs/core/scene';
+export declare class SceneManager extends ParameterObservable {
+    scene: BabylonScene;
+    protected readonly _parameterObservers: Map<string, ParameterObserver[]>;
+    /**
+     * Constructor.
+     */
+    protected constructor(scene: BabylonScene);
+    /**
+     * Creates a {@link SceneManager} based on given BabylonJS scene.
+     */
+    static create(scene: BabylonScene): Promise<SceneManager>;
+    /**
+     * The active `Camera`.
+     */
+    get activeCamera(): Camera;
+    /**
+     * Places the given {@link ParameterBag} in the {@link SceneManager}'s parameters, replaces all patterns in the
+     * {@link StructureJson} and broadcasts all {@link ParameterObserver}s.
+     *
+     * @emit {@link Event.SCENE_PARAMETER_COMMITTED}
+     */
+    commitParameters(parameters?: ParameterBag): Promise<SceneManager>;
+    protected addParameterObservers(): SceneManager;
+    /**
+     * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
+     */
+    protected bootstrapParameters(parameters?: ParameterBag): Promise<SceneManager>;
+}

package/dist/lib-cjs/src/api/manager/sceneManager.js

@@ -0,0 +1,128 @@
+"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.SceneManager = void 0;
+const event_1 = require("../classes/event");
+const parameter_1 = require("../classes/parameter");
+const parameterObservable_1 = require("../classes/parameterObservable");
+const specStorage_1 = require("../store/specStorage");
+const babylonHelper_1 = require("../util/babylonHelper");
+const resourceHelper_1 = require("../util/resourceHelper");
+const lodash_es_1 = require("lodash-es");
+class SceneManager extends parameterObservable_1.ParameterObservable {
+    /**
+     * Constructor.
+     */
+    constructor(scene) {
+        super();
+        this.scene = scene;
+        this._parameterObservers = new Map();
+        this.addParameterObservers();
+    }
+    /**
+     * Creates a {@link SceneManager} based on given BabylonJS scene.
+     */
+    static create(scene) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const sceneManager = new SceneManager(scene);
+            yield sceneManager.bootstrapParameters(specStorage_1.SpecStorage.get('scene.parameters'));
+            return sceneManager;
+        });
+    }
+    /**
+     * The active `Camera`.
+     */
+    get activeCamera() {
+        if (!this.scene.activeCamera) {
+            throw new Error('Scene has no active camera.');
+        }
+        return this.scene.activeCamera;
+    }
+    /**
+     * Places the given {@link ParameterBag} in the {@link SceneManager}'s parameters, replaces all patterns in the
+     * {@link StructureJson} and broadcasts all {@link ParameterObserver}s.
+     *
+     * @emit {@link Event.SCENE_PARAMETER_COMMITTED}
+     */
+    commitParameters(parameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!parameters) {
+                parameters = {};
+            }
+            const oldParameters = (0, lodash_es_1.cloneDeep)(this.parameters);
+            (0, lodash_es_1.merge)(this.parameters, parameters);
+            // handle parameter observers
+            let observerPromises = [];
+            for (const parameter in this.parameters) {
+                const oldParameterValue = oldParameters[parameter];
+                const newParameterValue = this.parameters[parameter];
+                this.assertParameter(parameter_1.Parameter.declarations, parameter, newParameterValue);
+                if (oldParameterValue === newParameterValue) {
+                    continue;
+                }
+                // parameter changed
+                const parameterObservers = (0, resourceHelper_1.mergeMaps)(this._parameterObservers, this.parameterObservers);
+                if (parameterObservers.has(parameter)) {
+                    const observers = parameterObservers.get(parameter);
+                    observerPromises = (0, lodash_es_1.concat)(observerPromises, observers.map(observer => {
+                        const observerResult = observer(this, oldParameterValue, newParameterValue);
+                        const observerPromise = Promise.resolve(observerResult);
+                        observerPromise.then(() => {
+                            this.broadcastEvent(event_1.Event.SCENE_PARAMETER_COMMITTED, this, parameter, oldParameterValue, newParameterValue);
+                        });
+                        return observerPromise;
+                    }));
+                }
+            }
+            yield Promise.all(observerPromises);
+            return this;
+        });
+    }
+    addParameterObservers() {
+        const handleEnvParamChange = (manager, oldValue, newValue) => {
+            const params = {
+                color: manager.parameters[parameter_1.Parameter.ENVIRONMENT_COLOR],
+                intensity: manager.parameters[parameter_1.Parameter.ENVIRONMENT_INTENSITY],
+                env: manager.parameters[parameter_1.Parameter.ENVIRONMENT],
+                background: manager.parameters[parameter_1.Parameter.ENVIRONMENT_BACKGROUND],
+                rotation: manager.parameters[parameter_1.Parameter.ENVIRONMENT_ROTATION],
+                useDefault: manager.parameters[parameter_1.Parameter.ENVIRONMENT_USEDEFAULT],
+            };
+            const envDef = {
+                environmentColor: params.color ? parameter_1.Parameter.parseColor(params.color) : undefined,
+                environmentIntensity: params.intensity !== undefined ? parameter_1.Parameter.parseNumber(params.intensity) : undefined,
+                environment: params.env ? params.env : undefined,
+                environmentBackground: params.background ? params.background : undefined,
+                environmentRotation: params.rotation !== undefined ? parameter_1.Parameter.parseNumber(params.rotation) : undefined,
+                environmentUseDefault: params.useDefault ? parameter_1.Parameter.parseBoolean(params.useDefault) : undefined,
+            };
+            (0, babylonHelper_1.changeEnvironment)(manager.scene, envDef);
+        };
+        this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_COLOR, [handleEnvParamChange]);
+        this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_ROTATION, [handleEnvParamChange]);
+        this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_USEDEFAULT, [handleEnvParamChange]);
+        this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT, [handleEnvParamChange]);
+        this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_BACKGROUND, [handleEnvParamChange]);
+        this._parameterObservers.set(parameter_1.Parameter.ENVIRONMENT_INTENSITY, [handleEnvParamChange]);
+        return this;
+    }
+    /**
+     * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
+     */
+    bootstrapParameters(parameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.commitParameters((0, lodash_es_1.merge)((0, lodash_es_1.cloneDeep)(this.parameters), parameters));
+            return this;
+        });
+    }
+}
+exports.SceneManager = SceneManager;
+//# sourceMappingURL=sceneManager.js.map

package/dist/lib-cjs/src/api/manager/sceneManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sceneManager.js","sourceRoot":"","sources":["../../../../../src/api/manager/sceneManager.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,4CAAyC;AACzC,oDAAiD;AACjD,wEAAqE;AACrE,sDAAmD;AACnD,yDAA0D;AAC1D,2DAAmD;AAGnD,yCAAqD;AAErD,MAAa,YAAa,SAAQ,yCAAmB;IAGnD;;OAEG;IACH,YAA6B,KAAmB;QAC9C,KAAK,EAAE,CAAC;QADmB,UAAK,GAAL,KAAK,CAAc;QAL7B,wBAAmB,GAAqC,IAAI,GAAG,EAAE,CAAC;QAOnF,IAAI,CAAC,qBAAqB,EAAE,CAAC;IAC/B,CAAC;IAED;;OAEG;IACI,MAAM,CAAO,MAAM,CAAC,KAAmB;;YAC5C,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;YAC7C,MAAM,YAAY,CAAC,mBAAmB,CAAC,yBAAW,CAAC,GAAG,CAAe,kBAAkB,CAAC,CAAC,CAAC;YAC1F,OAAO,YAAY,CAAC;QACtB,CAAC;KAAA;IAED;;OAEG;IACH,IAAI,YAAY;QACd,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;SAChD;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACU,gBAAgB,CAAC,UAAyB;;YACrD,IAAI,CAAC,UAAU,EAAE;gBACf,UAAU,GAAG,EAAE,CAAC;aACjB;YACD,MAAM,aAAa,GAAG,IAAA,qBAAS,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACjD,IAAA,iBAAK,EAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;YAEnC,6BAA6B;YAC7B,IAAI,gBAAgB,GAAwC,EAAE,CAAC;YAC/D,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE;gBACvC,MAAM,iBAAiB,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;gBACnD,MAAM,iBAAiB,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;gBACrD,IAAI,CAAC,eAAe,CAAC,qBAAS,CAAC,YAAY,EAAE,SAAS,EAAE,iBAAiB,CAAC,CAAC;gBAC3E,IAAI,iBAAiB,KAAK,iBAAiB,EAAE;oBAC3C,SAAS;iBACV;gBACD,oBAAoB;gBACpB,MAAM,kBAAkB,GAAG,IAAA,0BAAS,EAAC,IAAI,CAAC,mBAAmB,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;gBACxF,IAAI,kBAAkB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;oBACrC,MAAM,SAAS,GAAG,kBAAkB,CAAC,GAAG,CAAC,SAAS,CAAE,CAAC;oBACrD,gBAAgB,GAAG,IAAA,kBAAM,EACvB,gBAAgB,EAChB,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;wBACvB,MAAM,cAAc,GAAG,QAAQ,CAAC,IAAI,EAAE,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;wBAC5E,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;wBACxD,eAAe,CAAC,IAAI,CAAC,GAAG,EAAE;4BACxB,IAAI,CAAC,cAAc,CACjB,aAAK,CAAC,yBAAyB,EAC/B,IAAI,EACJ,SAAS,EACT,iBAAiB,EACjB,iBAAiB,CAClB,CAAC;wBACJ,CAAC,CAAC,CAAC;wBACH,OAAO,eAAe,CAAC;oBACzB,CAAC,CAAC,CACH,CAAC;iBACH;aACF;YACD,MAAM,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;YACpC,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;IAES,qBAAqB;QAC7B,MAAM,oBAAoB,GAAG,CAAC,OAAqB,EAAE,QAAwB,EAAE,QAAwB,EAAE,EAAE;YACzG,MAAM,MAAM,GAAG;gBACb,KAAK,EAAE,OAAO,CAAC,UAAU,CAAC,qBAAS,CAAC,iBAAiB,CAAC;gBACtD,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,qBAAS,CAAC,qBAAqB,CAAC;gBAC9D,GAAG,EAAE,OAAO,CAAC,UAAU,CAAC,qBAAS,CAAC,WAAW,CAAC;gBAC9C,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,qBAAS,CAAC,sBAAsB,CAAC;gBAChE,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,qBAAS,CAAC,oBAAoB,CAAC;gBAC5D,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,qBAAS,CAAC,sBAAsB,CAAC;aACjE,CAAC;YACF,MAAM,MAAM,GAA0B;gBACpC,gBAAgB,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,qBAAS,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;gBAC/E,oBAAoB,EAAE,MAAM,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,qBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS;gBAC1G,WAAW,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAE,MAAM,CAAC,GAAc,CAAC,CAAC,CAAC,SAAS;gBAC5D,qBAAqB,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAE,MAAM,CAAC,UAAqB,CAAC,CAAC,CAAC,SAAS;gBACpF,mBAAmB,EAAE,MAAM,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,qBAAS,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS;gBACvG,qBAAqB,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,qBAAS,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;aACjG,CAAC;YACF,IAAA,iCAAiB,EAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC3C,CAAC,CAAC;QAEF,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,qBAAS,CAAC,iBAAiB,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAClF,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,qBAAS,CAAC,oBAAoB,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC;QACrF,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,qBAAS,CAAC,sBAAsB,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC;QACvF,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,qBAAS,CAAC,WAAW,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAC5E,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,qBAAS,CAAC,sBAAsB,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC;QACvF,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,qBAAS,CAAC,qBAAqB,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC;QACtF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACa,mBAAmB,CAAC,UAAyB;;YAC3D,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAA,iBAAK,EAAC,IAAA,qBAAS,EAAC,IAAI,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC;YAC3E,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;CACF;AApHD,oCAoHC"}

package/dist/{lib-es6 → lib-cjs/src}/api/manager/variantInstanceManager.d.ts

@@ -1,92 +1,92 @@
-import { EventBroadcaster } from '../classes/eventBroadcaster';
-import { Variant } from '../classes/variant';
-import { VariantInstance } from '../classes/variantInstance';
-/**
- * There's usually no need to instantiate a {@link VariantInstanceManager} yourself as it is provided by each
- * {@link Viewer} instance via its {@link Viewer.variantInstances}
- */
-export declare class VariantInstanceManager extends EventBroadcaster {
-    protected rootVariant: Variant;
-    protected variantInstancePromises: Map<string, Promise<VariantInstance>>;
-    protected variantInstances: Map<string, VariantInstance>;
-    protected variantInstanceDefinitions: Map<string, VariantInstanceDefinition>;
-    protected parameters: ParameterBag;
-    protected queues: {
-        [name: string]: Promise<VariantInstance>[];
-    };
-    /**
-     * Constructor.
-     */
-    protected constructor(rootVariant: Variant);
-    /**
-     * Creates a {@link VariantInstanceManager} based on given root Variant.
-     */
-    static create(rootVariant: Variant): Promise<VariantInstanceManager>;
-    /**
-     * Gets all instances.
-     */
-    get all(): VariantInstance[];
-    /**
-     * Gets all instance definitions.
-     */
-    get allDefinitions(): VariantInstanceDefinition[];
-    /**
-     * Checks whether a {@link VariantInstance} is either registered or created.
-     */
-    has(name: string): boolean;
-    /**
-     * Retrieves a {@link VariantInstance}.
-     * If the instance has been created, the created instance will be returned.
-     * If the instance is registered, the instance will be created and returned.
-     * if the instance has already been requested and is currently pending, the dedicated promise will be returned.
-     * If none of these apply, an Error is thrown.
-     *
-     * @emits {@link Event.VARIANT_INSTANCE_CREATED}
-     */
-    get(name: string): Promise<VariantInstance>;
-    /**
-     * Creates and registers a unique {@link VariantInstance}.
-     *
-     * @emits {@link Event.VARIANT_INSTANCE_CREATED}
-     */
-    create(dottedPath: DottedPathArgument, name?: string, parameters?: ParameterBag): Promise<VariantInstance>;
-    /**
-     * Registers a unique {@link VariantInstanceDefinition}.
-     *
-     * @emits {@link Event.VARIANT_INSTANCE_REGISTERED}
-     */
-    register(instanceDefinition: VariantInstanceDefinition): VariantInstanceDefinition;
-    /**
-     * Commits the {@link ParameterBag} to all registered and created {@link VariantInstance}s.
-     */
-    commitParameters(parameters?: ParameterBag, onlyVisible?: boolean): Promise<VariantInstanceManager>;
-    /**
-     * Show one {@link VariantInstance}. If `exclusive` is set to `true` it will hide all other
-     * instances handled by this {@link VariantInstanceManager}. If the function is called synchronously,
-     * the calls end up in a queue according to the FIFO principle (the last one wins).
-     */
-    show(name: string, exclusive?: boolean): Promise<VariantInstance>;
-    /**
-     * Clones and registers a new {@link VariantInstance} with a new, unique name.
-     *
-     * @emits {@link Event.VARIANT_INSTANCE_CLONED}
-     */
-    clone(name: string, newName: string, parameters?: ParameterBag): Promise<VariantInstance>;
-    /**
-     * Destroys the instance by removing the {@link Variant} and de-registering the instance.
-     *
-     * @emits {@link Event.VARIANT_INSTANCE_DESTROYED}
-     */
-    destroy(name: string): VariantInstanceManager;
-    /**
-     * Creates and registers a unique {@link VariantInstance} from `definition`.
-     *
-     * @emits {@link Event.VARIANT_INSTANCE_CREATED}
-     */
-    protected createFromDefinition(definition: VariantInstanceDefinition): Promise<VariantInstance>;
-    /**
-     * Creates a unique instance name based on already registered instance names on the {@link VariantInstanceManager}.
-     * Appends an `_i` to the name where `i = 0` and increments as long as the name is not registered.
-     */
-    protected ensureUniqueName(name: string): string;
-}
+import { EventBroadcaster } from '../classes/eventBroadcaster';
+import { Variant } from '../classes/variant';
+import { VariantInstance } from '../classes/variantInstance';
+/**
+ * There's usually no need to instantiate a {@link VariantInstanceManager} yourself as it is provided by each
+ * {@link Viewer} instance via its {@link Viewer.variantInstances}
+ */
+export declare class VariantInstanceManager extends EventBroadcaster {
+    protected rootVariant: Variant;
+    protected variantInstancePromises: Map<string, Promise<VariantInstance>>;
+    protected variantInstances: Map<string, VariantInstance>;
+    protected variantInstanceDefinitions: Map<string, VariantInstanceDefinition>;
+    protected parameters: ParameterBag;
+    protected queues: {
+        [name: string]: Promise<VariantInstance>[];
+    };
+    /**
+     * Constructor.
+     */
+    protected constructor(rootVariant: Variant);
+    /**
+     * Creates a {@link VariantInstanceManager} based on given root Variant.
+     */
+    static create(rootVariant: Variant): Promise<VariantInstanceManager>;
+    /**
+     * Gets all instances.
+     */
+    get all(): VariantInstance[];
+    /**
+     * Gets all instance definitions.
+     */
+    get allDefinitions(): VariantInstanceDefinition[];
+    /**
+     * Checks whether a {@link VariantInstance} is either registered or created.
+     */
+    has(name: string): boolean;
+    /**
+     * Retrieves a {@link VariantInstance}.
+     * If the instance has been created, the created instance will be returned.
+     * If the instance is registered, the instance will be created and returned.
+     * if the instance has already been requested and is currently pending, the dedicated promise will be returned.
+     * If none of these apply, an Error is thrown.
+     *
+     * @emits {@link Event.VARIANT_INSTANCE_CREATED}
+     */
+    get(name: string): Promise<VariantInstance>;
+    /**
+     * Creates and registers a unique {@link VariantInstance}.
+     *
+     * @emits {@link Event.VARIANT_INSTANCE_CREATED}
+     */
+    create(dottedPath: DottedPathArgument, name?: string, parameters?: ParameterBag): Promise<VariantInstance>;
+    /**
+     * Registers a unique {@link VariantInstanceDefinition}.
+     *
+     * @emits {@link Event.VARIANT_INSTANCE_REGISTERED}
+     */
+    register(instanceDefinition: VariantInstanceDefinition): VariantInstanceDefinition;
+    /**
+     * Commits the {@link ParameterBag} to all registered and created {@link VariantInstance}s.
+     */
+    commitParameters(parameters?: ParameterBag, onlyVisible?: boolean): Promise<VariantInstanceManager>;
+    /**
+     * Show one {@link VariantInstance}. If `exclusive` is set to `true` it will hide all other
+     * instances handled by this {@link VariantInstanceManager}. If the function is called synchronously,
+     * the calls end up in a queue according to the FIFO principle (the last one wins).
+     */
+    show(name: string, exclusive?: boolean): Promise<VariantInstance>;
+    /**
+     * Clones and registers a new {@link VariantInstance} with a new, unique name.
+     *
+     * @emits {@link Event.VARIANT_INSTANCE_CLONED}
+     */
+    clone(name: string, newName: string, parameters?: ParameterBag): Promise<VariantInstance>;
+    /**
+     * Destroys the instance by removing the {@link Variant} and de-registering the instance.
+     *
+     * @emits {@link Event.VARIANT_INSTANCE_DESTROYED}
+     */
+    destroy(name: string): VariantInstanceManager;
+    /**
+     * Creates and registers a unique {@link VariantInstance} from `definition`.
+     *
+     * @emits {@link Event.VARIANT_INSTANCE_CREATED}
+     */
+    protected createFromDefinition(definition: VariantInstanceDefinition): Promise<VariantInstance>;
+    /**
+     * Creates a unique instance name based on already registered instance names on the {@link VariantInstanceManager}.
+     * Appends an `_i` to the name where `i = 0` and increments as long as the name is not registered.
+     */
+    protected ensureUniqueName(name: string): string;
+}