@combeenation/3d-viewer 5.1.0-rc3 → 5.1.0-rc4

package/dist/lib-es6/api/manager/gltfExportManager.js

@@ -0,0 +1,221 @@
+import { __assign, __awaiter, __generator } from "tslib";
+import { PBRMaterial } from '@babylonjs/core/Materials/PBR/pbrMaterial';
+import { Color3 } from '@babylonjs/core/Maths/math.color';
+import { AbstractMesh } from '@babylonjs/core/Meshes/abstractMesh';
+import { GLTF2Export } from '@babylonjs/serializers/glTF/2.0';
+import { isMeshIncludedInExclusionList } from '../util/structureHelper';
+import { merge } from 'lodash-es';
+import { Mesh } from '@babylonjs/core/Meshes/mesh';
+var GltfExportManager = /** @class */ (function () {
+    /**
+     * Constructor.
+     */
+    function GltfExportManager(viewer) {
+        this.viewer = viewer;
+    }
+    /**
+     * Creates an {@link GltfExportManager}.
+     */
+    GltfExportManager.create = function (viewer) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*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.
+     */
+    GltfExportManager.prototype.exportGlb = function (filename, exportOptions, excluded) {
+        if (filename === void 0) { filename = 'glb-export.glb'; }
+        if (exportOptions === void 0) { exportOptions = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            var glbData, resBlob;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        this.exportPreProcess();
+                        return [4 /*yield*/, GLTF2Export.GLBAsync(this.viewer.scene, 'dummy', this.gltfExportOptions(exportOptions, excluded))];
+                    case 1:
+                        glbData = _a.sent();
+                        this.exportPostProcess();
+                        resBlob = glbData.glTFFiles['dummy.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 [2 /*return*/, new File([resBlob], filename)];
+                        }
+                        else {
+                            // result was not a valid blob
+                            return [2 /*return*/, undefined];
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * 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.
+     */
+    GltfExportManager.prototype.exportGltfToFile = function (filename, exportOptions, excluded) {
+        if (exportOptions === void 0) { exportOptions = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        this.exportPreProcess();
+                        return [4 /*yield*/, GLTF2Export.GLTFAsync(this.viewer.scene, filename, this.gltfExportOptions(exportOptions, excluded)).then(function (glb) {
+                                glb.downloadFiles();
+                            })];
+                    case 1:
+                        _a.sent();
+                        this.exportPostProcess();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * 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
+     */
+    GltfExportManager.prototype.exportGlbToFile = function (filename, exportOptions, excluded) {
+        if (exportOptions === void 0) { exportOptions = {}; }
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        this.exportPreProcess();
+                        return [4 /*yield*/, GLTF2Export.GLBAsync(this.viewer.scene, filename, this.gltfExportOptions(exportOptions, excluded)).then(function (glb) {
+                                glb.downloadFiles();
+                            })];
+                    case 1:
+                        _a.sent();
+                        this.exportPostProcess();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Gets predefined {@link IExportOptions } merged with given ones.
+     */
+    GltfExportManager.prototype.gltfExportOptions = function (mergeWithOptions, excluded) {
+        if (mergeWithOptions === void 0) { mergeWithOptions = {}; }
+        var 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 && isMeshIncludedInExclusionList(node, excluded)) {
+                    return false;
+                }
+                return true;
+            },
+        };
+        return merge({}, defaultOptions, mergeWithOptions);
+    };
+    /**
+     * Stuff to be done before exporting to GLTF
+     */
+    GltfExportManager.prototype.exportPreProcess = function () {
+        this.viewer.pauseRendering();
+        this.exchangeRefractionMaterials();
+    };
+    /**
+     * Stuff to be done after the GLTF export
+     */
+    GltfExportManager.prototype.exportPostProcess = function () {
+        this.restoreRefractionMaterials();
+        this.viewer.resumeRendering();
+    };
+    /**
+     * Materials with refraction set are not exported properly.
+     * Exchange all such (relevant) materials with a more export-friendly version
+     */
+    GltfExportManager.prototype.exchangeRefractionMaterials = function () {
+        for (var _i = 0, _a = this.viewer.scene.getNodes(); _i < _a.length; _i++) {
+            var n = _a[_i];
+            if (!(n instanceof AbstractMesh))
+                continue;
+            if (!(n.material instanceof PBRMaterial))
+                continue;
+            if (!n.material.subSurface.isRefractionEnabled)
+                continue;
+            if (n.material.transparencyMode !== 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.
+     */
+    GltfExportManager.prototype.restoreRefractionMaterials = function () {
+        for (var _i = 0, _a = this.viewer.scene.getNodes(); _i < _a.length; _i++) {
+            var n = _a[_i];
+            if (!(n instanceof AbstractMesh))
+                continue;
+            if (!(n.material instanceof 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
+            var currMaterial = n.material;
+            var 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
+     */
+    GltfExportManager.prototype.createRefractionMaterialReplacement = function (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
+        var clonedMaterial = mat.clone(mat.name); // clone material. clone uses same name
+        clonedMaterial.metadata = __assign(__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 Color3(0.3, 0.3, 0.3);
+        clonedMaterial.transparencyMode = 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
+     */
+    GltfExportManager.prototype.isMaterialClonedForExport = function (mat) {
+        var _a;
+        return !!((_a = mat.metadata) === null || _a === void 0 ? void 0 : _a.clonedFrom);
+    };
+    return GltfExportManager;
+}());
+export { GltfExportManager };
+//# sourceMappingURL=gltfExportManager.js.map

package/dist/lib-es6/api/manager/gltfExportManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gltfExportManager.js","sourceRoot":"","sources":["../../../../src/api/manager/gltfExportManager.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,2CAA2C,CAAC;AACxE,OAAO,EAAE,MAAM,EAAE,MAAM,kCAAkC,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,qCAAqC,CAAC;AACnE,OAAO,EAAE,WAAW,EAAkB,MAAM,iCAAiC,CAAC;AAC9E,OAAO,EAAE,6BAA6B,EAAE,MAAM,yBAAyB,CAAC;AACxE,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,MAAM,6BAA6B,CAAC;AAEnD;IACE;;OAEG;IACH,2BAAgC,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;IAAG,CAAC;IAElD;;OAEG;IACiB,wBAAM,GAA1B,UAA2B,MAAc;;;gBACvC,sBAAO,IAAI,iBAAiB,CAAC,MAAM,CAAC,EAAC;;;KACtC;IAED;;;;;OAKG;IACU,qCAAS,GAAtB,UACE,QAA2B,EAC3B,aAAkC,EAClC,QAA+B;QAF/B,yBAAA,EAAA,2BAA2B;QAC3B,8BAAA,EAAA,kBAAkC;;;;;;wBAGlC,IAAI,CAAC,gBAAgB,EAAE,CAAC;wBACR,qBAAM,WAAW,CAAC,QAAQ,CACxC,IAAI,CAAC,MAAM,CAAC,KAAK,EACjB,OAAO,EACP,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAChD,EAAA;;wBAJK,OAAO,GAAG,SAIf;wBACD,IAAI,CAAC,iBAAiB,EAAE,CAAC;wBACnB,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;wBAE/C,iFAAiF;wBACjF,IAAI,OAAO,YAAY,IAAI,EAAE;4BAC3B,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gCAC9B,QAAQ,IAAI,MAAM,CAAC;6BACpB;4BACD,sBAAO,IAAI,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,EAAC;yBACtC;6BAAM;4BACL,8BAA8B;4BAC9B,sBAAO,SAAS,EAAC;yBAClB;;;;;KACF;IAED;;;;;OAKG;IACU,4CAAgB,GAA7B,UAA8B,QAAgB,EAAE,aAAkC,EAAE,QAA+B;QAAnE,8BAAA,EAAA,kBAAkC;;;;;wBAChF,IAAI,CAAC,gBAAgB,EAAE,CAAC;wBACxB,qBAAM,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAC5G,UAAA,GAAG;gCACD,GAAG,CAAC,aAAa,EAAE,CAAC;4BACtB,CAAC,CACF,EAAA;;wBAJD,SAIC,CAAC;wBACF,IAAI,CAAC,iBAAiB,EAAE,CAAC;;;;;KAC1B;IAED;;;;;OAKG;IACU,2CAAe,GAA5B,UAA6B,QAAgB,EAAE,aAAkC,EAAE,QAA+B;QAAnE,8BAAA,EAAA,kBAAkC;;;;;wBAC/E,IAAI,CAAC,gBAAgB,EAAE,CAAC;wBACxB,qBAAM,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAC3G,UAAA,GAAG;gCACD,GAAG,CAAC,aAAa,EAAE,CAAC;4BACtB,CAAC,CACF,EAAA;;wBAJD,SAIC,CAAC;wBACF,IAAI,CAAC,iBAAiB,EAAE,CAAC;;;;;KAC1B;IAED;;OAEG;IACO,6CAAiB,GAA3B,UAA4B,gBAAqC,EAAE,QAA+B;QAAtE,iCAAA,EAAA,qBAAqC;QAC/D,IAAM,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,IAAI,IAAI,6BAA6B,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE;oBACrF,OAAO,KAAK,CAAC;iBACd;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;SACF,CAAC;QACF,OAAO,KAAK,CAAC,EAAE,EAAE,cAAc,EAAE,gBAAgB,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACO,4CAAgB,GAA1B;QACE,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;QAC7B,IAAI,CAAC,2BAA2B,EAAE,CAAC;IACrC,CAAC;IAED;;OAEG;IACO,6CAAiB,GAA3B;QACE,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAClC,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;IAChC,CAAC;IAED;;;OAGG;IACO,uDAA2B,GAArC;QACE,KAAgB,UAA4B,EAA5B,KAAA,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,EAA5B,cAA4B,EAA5B,IAA4B,EAAE;YAAzC,IAAM,CAAC,SAAA;YACV,IAAI,CAAC,CAAC,CAAC,YAAY,YAAY,CAAC;gBAAE,SAAS;YAC3C,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,YAAY,WAAW,CAAC;gBAAE,SAAS;YACnD,IAAI,CAAE,CAAC,CAAC,QAAwB,CAAC,UAAU,CAAC,mBAAmB;gBAAE,SAAS;YAC1E,IAAK,CAAC,CAAC,QAAwB,CAAC,gBAAgB,KAAK,WAAW,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,sDAA0B,GAApC;QACE,KAAgB,UAA4B,EAA5B,KAAA,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,EAA5B,cAA4B,EAA5B,IAA4B,EAAE;YAAzC,IAAM,CAAC,SAAA;YACV,IAAI,CAAC,CAAC,CAAC,YAAY,YAAY,CAAC;gBAAE,SAAS;YAC3C,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,YAAY,WAAW,CAAC;gBAAE,SAAS;YACnD,IAAI,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,CAAC,QAAQ,CAAC;gBAAE,SAAS;YAC1D,4FAA4F;YAE5F,sBAAsB;YACtB,IAAM,YAAY,GAAG,CAAC,CAAC,QAAQ,CAAC;YAChC,IAAM,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,+DAAmC,GAA7C,UAA8C,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,yBAAQ,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,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QACvD,cAAc,CAAC,gBAAgB,GAAG,WAAW,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,qDAAyB,GAAnC,UAAoC,GAAgB;;QAClD,OAAO,CAAC,QAAC,GAAG,CAAC,QAAQ,0CAAE,UAAU,CAAA,CAAC;IACpC,CAAC;IACH,wBAAC;AAAD,CAAC,AAtLD,IAsLC"}

package/dist/lib-es6/api/manager/sceneManager.d.ts

@@ -0,0 +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>;
+}

package/dist/lib-es6/api/manager/sceneManager.js

@@ -0,0 +1,150 @@
+import { __awaiter, __extends, __generator } from "tslib";
+import { cloneDeep, concat, merge } from 'lodash-es';
+import { ParameterObservable } from '../classes/parameterObservable';
+import { Event } from '../classes/event';
+import { SpecStorage } from '../store/specStorage';
+import { mergeMaps } from '../util/resourceHelper';
+import { Parameter } from '../classes/parameter';
+import { changeEnvironment } from '../util/babylonHelper';
+var SceneManager = /** @class */ (function (_super) {
+    __extends(SceneManager, _super);
+    /**
+     * Constructor.
+     */
+    function SceneManager(scene) {
+        var _this = _super.call(this) || this;
+        _this.scene = scene;
+        _this._parameterObservers = new Map();
+        _this.addParameterObservers();
+        return _this;
+    }
+    /**
+     * Creates a {@link SceneManager} based on given BabylonJS scene.
+     */
+    SceneManager.create = function (scene) {
+        return __awaiter(this, void 0, void 0, function () {
+            var sceneManager;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        sceneManager = new SceneManager(scene);
+                        return [4 /*yield*/, sceneManager.bootstrapParameters(SpecStorage.get('scene.parameters'))];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, sceneManager];
+                }
+            });
+        });
+    };
+    Object.defineProperty(SceneManager.prototype, "activeCamera", {
+        /**
+         * The active `Camera`.
+         */
+        get: function () {
+            if (!this.scene.activeCamera) {
+                throw new Error('Scene has no active camera.');
+            }
+            return this.scene.activeCamera;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * 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}
+     */
+    SceneManager.prototype.commitParameters = function (parameters) {
+        return __awaiter(this, void 0, void 0, function () {
+            var oldParameters, observerPromises, _loop_1, this_1, parameter;
+            var _this = this;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!parameters) {
+                            parameters = {};
+                        }
+                        oldParameters = cloneDeep(this.parameters);
+                        merge(this.parameters, parameters);
+                        observerPromises = [];
+                        _loop_1 = function (parameter) {
+                            var oldParameterValue = oldParameters[parameter];
+                            var newParameterValue = this_1.parameters[parameter];
+                            this_1.assertParameter(Parameter.declarations, parameter, newParameterValue);
+                            if (oldParameterValue === newParameterValue) {
+                                return "continue";
+                            }
+                            // parameter changed
+                            var parameterObservers = mergeMaps(this_1._parameterObservers, this_1.parameterObservers);
+                            if (parameterObservers.has(parameter)) {
+                                var observers = parameterObservers.get(parameter);
+                                observerPromises = concat(observerPromises, observers.map(function (observer) {
+                                    var observerResult = observer(_this, oldParameterValue, newParameterValue);
+                                    var observerPromise = Promise.resolve(observerResult);
+                                    observerPromise.then(function () {
+                                        _this.broadcastEvent(Event.SCENE_PARAMETER_COMMITTED, _this, parameter, oldParameterValue, newParameterValue);
+                                    });
+                                    return observerPromise;
+                                }));
+                            }
+                        };
+                        this_1 = this;
+                        for (parameter in this.parameters) {
+                            _loop_1(parameter);
+                        }
+                        return [4 /*yield*/, Promise.all(observerPromises)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, this];
+                }
+            });
+        });
+    };
+    SceneManager.prototype.addParameterObservers = function () {
+        var handleEnvParamChange = function (manager, oldValue, newValue) {
+            var params = {
+                color: manager.parameters[Parameter.ENVIRONMENT_COLOR],
+                intensity: manager.parameters[Parameter.ENVIRONMENT_INTENSITY],
+                env: manager.parameters[Parameter.ENVIRONMENT],
+                background: manager.parameters[Parameter.ENVIRONMENT_BACKGROUND],
+                rotation: manager.parameters[Parameter.ENVIRONMENT_ROTATION],
+                useDefault: manager.parameters[Parameter.ENVIRONMENT_USEDEFAULT],
+            };
+            var envDef = {
+                environmentColor: params.color ? Parameter.parseColor(params.color) : undefined,
+                environmentIntensity: params.intensity !== undefined ? Parameter.parseNumber(params.intensity) : undefined,
+                environment: params.env ? params.env : undefined,
+                environmentBackground: params.background ? params.background : undefined,
+                environmentRotation: params.rotation !== undefined ? Parameter.parseNumber(params.rotation) : undefined,
+                environmentUseDefault: params.useDefault ? Parameter.parseBoolean(params.useDefault) : undefined,
+            };
+            changeEnvironment(manager.scene, envDef);
+        };
+        this._parameterObservers.set(Parameter.ENVIRONMENT_COLOR, [handleEnvParamChange]);
+        this._parameterObservers.set(Parameter.ENVIRONMENT_ROTATION, [handleEnvParamChange]);
+        this._parameterObservers.set(Parameter.ENVIRONMENT_USEDEFAULT, [handleEnvParamChange]);
+        this._parameterObservers.set(Parameter.ENVIRONMENT, [handleEnvParamChange]);
+        this._parameterObservers.set(Parameter.ENVIRONMENT_BACKGROUND, [handleEnvParamChange]);
+        this._parameterObservers.set(Parameter.ENVIRONMENT_INTENSITY, [handleEnvParamChange]);
+        return this;
+    };
+    /**
+     * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
+     */
+    SceneManager.prototype.bootstrapParameters = function (parameters) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.commitParameters(merge(cloneDeep(this.parameters), parameters))];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, this];
+                }
+            });
+        });
+    };
+    return SceneManager;
+}(ParameterObservable));
+export { SceneManager };
+//# sourceMappingURL=sceneManager.js.map

package/dist/lib-es6/api/manager/sceneManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sceneManager.js","sourceRoot":"","sources":["../../../../src/api/manager/sceneManager.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE1D;IAAkC,gCAAmB;IAGnD;;OAEG;IACH,sBAA6B,KAAmB;QAAhD,YACE,iBAAO,SAER;QAH4B,WAAK,GAAL,KAAK,CAAc;QAL7B,yBAAmB,GAAqC,IAAI,GAAG,EAAE,CAAC;QAOnF,KAAI,CAAC,qBAAqB,EAAE,CAAC;;IAC/B,CAAC;IAED;;OAEG;IACiB,mBAAM,GAA1B,UAA2B,KAAmB;;;;;;wBACtC,YAAY,GAAG,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;wBAC7C,qBAAM,YAAY,CAAC,mBAAmB,CAAC,WAAW,CAAC,GAAG,CAAe,kBAAkB,CAAC,CAAC,EAAA;;wBAAzF,SAAyF,CAAC;wBAC1F,sBAAO,YAAY,EAAC;;;;KACrB;IAKD,sBAAI,sCAAY;QAHhB;;WAEG;aACH;YACE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE;gBAC5B,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;aAChD;YACD,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;QACjC,CAAC;;;OAAA;IAED;;;;;OAKG;IACU,uCAAgB,GAA7B,UAA8B,UAAyB;;;;;;;wBACrD,IAAI,CAAC,UAAU,EAAE;4BACf,UAAU,GAAG,EAAE,CAAC;yBACjB;wBACK,aAAa,GAAG,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;wBACjD,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;wBAG/B,gBAAgB,GAAwC,EAAE,CAAC;4CACpD,SAAS;4BAClB,IAAM,iBAAiB,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;4BACnD,IAAM,iBAAiB,GAAG,OAAK,UAAU,CAAC,SAAS,CAAC,CAAC;4BACrD,OAAK,eAAe,CAAC,SAAS,CAAC,YAAY,EAAE,SAAS,EAAE,iBAAiB,CAAC,CAAC;4BAC3E,IAAI,iBAAiB,KAAK,iBAAiB,EAAE;;6BAE5C;4BACD,oBAAoB;4BACpB,IAAM,kBAAkB,GAAG,SAAS,CAAC,OAAK,mBAAmB,EAAE,OAAK,kBAAkB,CAAC,CAAC;4BACxF,IAAI,kBAAkB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;gCACrC,IAAM,SAAS,GAAG,kBAAkB,CAAC,GAAG,CAAC,SAAS,CAAE,CAAC;gCACrD,gBAAgB,GAAG,MAAM,CACvB,gBAAgB,EAChB,SAAS,CAAC,GAAG,CAAC,UAAA,QAAQ;oCACpB,IAAM,cAAc,GAAG,QAAQ,CAAC,KAAI,EAAE,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;oCAC5E,IAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;oCACxD,eAAe,CAAC,IAAI,CAAC;wCACnB,KAAI,CAAC,cAAc,CACjB,KAAK,CAAC,yBAAyB,EAC/B,KAAI,EACJ,SAAS,EACT,iBAAiB,EACjB,iBAAiB,CAClB,CAAC;oCACJ,CAAC,CAAC,CAAC;oCACH,OAAO,eAAe,CAAC;gCACzB,CAAC,CAAC,CACH,CAAC;6BACH;;;wBA5BH,KAAW,SAAS,IAAI,IAAI,CAAC,UAAU;oCAA5B,SAAS;yBA6BnB;wBACD,qBAAM,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAA;;wBAAnC,SAAmC,CAAC;wBACpC,sBAAO,IAAI,EAAC;;;;KACb;IAES,4CAAqB,GAA/B;QACE,IAAM,oBAAoB,GAAG,UAAC,OAAqB,EAAE,QAAwB,EAAE,QAAwB;YACrG,IAAM,MAAM,GAAG;gBACb,KAAK,EAAE,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,iBAAiB,CAAC;gBACtD,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,qBAAqB,CAAC;gBAC9D,GAAG,EAAE,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC;gBAC9C,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,sBAAsB,CAAC;gBAChE,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,oBAAoB,CAAC;gBAC5D,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,sBAAsB,CAAC;aACjE,CAAC;YACF,IAAM,MAAM,GAA0B;gBACpC,gBAAgB,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS;gBAC/E,oBAAoB,EAAE,MAAM,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,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,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS;gBACvG,qBAAqB,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;aACjG,CAAC;YACF,iBAAiB,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAC3C,CAAC,CAAC;QAEF,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAClF,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC;QACrF,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC,sBAAsB,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC;QACvF,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC;QAC5E,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC,sBAAsB,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC;QACvF,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC,qBAAqB,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC;QACtF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACa,0CAAmB,GAAnC,UAAoC,UAAyB;;;;4BAC3D,qBAAM,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC,CAAC,EAAA;;wBAA1E,SAA0E,CAAC;wBAC3E,sBAAO,IAAI,EAAC;;;;KACb;IACH,mBAAC;AAAD,CAAC,AApHD,CAAkC,mBAAmB,GAoHpD"}

package/dist/lib-es6/api/manager/variantInstanceManager.d.ts

@@ -0,0 +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;
+}