@combeenation/3d-viewer 12.4.1 → 13.0.0

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

@@ -0,0 +1,381 @@
+"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.ModelManager = void 0;
+const index_1 = require("../index");
+const cloningHelper_1 = require("../internal/cloningHelper");
+const metadataHelper_1 = require("../internal/metadataHelper");
+const lodash_es_1 = require("lodash-es");
+/**
+ * Manager for handling 3d models.\
+ * Responsible for loading models and handling their visibility.\
+ * Also contains advanced features like model cloning.
+ */
+class ModelManager {
+    constructor(viewer) {
+        this.viewer = viewer;
+        this._modelAssets = {};
+        this._fallbackModelAsset = {
+            name: ModelManager.CBN_FALLBACK_MODEL_ASSET_NAME,
+            url: '',
+            state: 'loaded',
+            assetContainer: new index_1.AssetContainer(),
+            isClone: false,
+        };
+        this._loadModelPromises = {};
+    }
+    get modelNames() {
+        return Object.keys(this._modelAssets);
+    }
+    /**
+     * Nested models were targeted with slash notation previously, as Spec couldn't work with dots.
+     * Dots were interpreted as inherited model.
+     * Now the Hive viewer parameters are returning slash notated asset names, whereas the asset names from the
+     * prepacked asset manager are dot notated.
+     * This function converts slash to dot notation, so that models can be target with slash and dot notation alike.
+     */
+    static _replaceSlashes(inputStr) {
+        return inputStr.split('/').join('.');
+    }
+    /**
+     * Creates content for the fallback model, which is actually just a black cube.
+     * This is used for 3d assets that are linked in a data source but not available (yet).
+     * The Combeenation backend exchanges the missing 3d asset name with "$fallback", which indicates that we shouldn't
+     * throw an error but just show the fallback model instead.
+     *
+     * @internal
+     */
+    createFallbackModel() {
+        const fallbackCube = index_1.MeshBuilder.CreateBox('$fallbackCube', { size: 1 }, this.viewer.scene);
+        fallbackCube._parentContainer = this._fallbackModelAsset.assetContainer;
+        this._fallbackModelAsset.assetContainer.meshes.push(fallbackCube);
+        // NOTE: this is theoretically async, but in reality it's not when getting the material description from the CBN
+        // server
+        // also this is just a fallback that shouldn't be relevant in productive configurators
+        this.viewer.materialManager.setMaterialOnMesh(index_1.MaterialManager.CBN_FALLBACK_MATERIAL_NAME, fallbackCube);
+        this._fallbackModelAsset.assetContainer.removeFromScene();
+    }
+    /**
+     * Register models for 3d viewer, this is required for each model before it can be loaded/shown.\
+     * The "viewer control" inside the Combeenation framework calls this function automatically with all assigned
+     * 3d assets.
+     */
+    registerModels(modelAssets) {
+        for (const { name, url } of modelAssets) {
+            const existingModel = this._modelAssets[name];
+            if (existingModel) {
+                console.warn(`Model ${name} is already registered`);
+                return;
+            }
+            const model = { name, url, state: 'notLoaded', assetContainer: new index_1.AssetContainer(), isClone: false };
+            this._modelAssets[name] = model;
+        }
+    }
+    /**
+     * Loads the model and all it's assigned materials.\
+     * This function should be used for "eager loading" of models, so that model switching will be instant in the
+     * process.\
+     * If you don't plan to do this, just use {@link setModelVisibility} as this function will load the model under the
+     * hood the first time the model gets visible.
+     */
+    loadModel(name) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const model = this._getModel(name);
+            if (!model) {
+                throw new index_1.ViewerError({
+                    id: index_1.ViewerErrorIds.ModelNotRegistered,
+                    message: `Can't load model "${name}" as model is not registered`,
+                });
+            }
+            if (model.state !== 'notLoaded') {
+                console.warn(`Model ${name} is already loaded or currently loading`);
+                return;
+            }
+            yield this._loadModel(model);
+            yield this._prepareModelForScene(model);
+        });
+    }
+    /**
+     * Enables/disables multiple one or multiple models simultaniously.\
+     * All required models are loaded before adjusting the visibility to avoid flashing in the 3d scene.
+     *
+     * @returns Array of changed visibility status, combined with the corresponding model name
+     */
+    setModelVisibility(modelVisibility) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const showModels = [];
+            const hideModels = [];
+            if (!(0, lodash_es_1.isArray)(modelVisibility)) {
+                modelVisibility = [modelVisibility];
+            }
+            for (const entry of modelVisibility) {
+                const model = this._getModel(entry.name);
+                if (!model) {
+                    throw new index_1.ViewerError({
+                        id: index_1.ViewerErrorIds.ModelNotRegistered,
+                        message: `Can't set visibility of model "${entry.name}" as model is not registered`,
+                    });
+                }
+                // there can be multiple "setModelVisibility" calls while the model is loading
+                // loading can be awaited, but it has to be ensured, that the last call of "setModelVisibility" has priority
+                // therefore we store the id of the call in the model
+                const curVisibilityCallId = ((_a = model.visibilityCallId) !== null && _a !== void 0 ? _a : 0) + 1;
+                model.visibilityCallId = curVisibilityCallId;
+                if (entry.visible) {
+                    if (model.state === 'notLoaded') {
+                        yield this._loadModel(model);
+                        // check if this is still the latest visibility call
+                        if (model.visibilityCallId === curVisibilityCallId) {
+                            showModels.push(model);
+                        }
+                    }
+                    else if (model.state === 'loading') {
+                        yield this._loadModelPromises[model.name];
+                        if (model.visibilityCallId === curVisibilityCallId) {
+                            showModels.push(model);
+                        }
+                    }
+                    else if (model.state === 'loaded') {
+                        showModels.push(model);
+                    }
+                }
+                else {
+                    if (model.state === 'loading') {
+                        yield this._loadModelPromises[model.name];
+                        if (model.visibilityCallId === curVisibilityCallId) {
+                            hideModels.push(model);
+                        }
+                    }
+                    else if (model.state === 'inScene') {
+                        hideModels.push(model);
+                    }
+                }
+            }
+            for (const showModel of showModels) {
+                yield this._prepareModelForScene(showModel);
+            }
+            for (const showModel of showModels) {
+                yield this._showModel(showModel, true);
+            }
+            for (const hideModel of hideModels) {
+                this._hideModel(hideModel);
+            }
+            const returnVal = [];
+            showModels.forEach(showModel => returnVal.push({ name: showModel.name, visible: true }));
+            hideModels.forEach(hideModel => returnVal.push({ name: hideModel.name, visible: false }));
+            return returnVal;
+        });
+    }
+    /**
+     * Create a clone of an existing model.\
+     * Only the geometry (meshes, transform nodes) gets cloned, as materials are typically shared across the whole scene.
+     *
+     * @param show show model immediately after cloning
+     * @param options additional options for the cloning procedure, like renaming algorithms
+     */
+    cloneModel(name, newModelName, show = true, options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const sourceModel = this._getModel(name);
+            if (!sourceModel) {
+                throw new index_1.ViewerError({
+                    id: index_1.ViewerErrorIds.ModelNotRegistered,
+                    message: `Can't clone model "${name}" as model is not registered`,
+                });
+            }
+            const existingModel = this._getModel(newModelName);
+            if (existingModel) {
+                throw new index_1.ViewerError({
+                    id: index_1.ViewerErrorIds.ModelAlreadyExists,
+                    message: `Can't create clone as model "${newModelName}" already exists`,
+                });
+            }
+            if (sourceModel.state === 'notLoaded') {
+                yield this._loadModel(sourceModel);
+            }
+            else if (sourceModel.state === 'loading') {
+                yield this._loadModelPromises[sourceModel.name];
+            }
+            const clonedModel = {
+                name: newModelName,
+                url: sourceModel.url,
+                state: 'loaded',
+                assetContainer: (0, cloningHelper_1.cloneModelAssetContainer)(sourceModel.assetContainer, newModelName, {
+                    nodeNamingStrategy: options === null || options === void 0 ? void 0 : options.nodeNamingStrategy,
+                    tagNamingStrategy: options === null || options === void 0 ? void 0 : options.tagNamingStrategy,
+                }, this.viewer.scene),
+                isClone: true,
+            };
+            this._modelAssets[newModelName] = clonedModel;
+            if (show) {
+                yield this._showModel(clonedModel);
+            }
+        });
+    }
+    /**
+     * Removes a cloned model from the scene and from the internal model storage.\
+     * Deleted clones can not be shown again.
+     */
+    deleteClonedModel(name) {
+        const model = this._getModel(name);
+        if (!model) {
+            throw new index_1.ViewerError({
+                id: index_1.ViewerErrorIds.ModelNotRegistered,
+                message: `Can't delete cloned model "${name}" as model is not registered`,
+            });
+        }
+        if (!model.isClone) {
+            throw new index_1.ViewerError({
+                id: index_1.ViewerErrorIds.ModelIsNotAClone,
+                message: `Can't delete model "${name}" as model is not a clone`,
+            });
+        }
+        model.assetContainer.dispose();
+        delete this._modelAssets[name];
+    }
+    /**
+     * Removes all cloned models from the scene and the internal model storage.
+     */
+    deleteAllClonedModels() {
+        const clonedModelNames = Object.values(this._modelAssets)
+            .filter(model => model.isClone)
+            .map(model => model.name);
+        clonedModelNames.forEach(modelName => this.deleteClonedModel(modelName));
+    }
+    /**
+     * Loads and returns the asset container of a certain model.\
+     * This can be used to access the models content without having to add it to the scene.\
+     * A typical use case is to clone or instantiate a node from a "library" model.
+     */
+    getAssetContainerOfModel(name) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const model = this._getModel(name);
+            if (!model) {
+                throw new index_1.ViewerError({
+                    id: index_1.ViewerErrorIds.ModelNotRegistered,
+                    message: `Can't get asset container of model "${name}" as model is not registered`,
+                });
+            }
+            if (model.state === 'notLoaded') {
+                yield this._loadModel(model);
+            }
+            else if (model.state === 'loading') {
+                yield this._loadModelPromises[model.name];
+            }
+            yield this._prepareModelForScene(model);
+            return model.assetContainer;
+        });
+    }
+    /**
+     * Get model by name
+     */
+    _getModel(name) {
+        if (name === '$fallback') {
+            return this._fallbackModelAsset;
+        }
+        const replacedName = ModelManager._replaceSlashes(name);
+        const model = this._modelAssets[replacedName];
+        return model;
+    }
+    /**
+     * Load model into scene, but don't show it immediately
+     */
+    _loadModel(model) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const loadModelPromise = () => __awaiter(this, void 0, void 0, function* () {
+                model.state = 'loading';
+                const curEnvTexture = this.viewer.scene.environmentTexture;
+                const curEnvIntensity = this.viewer.scene.environmentIntensity;
+                let assetContainer;
+                try {
+                    assetContainer = yield index_1.SceneLoader.LoadAssetContainerAsync('', model.url, this.viewer.scene);
+                }
+                catch (e) {
+                    throw new index_1.ViewerError({
+                        id: index_1.ViewerErrorIds.AssetLoadingFailed,
+                        message: `Error loading model "${model.name}" from url "${model.url}":\n${e.message}`,
+                    });
+                }
+                // remove all lights and cameras from the asset, as this data should be handled globally in the scene instead of
+                // being in a model context
+                [...assetContainer.lights].forEach(light => light.dispose());
+                [...assetContainer.cameras].forEach(camera => camera.dispose());
+                // environment texture and intensity has been overwritten by load asset container function
+                this.viewer.scene.environmentTexture = curEnvTexture;
+                this.viewer.scene.environmentIntensity = curEnvIntensity;
+                model.assetContainer = assetContainer;
+                model.state = 'loaded';
+                delete this._loadModelPromises[model.name];
+            });
+            this._loadModelPromises[model.name] = loadModelPromise();
+            return this._loadModelPromises[model.name];
+        });
+    }
+    /**
+     * Apply parameter to the model in the asset container.
+     * This is typically done before the model is added to the scene to avoid changes on the visible model, which ensures
+     * a smooth model switch behaviour.
+     */
+    _prepareModelForScene(model) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.viewer.parameterManager.applyAllParameterValuesToModel(model.assetContainer);
+            // parameter manager did his job, now apply the deferred materials to all meshes that are not explicitely hidden by
+            // the parameter manager
+            yield this._applyDeferredMaterialsForAllVisibleMeshes(model);
+        });
+    }
+    /**
+     * Add assets of asset container to scene, do the scene preparation if required.
+     * CAUTION: model is expected to be in the correct loading state already.
+     *
+     * @param skipPreparation optionally skip applying parameter values to model before showing it
+     *                        (see {@link _prepareModelForScene})
+     */
+    _showModel(model, skipPreparation) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!skipPreparation) {
+                yield this._prepareModelForScene(model);
+            }
+            model.assetContainer.addToScene();
+            model.state = 'inScene';
+        });
+    }
+    /**
+     * Remove assets of asset container from scene
+     */
+    _hideModel(model) {
+        model.assetContainer.removeFromScene();
+        model.state = 'loaded';
+    }
+    /**
+     * Creates and assigns each "deferred" material to the corresponding mesh, if the mesh is visible.
+     * Model should be ready to use immediately after this function has done it's job.
+     */
+    _applyDeferredMaterialsForAllVisibleMeshes(model) {
+        return __awaiter(this, void 0, void 0, function* () {
+            for (const mesh of model.assetContainer.meshes) {
+                const deferredMaterial = (0, metadataHelper_1.getInternalMetadataValue)(mesh, 'deferredMaterial');
+                const rawVisibleValue = this.viewer.parameterManager.getParameterValueOfNode(mesh, index_1.BuiltInParameter.Visible);
+                const visible = rawVisibleValue === undefined || index_1.ParameterManager.parseBoolean(rawVisibleValue) === true;
+                if (deferredMaterial && visible) {
+                    yield this.viewer.materialManager.setMaterialOnMesh(deferredMaterial, mesh);
+                }
+            }
+        });
+    }
+}
+exports.ModelManager = ModelManager;
+/**
+ * CAUTION: this has to be in sync with the Combeenation backend!
+ * @internal
+ */
+ModelManager.CBN_FALLBACK_MODEL_ASSET_NAME = '$fallback';
+//# sourceMappingURL=modelManager.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"modelManager.js","sourceRoot":"","sources":["../../../src/manager/modelManager.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,oCAWkB;AAClB,6DAAqE;AACrE,+DAAsE;AACtE,yCAAoC;AAqCpC;;;;GAIG;AACH,MAAa,YAAY;IAkCvB,YAA6B,MAAc;QAAd,WAAM,GAAN,MAAM,CAAQ;QA3BjC,iBAAY,GAElB,EAAE,CAAC;QACG,wBAAmB,GAAU;YACrC,IAAI,EAAE,YAAY,CAAC,6BAA6B;YAChD,GAAG,EAAE,EAAE;YACP,KAAK,EAAE,QAAQ;YACf,cAAc,EAAE,IAAI,sBAAc,EAAE;YACpC,OAAO,EAAE,KAAK;SACf,CAAC;QACQ,uBAAkB,GAA2C,EAAE,CAAC;IAiB5B,CAAC;IAf/C,IAAI,UAAU;QACZ,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACO,MAAM,CAAC,eAAe,CAAC,QAAgB;QAC/C,OAAO,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvC,CAAC;IAID;;;;;;;OAOG;IACI,mBAAmB;QACxB,MAAM,YAAY,GAAG,mBAAW,CAAC,SAAS,CAAC,eAAe,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5F,YAAY,CAAC,gBAAgB,GAAG,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC;QACxE,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAClE,gHAAgH;QAChH,SAAS;QACT,sFAAsF;QACtF,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,iBAAiB,CAAC,uBAAe,CAAC,0BAA0B,EAAE,YAAY,CAAC,CAAC;QAExG,IAAI,CAAC,mBAAmB,CAAC,cAAc,CAAC,eAAe,EAAE,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACI,cAAc,CAAC,WAAmC;QACvD,KAAK,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,WAAW,EAAE;YACvC,MAAM,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;YAC9C,IAAI,aAAa,EAAE;gBACjB,OAAO,CAAC,IAAI,CAAC,SAAS,IAAI,wBAAwB,CAAC,CAAC;gBACpD,OAAO;aACR;YAED,MAAM,KAAK,GAAU,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,WAAW,EAAE,cAAc,EAAE,IAAI,sBAAc,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;YAC7G,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;SACjC;IACH,CAAC;IAED;;;;;;OAMG;IACU,SAAS,CAAC,IAAY;;YACjC,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACnC,IAAI,CAAC,KAAK,EAAE;gBACV,MAAM,IAAI,mBAAW,CAAC;oBACpB,EAAE,EAAE,sBAAc,CAAC,kBAAkB;oBACrC,OAAO,EAAE,qBAAqB,IAAI,8BAA8B;iBACjE,CAAC,CAAC;aACJ;YAED,IAAI,KAAK,CAAC,KAAK,KAAK,WAAW,EAAE;gBAC/B,OAAO,CAAC,IAAI,CAAC,SAAS,IAAI,yCAAyC,CAAC,CAAC;gBACrE,OAAO;aACR;YAED,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YAC7B,MAAM,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAC1C,CAAC;KAAA;IAED;;;;;OAKG;IACU,kBAAkB,CAC7B,eAA8D;;;YAE9D,MAAM,UAAU,GAAY,EAAE,CAAC;YAC/B,MAAM,UAAU,GAAY,EAAE,CAAC;YAE/B,IAAI,CAAC,IAAA,mBAAO,EAAC,eAAe,CAAC,EAAE;gBAC7B,eAAe,GAAG,CAAC,eAAe,CAAC,CAAC;aACrC;YAED,KAAK,MAAM,KAAK,IAAI,eAAe,EAAE;gBACnC,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACzC,IAAI,CAAC,KAAK,EAAE;oBACV,MAAM,IAAI,mBAAW,CAAC;wBACpB,EAAE,EAAE,sBAAc,CAAC,kBAAkB;wBACrC,OAAO,EAAE,kCAAkC,KAAK,CAAC,IAAI,8BAA8B;qBACpF,CAAC,CAAC;iBACJ;gBAED,8EAA8E;gBAC9E,4GAA4G;gBAC5G,qDAAqD;gBACrD,MAAM,mBAAmB,GAAG,CAAC,MAAA,KAAK,CAAC,gBAAgB,mCAAI,CAAC,CAAC,GAAG,CAAC,CAAC;gBAC9D,KAAK,CAAC,gBAAgB,GAAG,mBAAmB,CAAC;gBAE7C,IAAI,KAAK,CAAC,OAAO,EAAE;oBACjB,IAAI,KAAK,CAAC,KAAK,KAAK,WAAW,EAAE;wBAC/B,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;wBAE7B,oDAAoD;wBACpD,IAAI,KAAK,CAAC,gBAAgB,KAAK,mBAAmB,EAAE;4BAClD,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;yBACxB;qBACF;yBAAM,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE;wBACpC,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;wBAE1C,IAAI,KAAK,CAAC,gBAAgB,KAAK,mBAAmB,EAAE;4BAClD,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;yBACxB;qBACF;yBAAM,IAAI,KAAK,CAAC,KAAK,KAAK,QAAQ,EAAE;wBACnC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;qBACxB;iBACF;qBAAM;oBACL,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE;wBAC7B,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;wBAE1C,IAAI,KAAK,CAAC,gBAAgB,KAAK,mBAAmB,EAAE;4BAClD,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;yBACxB;qBACF;yBAAM,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE;wBACpC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;qBACxB;iBACF;aACF;YAED,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;gBAClC,MAAM,IAAI,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC;aAC7C;YAED,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;gBAClC,MAAM,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;aACxC;YAED,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE;gBAClC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;aAC5B;YAED,MAAM,SAAS,GAA2B,EAAE,CAAC;YAC7C,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YACzF,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;YAE1F,OAAO,SAAS,CAAC;;KAClB;IAED;;;;;;OAMG;IACU,UAAU,CACrB,IAAY,EACZ,YAAoB,EACpB,OAAgB,IAAI,EACpB,OAA2B;;YAE3B,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACzC,IAAI,CAAC,WAAW,EAAE;gBAChB,MAAM,IAAI,mBAAW,CAAC;oBACpB,EAAE,EAAE,sBAAc,CAAC,kBAAkB;oBACrC,OAAO,EAAE,sBAAsB,IAAI,8BAA8B;iBAClE,CAAC,CAAC;aACJ;YAED,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YACnD,IAAI,aAAa,EAAE;gBACjB,MAAM,IAAI,mBAAW,CAAC;oBACpB,EAAE,EAAE,sBAAc,CAAC,kBAAkB;oBACrC,OAAO,EAAE,gCAAgC,YAAY,kBAAkB;iBACxE,CAAC,CAAC;aACJ;YAED,IAAI,WAAW,CAAC,KAAK,KAAK,WAAW,EAAE;gBACrC,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;aACpC;iBAAM,IAAI,WAAW,CAAC,KAAK,KAAK,SAAS,EAAE;gBAC1C,MAAM,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;aACjD;YAED,MAAM,WAAW,GAAU;gBACzB,IAAI,EAAE,YAAY;gBAClB,GAAG,EAAE,WAAW,CAAC,GAAG;gBACpB,KAAK,EAAE,QAAQ;gBACf,cAAc,EAAE,IAAA,wCAAwB,EACtC,WAAW,CAAC,cAAc,EAC1B,YAAY,EACZ;oBACE,kBAAkB,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,kBAAkB;oBAC/C,iBAAiB,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,iBAAiB;iBAC9C,EACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAClB;gBACD,OAAO,EAAE,IAAI;aACd,CAAC;YACF,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,GAAG,WAAW,CAAC;YAE9C,IAAI,IAAI,EAAE;gBACR,MAAM,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;aACpC;QACH,CAAC;KAAA;IAED;;;OAGG;IACI,iBAAiB,CAAC,IAAY;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACnC,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,mBAAW,CAAC;gBACpB,EAAE,EAAE,sBAAc,CAAC,kBAAkB;gBACrC,OAAO,EAAE,8BAA8B,IAAI,8BAA8B;aAC1E,CAAC,CAAC;SACJ;QAED,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;YAClB,MAAM,IAAI,mBAAW,CAAC;gBACpB,EAAE,EAAE,sBAAc,CAAC,gBAAgB;gBACnC,OAAO,EAAE,uBAAuB,IAAI,2BAA2B;aAChE,CAAC,CAAC;SACJ;QAED,KAAK,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;QAE/B,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,qBAAqB;QAC1B,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC;aACtD,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;aAC9B,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAE5B,gBAAgB,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACU,wBAAwB,CAAC,IAAY;;YAChD,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACnC,IAAI,CAAC,KAAK,EAAE;gBACV,MAAM,IAAI,mBAAW,CAAC;oBACpB,EAAE,EAAE,sBAAc,CAAC,kBAAkB;oBACrC,OAAO,EAAE,uCAAuC,IAAI,8BAA8B;iBACnF,CAAC,CAAC;aACJ;YAED,IAAI,KAAK,CAAC,KAAK,KAAK,WAAW,EAAE;gBAC/B,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;aAC9B;iBAAM,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE;gBACpC,MAAM,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;aAC3C;YAED,MAAM,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;YAExC,OAAO,KAAK,CAAC,cAAc,CAAC;QAC9B,CAAC;KAAA;IAED;;OAEG;IACO,SAAS,CAAC,IAAY;QAC9B,IAAI,IAAI,KAAK,WAAW,EAAE;YACxB,OAAO,IAAI,CAAC,mBAAmB,CAAC;SACjC;QAED,MAAM,YAAY,GAAG,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;QAE9C,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACa,UAAU,CAAC,KAAY;;YACrC,MAAM,gBAAgB,GAAG,GAAwB,EAAE;gBACjD,KAAK,CAAC,KAAK,GAAG,SAAS,CAAC;gBACxB,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC;gBAC3D,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC;gBAE/D,IAAI,cAAc,CAAC;gBACnB,IAAI;oBACF,cAAc,GAAG,MAAM,mBAAW,CAAC,uBAAuB,CAAC,EAAE,EAAE,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;iBAC9F;gBAAC,OAAO,CAAC,EAAE;oBACV,MAAM,IAAI,mBAAW,CAAC;wBACpB,EAAE,EAAE,sBAAc,CAAC,kBAAkB;wBACrC,OAAO,EAAE,wBAAwB,KAAK,CAAC,IAAI,eAAe,KAAK,CAAC,GAAG,OAAQ,CAAW,CAAC,OAAO,EAAE;qBACjG,CAAC,CAAC;iBACJ;gBAED,gHAAgH;gBAChH,2BAA2B;gBAC3B,CAAC,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;gBAC7D,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC;gBAEhE,0FAA0F;gBAC1F,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,GAAG,aAAa,CAAC;gBACrD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,GAAG,eAAe,CAAC;gBAEzD,KAAK,CAAC,cAAc,GAAG,cAAc,CAAC;gBACtC,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC;gBAEvB,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC7C,CAAC,CAAA,CAAC;YAEF,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,gBAAgB,EAAE,CAAC;YACzD,OAAO,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC;KAAA;IAED;;;;OAIG;IACa,qBAAqB,CAAC,KAAY;;YAChD,MAAM,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,8BAA8B,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YACxF,mHAAmH;YACnH,wBAAwB;YACxB,MAAM,IAAI,CAAC,0CAA0C,CAAC,KAAK,CAAC,CAAC;QAC/D,CAAC;KAAA;IAED;;;;;;OAMG;IACa,UAAU,CAAC,KAAY,EAAE,eAAyB;;YAChE,IAAI,CAAC,eAAe,EAAE;gBACpB,MAAM,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;aACzC;YAED,KAAK,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;YAClC,KAAK,CAAC,KAAK,GAAG,SAAS,CAAC;QAC1B,CAAC;KAAA;IAED;;OAEG;IACO,UAAU,CAAC,KAAY;QAC/B,KAAK,CAAC,cAAc,CAAC,eAAe,EAAE,CAAC;QACvC,KAAK,CAAC,KAAK,GAAG,QAAQ,CAAC;IACzB,CAAC;IAED;;;OAGG;IACa,0CAA0C,CAAC,KAAY;;YACrE,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,cAAc,CAAC,MAAM,EAAE;gBAC9C,MAAM,gBAAgB,GAAG,IAAA,yCAAwB,EAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;gBAC5E,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,IAAI,EAAE,wBAAgB,CAAC,OAAO,CAAC,CAAC;gBAC7G,MAAM,OAAO,GAAG,eAAe,KAAK,SAAS,IAAI,wBAAgB,CAAC,YAAY,CAAC,eAAe,CAAC,KAAK,IAAI,CAAC;gBACzG,IAAI,gBAAgB,IAAI,OAAO,EAAE;oBAC/B,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,iBAAiB,CAAC,gBAA0B,EAAE,IAAI,CAAC,CAAC;iBACvF;aACF;QACH,CAAC;KAAA;;AA9YH,oCA+YC;AA9YC;;;GAGG;AACoB,0CAA6B,GAAG,WAAW,CAAC"}

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

@@ -0,0 +1,210 @@
+import { AbstractScene, Color3, Material, TransformNode, Vector3, Viewer } from '../index';
+/**
+ * Parameters with a built in observer implementation
+ */
+export declare const BuiltInParameter: {
+    Visible: string;
+    Material: string;
+    Position: string;
+    Rotation: string;
+    Scaling: string;
+    Color: string;
+    Roughness: string;
+    Metallic: string;
+    Paintable: string;
+};
+export declare type ParameterName = string;
+export declare type ParameterValue = string | number | boolean;
+export declare type TagParameterSubject = {
+    tagName: string;
+    nodeName?: never;
+    materialName?: never;
+};
+export declare type NodeParameterSubject = {
+    tagName?: never;
+    nodeName: string;
+    materialName?: never;
+};
+export declare type MaterialParameterSubject = {
+    tagName?: never;
+    nodeName?: never;
+    materialName: string;
+};
+/**
+ * Defines which objects are affected by the parameter.\
+ * This can be single nodes and materials or tags, which can be used to apply a parameter to a group of nodes or
+ * materials.
+ */
+export declare type ParameterSubject = TagParameterSubject | NodeParameterSubject | MaterialParameterSubject;
+/**
+ * Bulk of targeted parameter values, mainly used as input for {@link ParameterManager.setParameterValues} function.\
+ * E.g.
+ * ```
+ * [
+ *  { nodeName: 'someMesh', parameterName: BuiltInParameter.Visible, value: false },
+ *  { materialName: 'someMaterial', parameterName: BuiltInParameter.Color, value: '#DD0060' }
+ * ]
+ * ```
+ * Each parameter value entry has to set exactly one of the subject keys (`nodeName`, `materialName` or `tagName`)
+ */
+export declare type ParameterValues = (ParameterSubject & {
+    parameterName: ParameterName;
+    value: ParameterValue;
+})[];
+/**
+ * Definition of callback function for parameter change
+ */
+export declare type ParameterObserver = (payload: ParameterObserverPayload) => Promise<void>;
+/**
+ * Payload of parameter observer.\
+ * Contains current data of parameter entry, which can be usefull for implementing the dedicated observer
+ */
+export declare type ParameterObserverPayload = {
+    subject: ParameterSubject;
+    nodes: TransformNode[];
+    materials: Material[];
+    newValue: ParameterValue;
+    oldValue: ParameterValue | undefined;
+};
+declare type ParameterEntry = {
+    subject: ParameterSubject;
+    parameterName: ParameterName;
+    value: ParameterValue;
+    oldValue: ParameterValue | undefined;
+};
+export declare class ParameterManager {
+    protected viewer: Viewer;
+    /**
+     * Parses and converts input to a boolean value, valid values are:
+     * - true / false
+     * - 1 / 0
+     */
+    static parseBoolean(value: ParameterValue): boolean;
+    /**
+     * Parses and converts input to a number value
+     */
+    static parseNumber(value: ParameterValue): number;
+    /**
+     * Parses and converts input to a string value
+     */
+    static parseString(value: ParameterValue): string;
+    /**
+     * Parses a string of format "(x,y,z)"" to a "Vector3".
+     */
+    static parseVector(value: ParameterValue): Vector3;
+    /**
+     * Parses a string of format `'(x,y,z)'` with angular degrees to a `Vector3` with rotation information in radians.
+     */
+    static parseRotation(value: ParameterValue): Vector3;
+    /**
+     * Parses a string of format `'#rrggbb'` or `'(r,g,b)'` to a `Color3`.
+     */
+    static parseColor(value: ParameterValue): Color3;
+    protected _parameterEntries: ParameterEntry[];
+    protected _parameterObserver: {
+        [parameterName: ParameterName]: ParameterObserver;
+    };
+    constructor(viewer: Viewer);
+    /**
+     * Set parameter value for a certain node and calls the corresponding observer if the value has changed
+     *
+     * @returns "true" if parameter value has changed
+     */
+    setNodeParameterValue(nodeName: string, parameterName: ParameterName, value: ParameterValue): Promise<boolean>;
+    /**
+     * Set parameter value for a certain material and calls the corresponding observer if the value has changed
+     *
+     * @returns "true" if parameter value has changed
+     */
+    setMaterialParameterValue(materialName: string, parameterName: ParameterName, value: ParameterValue): Promise<boolean>;
+    /**
+     * Set parameter value for a certain tag and calls the corresponding observer if the value has changed.\
+     * Setting a parameter value on a tag can affect multiple nodes and tags, depending which of these objects contains
+     * the desired tag.
+     *
+     * @returns "true" if parameter value has changed
+     */
+    setTagParameterValue(tagName: string, parameterName: ParameterName, value: ParameterValue): Promise<boolean>;
+    /**
+     * Set multiple parameter values simultaniously.\
+     * Tag parameters are applied before node and material parameters, node and materials are more specific and should
+     * have priority.
+     *
+     * @returns Array of parameters, which have changed values
+     */
+    setParameterValues(values: ParameterValues): Promise<ParameterValues>;
+    /**
+     * @returns desired parameter value or "undefined" if parameter entry is not available.
+     */
+    getParameterValue(subject: ParameterSubject, parameterName: ParameterName): ParameterValue | undefined;
+    /**
+     * Define observer callback for certain parameter.\
+     * There can only be one observer for a certain parameter name.\
+     * Parameter observers can not be overwritten once they are defined, this also includes system observers for
+     * {@link BuiltInParameter}.
+     */
+    setParameterObserver(parameterName: ParameterName, observer: ParameterObserver): void;
+    /**
+     * Print all parameter entries in table format into the console
+     */
+    printAllParameters(): void;
+    /**
+     * Applies all existing parameter entries to a certain "model", as defined in the {@link ModelManager}.\
+     * This can be usefull when updating the model before showing it in the scene.
+     *
+     * @internal
+     */
+    applyAllParameterValuesToModel(model: AbstractScene): Promise<void>;
+    /**
+     * Applies all parameter values which are targeting a material.\
+     * This can be usefull when updating a material definition before creating it.
+     *
+     * @internal
+     */
+    applyParameterValuesToMaterial(material: Material): Promise<void>;
+    /**
+     * @returns Desired parameter value of a certain node.
+     * Tags are considered as well but have lower priority than node parameters, as these are more specific.
+     *
+     * @internal
+     */
+    getParameterValueOfNode(node: TransformNode, parameterName: string): ParameterValue | undefined;
+    /**
+     * @returns Desired parameter value of a certain material.
+     * Tags are considered as well but have lower priority than material parameters, as these are more specific.
+     * Unused ATM, but added for consistency as counter part for {@link getParameterValueOfNode}
+     *
+     * @internal
+     */
+    getParameterValueOfMaterial(material: Material, parameterName: string): ParameterValue | undefined;
+    /**
+     * Parameter observer implementation of default parameters
+     */
+    protected _addBuiltInParameterObservers(): void;
+    /**
+     * Change parameter value in array of existing parameter entries or create a new entry
+     *
+     * @returns "true" if parameter has changed or wasn't available before
+     */
+    protected _addParameterValue(subject: ParameterSubject, parameterName: ParameterName, value: ParameterValue): boolean;
+    /**
+     * Call parameter observer of desired parameter which usually apply the new values to the scene.
+     *
+     * @param assetContainer Asset container in which to look for the paramter entries subjects (e.g. the nodes and
+     *                       materials to which the parameter values should be applied to).\
+     *                       Defaults to `viewer.scene`.
+     */
+    protected _applyParameterValues(parameterEntries: ParameterEntry[], assetContainer?: AbstractScene): Promise<void>;
+    /**
+     * Call parameter observer of desired parameter
+     *
+     * @param assetContainer Optionally add an "asset container", which actually represents a model in the
+     * {@link ModelManager}. Viewer scene is used if left empty.
+     */
+    protected _applyParameterValue(subject: ParameterSubject, parameterName: ParameterName, assetContainer?: AbstractScene): Promise<void>;
+    protected _getAffectedMaterials(subject: ParameterSubject, assetContainer?: AbstractScene): Material[];
+    protected _getAffectedNodes(subject: ParameterSubject, assetContainer?: AbstractScene): TransformNode[];
+    protected _getEntry(subject: ParameterSubject, parameterName: ParameterName): ParameterEntry | undefined;
+    protected _getEntriesOfSubject(subject: ParameterSubject): ParameterEntry[];
+}
+export {};