@combeenation/3d-viewer 12.4.1 → 12.4.3

package/dist/lib-cjs/api/classes/parameter.js

@@ -1,643 +1,643 @@
-"use strict";
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Parameter = void 0;
-const viewerError_1 = require("./viewerError");
-const math_color_1 = require("@babylonjs/core/Maths/math.color");
-const math_vector_1 = require("@babylonjs/core/Maths/math.vector");
-const lodash_es_1 = require("lodash-es");
-/**
- * This `Parameter` class defines all parameters that can be consumed and committed by a {@link ParameterObservable}.
- * Use {@link ParameterObservable.addParameterObserver} or {@link ParameterObservable.commitParameters} to either add or
- * commit parameters on your observable objects.
- */
-class Parameter {
-    /**
-     * Constructor.
-     */
-    constructor() { }
-    /**
-     * The {@link ParameterDeclarations} for all parameters in this class.
-     */
-    static get declarations() {
-        return {
-            [Parameter.VISIBLE]: { type: 'boolean', parser: Parameter.parseBoolean },
-            [Parameter.SCALING]: { type: 'number', parser: Parameter.parseNumber },
-            [Parameter.POSITION]: { type: 'vector', parser: Parameter.parseVector },
-            [Parameter.ROTATION]: { type: 'vector', parser: Parameter.parseVector },
-            [Parameter.HIGHLIGHTED]: { type: 'boolean', parser: Parameter.parseBoolean },
-            [Parameter.MATERIAL]: { type: 'string' },
-            [Parameter.MATERIAL_COLOR]: { type: 'color', parser: Parameter.parseColor },
-            [Parameter.MATERIAL_METALLNESS]: { type: 'number', parser: Parameter.parseNumber },
-            [Parameter.MATERIAL_ROUGHNESS]: { type: 'number', parser: Parameter.parseNumber },
-            [Parameter.HIGHLIGHT_ENABLED]: { type: 'boolean', parser: Parameter.parseBoolean },
-            [Parameter.HIGHLIGHT_COLOR]: { type: 'color', parser: Parameter.parseColor },
-            [Parameter.COLOR]: { type: 'color', parser: Parameter.parseColor },
-            [Parameter.METALLIC]: { type: 'number', parser: Parameter.parseNumber },
-            [Parameter.ROUGHNESS]: { type: 'number', parser: Parameter.parseNumber },
-            [Parameter.PAINTABLE]: { type: 'paintable', parser: Parameter.parsePaintable },
-            [Parameter.HIGHLIGHTED]: { type: 'boolean', parser: Parameter.parseBoolean },
-            [Parameter.CAST_SHADOW]: { type: 'boolean', parser: Parameter.parseBoolean },
-            [Parameter.CAST_SHADOW_FROM_LIGHTS]: { type: 'csl', parser: Parameter.parseCommaSeparatedList },
-            [Parameter.RECEIVE_SHADOWS]: { type: 'boolean', parser: Parameter.parseBoolean },
-            [Parameter.INTENSITY]: { type: 'number', parser: Parameter.parseNumber },
-            [Parameter.DIRECTION]: { type: 'vector', parser: Parameter.parseVector },
-            [Parameter.ANGLE]: { type: 'number', parser: Parameter.parseNumber },
-            [Parameter.EXPONENT]: { type: 'number', parser: Parameter.parseNumber },
-            [Parameter.DIFFUSE]: { type: 'color', parser: Parameter.parseColor },
-            [Parameter.SPECULAR]: { type: 'color', parser: Parameter.parseColor },
-            [Parameter.ENVIRONMENT]: { type: 'string' },
-            [Parameter.ENVIRONMENT_COLOR]: { type: 'color', parser: Parameter.parseColor },
-            [Parameter.ENVIRONMENT_ROTATION]: { type: 'number', parser: Parameter.parseNumber },
-            [Parameter.ENVIRONMENT_INTENSITY]: { type: 'number', parser: Parameter.parseNumber },
-            [Parameter.ENVIRONMENT_BACKGROUND]: { type: 'string' },
-            [Parameter.ENVIRONMENT_USEDEFAULT]: { type: 'boolean', parser: Parameter.parseBoolean },
-        };
-    }
-    /**
-     * The default {@link ParameterValue}s returned as {@link ParameterBag} for a set of parameters in this class.
-     */
-    static get defaultValues() {
-        return {
-            [Parameter.SCALING]: '(1, 1, 1)',
-            [Parameter.POSITION]: '(0, 0, 0)',
-            [Parameter.ROTATION]: '(0, 0, 0)',
-        };
-    }
-    /**
-     * Gets the default {@link ParameterValue} for a given {@link Parameter} declared in this class.
-     */
-    static getDefaultValue(parameter) {
-        return Parameter.defaultValues[parameter];
-    }
-    /**
-     * All parameters defined in this class.
-     */
-    static get all() {
-        const all = [];
-        for (const parameter in Parameter) {
-            const property = Object.getOwnPropertyDescriptor(Parameter, parameter);
-            if (parameter.toUpperCase() === parameter && property && (0, lodash_es_1.isString)(property.value)) {
-                all.push(property.value);
-            }
-        }
-        return all;
-    }
-    /**
-     * Asserts whether given parameter is declared and valid.
-     */
-    static assertParameter(parameterDeclaration, parameter, value) {
-        if (!(parameter in parameterDeclaration)) {
-            // This is a valid case since we are not able to check parameters that are not declared.
-            // We just ignore parameters that are not declared.
-            return;
-        }
-        const declaration = parameterDeclaration[parameter];
-        const errorPrefix = `Invalid value for parameter "${parameter}" of type "${declaration.type}" given:`;
-        if (declaration.parser) {
-            try {
-                declaration.parser(value);
-            }
-            catch (e) {
-                throw new viewerError_1.ViewerError({
-                    id: viewerError_1.ViewerErrorIds.InvalidParameterValue,
-                    message: `${errorPrefix}\n${e.message}.\nGiven value: ${value}`,
-                });
-            }
-        }
-        switch (declaration.type) {
-            case 'select':
-                if (!declaration.options) {
-                    throw new viewerError_1.ViewerError({
-                        id: viewerError_1.ViewerErrorIds.UnknownParameterOption,
-                        message: `No options defined for parameter declaration "${parameter}" of type "${declaration.type}".`,
-                    });
-                }
-                if (declaration.options.indexOf(value) === -1) {
-                    throw Error(`${errorPrefix}\nValid values are: "${declaration.options.join('", "')}".\nGiven value: ${value}`);
-                }
-                break;
-        }
-    }
-    /**
-     * Parses given {@link ParameterBag} with given {@link ParameterDeclarations}.
-     */
-    static parseFromDeclarations(declarations, parameterBag) {
-        const parameters = {};
-        for (const parameter in parameterBag) {
-            const value = (0, lodash_es_1.get)(parameterBag, parameter);
-            parameters[parameter] = value;
-            const declaration = declarations[parameter];
-            if (declaration) {
-                if (!(0, lodash_es_1.isEmpty)(value) && declaration.parser) {
-                    parameters[parameter] = declaration.parser(value);
-                }
-            }
-        }
-        return parameters;
-    }
-    /**
-     * Parses a string of format `'(x,y,z)'` to a `Vector3`.
-     */
-    static parseVector(value) {
-        if (!(0, lodash_es_1.isString)(value)) {
-            throw new Error(`Unable to convert "${value}" into a Vector: not a string.`);
-        }
-        let cleanedValue = value.split(' ').join('');
-        if (cleanedValue.startsWith('(') && cleanedValue.endsWith(')')) {
-            cleanedValue = cleanedValue.substring(1, cleanedValue.length - 1);
-            const [x, y, z] = cleanedValue.split(',').map(value => parseFloat(value));
-            return new math_vector_1.Vector3(x, y, z);
-        }
-        else {
-            throw new Error(`Unable to parse "${value}" to a Vector: expected "(x,y,z)".`);
-        }
-    }
-    /**
-     * Stringifies a Vector3 to format `(x,y,z)`.
-     */
-    static stringifyVector(value) {
-        return `(${value.x},${value.y},${value.z})`;
-    }
-    /**
-     * Parses a string of format `'(x,y,z)'` with angular degrees to a `Vector3` with rotation information in radians.
-     */
-    static parseRotation(value) {
-        const rotation = Parameter.parseVector(value);
-        const deg2rad = function (deg) {
-            return (deg * Math.PI) / 180;
-        };
-        return rotation.set(deg2rad(rotation.x), deg2rad(rotation.y), deg2rad(rotation.z));
-    }
-    /**
-     * Parses a string of format `'(x,y,z)'` or a simple `number` to a `Vector3` for scaling.
-     */
-    static parseScaling(value) {
-        let scaling = new math_vector_1.Vector3();
-        if ((0, lodash_es_1.isString)(value)) {
-            const cleanedFactor = value.split(' ').join('');
-            if (cleanedFactor.startsWith('(') && cleanedFactor.endsWith(')')) {
-                scaling = Parameter.parseVector(cleanedFactor);
-            }
-            else {
-                const _factor = parseFloat(value);
-                scaling = new math_vector_1.Vector3(_factor, _factor, _factor);
-            }
-        }
-        else if ((0, lodash_es_1.isNumber)(value)) {
-            scaling = new math_vector_1.Vector3(value, value, value);
-        }
-        else {
-            throw new Error(`Unable to convert "${value}" to a Vector: expected "(x,y,z)".`);
-        }
-        return scaling;
-    }
-    /**
-     * Parses a string of format `'#rrggbb'` or `'(r,g,b)'` to a `Color3`.
-     */
-    static parseColor(value) {
-        const cleanedValue = value.toString().split(' ').join('');
-        if (cleanedValue.startsWith('#')) {
-            return math_color_1.Color3.FromHexString(value.toString());
-        }
-        if (cleanedValue.startsWith('(') && cleanedValue.endsWith(')')) {
-            const rgb = cleanedValue.substring(1, cleanedValue.length - 1);
-            const [r, g, b] = rgb.split(',').map(value => parseFloat(value));
-            return math_color_1.Color3.FromInts(r, g, b);
-        }
-        const humanReadable = (0, lodash_es_1.capitalize)(cleanedValue);
-        // disable lint for this rule as there is no smoother option for checking static class functions (eg Color.Red())
-        // eslint-disable-next-line no-prototype-builtins
-        if (math_color_1.Color3.hasOwnProperty(humanReadable)) {
-            // @ts-ignore same as above
-            return math_color_1.Color3[humanReadable]();
-        }
-        throw new Error(`Unable to parse "${value}" to a Color: expected "#rrggbb", "(r,g,b)" or any human readable property implemented in Color3.`);
-    }
-    /**
-     * Parses a `boolean` string (`'true'`/`'1'` or `'false'`/`'0'`) or `number` (`1` or `0`) to a `boolean` or
-     * `undefined`.
-     */
-    static parseBoolean(value) {
-        if (value.toString() === 'true' || value.toString() === '1') {
-            return true;
-        }
-        else if (value.toString() === 'false' || value.toString() === '0') {
-            return false;
-        }
-        throw new Error(`Unable to parse "${value}" to a boolean.`);
-    }
-    /**
-     * Parses a number `string` to a `number`.
-     */
-    static parseNumber(value) {
-        return parseFloat(value.toString());
-    }
-    /**
-     * Parses string defintion of a paintable into a paintable object.\
-     * Here are some examples:
-     * ```ts
-     * // Default definition as JSON object:
-     * '{ "src": "https://path.to/image.jpg", "uScale": 0.5 }'
-     *
-     * // Short hand definition, only contains source string:
-     * 'https://path.to/image.jpg'
-     *
-     * // Full content, paintable texture is flipped in both directions
-     * '{ "src": "https://path.to/image.jpg", "uScale": -1, "vScale": -1, "uOffset": 0, "vOffset": 0 }'
-     *
-     * // SVG content can be used directly:
-     * '<svg>...</svg>'
-     *
-     * // SVG in src property works as well:
-     * '{ "src": "<svg>...</svg>", "uScale": 0.5 }'
-     * ```
-     */
-    static parsePaintable(value) {
-        if (!(0, lodash_es_1.isString)(value)) {
-            throw new Error(`Not a string.`);
-        }
-        const paintableValue = { src: '' };
-        let valObj = null;
-        try {
-            valObj = JSON.parse(value);
-        }
-        catch (_a) {
-            // use string directly
-            paintableValue.src = value;
-            if (value.startsWith('{')) {
-                // seems like the user tried to use a JSON string, as the input starts with {
-                throw new Error(`Not a valid JSON string.`);
-            }
-        }
-        if (valObj) {
-            // input string is JSON, src attribute is required
-            if (!valObj.src) {
-                throw new Error(`Property "src" is missing.`);
-            }
-            if (!(0, lodash_es_1.isString)(valObj.src)) {
-                throw new Error(`Property "src" is not a string.`);
-            }
-            // split src and options
-            const { src } = valObj, options = __rest(valObj, ["src"]);
-            paintableValue.src = src;
-            // only forward valid paintable options
-            const validOptionKeys = ['uScale', 'vScale', 'uOffset', 'vOffset'];
-            const { validOptions, invalidKeys } = Object.entries(options).reduce((accRes, [curKey, curValue]) => {
-                const isValidKey = validOptionKeys.includes(curKey);
-                if (isValidKey) {
-                    accRes.validOptions[curKey] = curValue;
-                }
-                else {
-                    accRes.invalidKeys.push(curKey);
-                }
-                return accRes;
-            }, { validOptions: {}, invalidKeys: [] });
-            if (invalidKeys.length) {
-                console.warn('parsePaintable: invalid paintable options provided: ' + invalidKeys.toString());
-            }
-            paintableValue.options = validOptions;
-        }
-        return paintableValue;
-    }
-    /**
-     * Parses a string with comma separated values to a list of strings.
-     */
-    static parseCommaSeparatedList(value) {
-        return value
-            .toString()
-            .split(',')
-            .map(s => s.trim());
-    }
-}
-exports.Parameter = Parameter;
-/**
- * Mutates the visibility. Helper methods are {@link VariantParameterizable.show} and
- * {@link VariantParameterizable.hide}. Getter and setter is {@link VariantParameterizable.visible}.
- *
- * Scopes:
- * * {@link Element}
- * * {@link Variant}
- * * {@link ViewerLight} Available for all light types
- *
- * @parser {@link parseBoolean}
- */
-Parameter.VISIBLE = 'visible';
-/**
- * Stretches or compresses some meshes. Getter and setter is {@link VariantParameterizable.scaling}.
- *
- * Scopes:
- * * {@link Element}
- * * {@link Variant}
- *
- * @parser {@link parseScaling}
- */
-Parameter.SCALING = 'scaling';
-/**
- * Mutates the material. Getter and setter is {@link VariantParameterizable.material}. The value of this parameter
- * represents the ID of a baked-in glTF or custom created material in the {@link Variant} tree.
- *
- * Scopes:
- * * {@link Element}
- * * {@link Variant}
- *
- * @parser string
- */
-Parameter.MATERIAL = 'material';
-/**
- * Mutates the material color.
- *
- * Scopes:
- * * {@link Element}
- * * {@link Variant}
- *
- * @parser {@link parseColor}
- */
-Parameter.MATERIAL_COLOR = 'material.color';
-/**
- * Mutates the material metallness.
- *
- * Scopes:
- * * {@link Element}
- * * {@link Variant}
- *
- * @parser {@link parseNumber}
- */
-Parameter.MATERIAL_METALLNESS = 'material.metallness';
-/**
- * Mutates the material roughness.
- *
- * Scopes:
- * * {@link Element}
- * * {@link Variant}
- *
- * @parser {@link parseNumber}
- */
-Parameter.MATERIAL_ROUGHNESS = 'material.roughness';
-/**
- * Mutates whether a highlight layer should be enabled.
- *
- * Scopes:
- * * {@link Element}
- * * {@link Variant}
- *
- * @parser {@link parseBoolean}
- */
-Parameter.HIGHLIGHT_ENABLED = 'highlight.enabled';
-/**
- * Changes the highlight color.
- *
- * Scopes:
- * * {@link Element}
- * * {@link Variant}
- *
- * @parser {@link parseColor}
- */
-Parameter.HIGHLIGHT_COLOR = 'highlight.color';
-/**
- * Mutates the highlighted state. Getter and setter is {@link VariantParameterizable.highlighted}.
- *
- * Scopes:
- * * {@link Element}
- * * {@link Variant}
- *
- * @parser {@link parseBoolean}
- */
-Parameter.HIGHLIGHTED = 'highlighted';
-/**
- * Mutates the position relative to its origin position. Getter and setter is {@link VariantParameterizable.position}.
- *
- * Scopes:
- * * {@link Element}
- * * {@link Variant}
- * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#position), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#position), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#position)
- *
- * @parser {@link parseVector}
- */
-Parameter.POSITION = 'position';
-/**
- * Mutates the rotation relative to its origin rotation. Getter and setter is {@link VariantParameterizable.rotation}.
- *
- * Scopes:
- * * {@link Element}
- * * {@link Variant}
- *
- * @parser {@link parseRotation}
- */
-Parameter.ROTATION = 'rotation';
-/**
- * Mutates the color.
- *
- * Scopes:
- * * {@link Material} via {@link TagManager}
- *
- * @parser {@link parseColor}
- */
-Parameter.COLOR = 'color';
-/**
- * Mutates the metallic.
- *
- * Scopes:
- * * {@link Material} via {@link TagManager}
- *
- * @parser {@link parseNumber}
- */
-Parameter.METALLIC = 'metallic';
-/**
- * Paintables can be used to let the client/browser draw graphics on a 3d model by mutating the texture of a
- * material.\
- * For detailed information have a look at the [paintables](./../pages/documentation/Paintables.html) page.
- *
- * Also see {@link parsePaintable} for detailed information on which values you can pass to the `paintable`
- * parameter.
- *
- * Scopes:
- * * {@link Material} via {@link TagManager}
- *
- * @parser {@link parsePaintable}
- *
- */
-Parameter.PAINTABLE = 'paintable';
-/**
- * Mutates the roughness.
- *
- * Scopes:
- * * {@link Material} via {@link TagManager}
- *
- * @parser {@link parseNumber}
- */
-Parameter.ROUGHNESS = 'roughness';
-/**
- * Mutates whether a shadow should be casted or not.
- *
- * Scopes:
- * * {@link Element}
- * * {@link Variant}
- *
- * @parser {@link parseBoolean}
- */
-Parameter.CAST_SHADOW = 'castShadow';
-/**
- * Mutates from which lights a shadow should be casted.
- *
- * Scopes:
- * * {@link Element}
- * * {@link Variant}
- *
- * @parser {@link parseCommaSeparatedList}
- */
-Parameter.CAST_SHADOW_FROM_LIGHTS = 'castShadow.fromLights';
-/**
- * Mutates whether to receive shadows or not.
- *
- * Scopes:
- * * {@link Element}
- * * {@link Variant}
- *
- * @parser {@link parseBoolean}
- */
-Parameter.RECEIVE_SHADOWS = 'receiveShadows';
-/**
- * Mutates the intensity of Lights.
- *
- * Scopes:
- * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#intensity), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#intensity), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#intensity), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#intensity)
- *
- * @parser {@link parseNumber}
- */
-Parameter.INTENSITY = 'intensity';
-/**
- * Mutates the direction of Lights.
- *
- * Scopes:
- * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#direction), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#direction), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#direction), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#direction)
- *
- * @parser {@link parseNumber}
- */
-Parameter.DIRECTION = 'direction';
-/**
- * Mutates the angle of Lights.
- *
- * Scopes:
- * * {@link ViewerLight} Available for [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#angle)
- *
- * @parser {@link parseNumber}
- */
-Parameter.ANGLE = 'angle';
-/**
- * Mutates the exponent of Lights.
- *
- * Scopes:
- * * {@link ViewerLight} Available for [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#exponent)
- *
- * @parser {@link parseNumber}
- */
-Parameter.EXPONENT = 'exponent';
-/**
- * Mutates the diffuse color of Lights.
- *
- * Scopes:
- * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#diffuse), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#diffuse), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#diffuse), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#diffuse)
- *
- * @parser {@link parseNumber}
- */
-Parameter.DIFFUSE = 'diffuse';
-/**
- * Mutates the specular color of Lights.
- *
- * Scopes:
- * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#specular), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#specular), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#specular), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#specular)
- *
- * @parser {@link parseNumber}
- */
-Parameter.SPECULAR = 'specular';
-/**
- * Sets the environment. See [BABYLON.Scene.environmentTexture](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#environmentTexture).
- *
- * Usually the URL to an `*.env` file.
- *
- * See [environment page](./../pages/documentation/Environment.html) for details on how to use this.
- *
- * Scopes:
- * * {@link SceneManager}
- *
- * @parser string
- */
-Parameter.ENVIRONMENT = 'environment';
-/**
- * Sets [BABYLON.Scene.clearColor](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#clearColor)
- *
- * See [environment page](./../pages/documentation/Environment.html) for details on how to use this.
- *
- * Scopes:
- * * {@link SceneManager}
- *
- * @parser {@link parseColor}
- */
-Parameter.ENVIRONMENT_COLOR = 'environment.color';
-/**
- * Rotates connected textures, i.e. IBL, reflection, background, ...
- * Rotation angle in degree.
- *
- * See [environment page](./../pages/documentation/Environment.html) for details on how to use this.
- *
- * Scopes:
- * * {@link SceneManager}
- *
- * @parser {@link parseNumber}
- */
-Parameter.ENVIRONMENT_ROTATION = 'environment.rotation';
-/**
- * Intensity of IBL. Defaults to 1, usually between 0 & 2.
- *
- * See [environment page](./../pages/documentation/Environment.html) for details on how to use this.
- *
- * Scopes:
- * * {@link SceneManager}
- *
- * @parser {@link parseNumber}
- */
-Parameter.ENVIRONMENT_INTENSITY = 'environment.intensity';
-/**
- * Background texture on a [PhotoDome](https://doc.babylonjs.com/divingDeeper/environment/360PhotoDome).
- * Just background, no IBL or reflection.
- *
- * Recommended format is `*.jpg`. HDR files are not supported as background but can be converted to `*.jpg` using
- * tools like Photoshop, Gimp or various free online converters.
- *
- * See [environment page](./../pages/documentation/Environment.html) for details on how to use this.
- *
- * Scopes:
- * * {@link SceneManager}
- *
- * @parser string
- */
-Parameter.ENVIRONMENT_BACKGROUND = 'environment.background';
-/**
- * If `true`, sets a `scene.environmentTexture` and creates a *BackgroundHelper* Node (via
- * [scene.createDefaultEnvironment](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#createDefaultEnvironment))
- * with two subnodes/meshes:
- * - BackgroundPlane
- * - BackgroundSkybox
- *
- * The value of this parameter is ignored if {@link ENVIRONMENT_BACKGROUND} is also set.
- *
- * See [environment page](./../pages/documentation/Environment.html) for details on how to use this.
- *
- * Scopes:
- * * {@link SceneManager}
- *
- * @parser {@link parseBoolean}
- */
-Parameter.ENVIRONMENT_USEDEFAULT = 'environment.usedefault';
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Parameter = void 0;
+const viewerError_1 = require("./viewerError");
+const math_color_1 = require("@babylonjs/core/Maths/math.color");
+const math_vector_1 = require("@babylonjs/core/Maths/math.vector");
+const lodash_es_1 = require("lodash-es");
+/**
+ * This `Parameter` class defines all parameters that can be consumed and committed by a {@link ParameterObservable}.
+ * Use {@link ParameterObservable.addParameterObserver} or {@link ParameterObservable.commitParameters} to either add or
+ * commit parameters on your observable objects.
+ */
+class Parameter {
+    /**
+     * Constructor.
+     */
+    constructor() { }
+    /**
+     * The {@link ParameterDeclarations} for all parameters in this class.
+     */
+    static get declarations() {
+        return {
+            [Parameter.VISIBLE]: { type: 'boolean', parser: Parameter.parseBoolean },
+            [Parameter.SCALING]: { type: 'number', parser: Parameter.parseNumber },
+            [Parameter.POSITION]: { type: 'vector', parser: Parameter.parseVector },
+            [Parameter.ROTATION]: { type: 'vector', parser: Parameter.parseVector },
+            [Parameter.HIGHLIGHTED]: { type: 'boolean', parser: Parameter.parseBoolean },
+            [Parameter.MATERIAL]: { type: 'string' },
+            [Parameter.MATERIAL_COLOR]: { type: 'color', parser: Parameter.parseColor },
+            [Parameter.MATERIAL_METALLNESS]: { type: 'number', parser: Parameter.parseNumber },
+            [Parameter.MATERIAL_ROUGHNESS]: { type: 'number', parser: Parameter.parseNumber },
+            [Parameter.HIGHLIGHT_ENABLED]: { type: 'boolean', parser: Parameter.parseBoolean },
+            [Parameter.HIGHLIGHT_COLOR]: { type: 'color', parser: Parameter.parseColor },
+            [Parameter.COLOR]: { type: 'color', parser: Parameter.parseColor },
+            [Parameter.METALLIC]: { type: 'number', parser: Parameter.parseNumber },
+            [Parameter.ROUGHNESS]: { type: 'number', parser: Parameter.parseNumber },
+            [Parameter.PAINTABLE]: { type: 'paintable', parser: Parameter.parsePaintable },
+            [Parameter.HIGHLIGHTED]: { type: 'boolean', parser: Parameter.parseBoolean },
+            [Parameter.CAST_SHADOW]: { type: 'boolean', parser: Parameter.parseBoolean },
+            [Parameter.CAST_SHADOW_FROM_LIGHTS]: { type: 'csl', parser: Parameter.parseCommaSeparatedList },
+            [Parameter.RECEIVE_SHADOWS]: { type: 'boolean', parser: Parameter.parseBoolean },
+            [Parameter.INTENSITY]: { type: 'number', parser: Parameter.parseNumber },
+            [Parameter.DIRECTION]: { type: 'vector', parser: Parameter.parseVector },
+            [Parameter.ANGLE]: { type: 'number', parser: Parameter.parseNumber },
+            [Parameter.EXPONENT]: { type: 'number', parser: Parameter.parseNumber },
+            [Parameter.DIFFUSE]: { type: 'color', parser: Parameter.parseColor },
+            [Parameter.SPECULAR]: { type: 'color', parser: Parameter.parseColor },
+            [Parameter.ENVIRONMENT]: { type: 'string' },
+            [Parameter.ENVIRONMENT_COLOR]: { type: 'color', parser: Parameter.parseColor },
+            [Parameter.ENVIRONMENT_ROTATION]: { type: 'number', parser: Parameter.parseNumber },
+            [Parameter.ENVIRONMENT_INTENSITY]: { type: 'number', parser: Parameter.parseNumber },
+            [Parameter.ENVIRONMENT_BACKGROUND]: { type: 'string' },
+            [Parameter.ENVIRONMENT_USEDEFAULT]: { type: 'boolean', parser: Parameter.parseBoolean },
+        };
+    }
+    /**
+     * The default {@link ParameterValue}s returned as {@link ParameterBag} for a set of parameters in this class.
+     */
+    static get defaultValues() {
+        return {
+            [Parameter.SCALING]: '(1, 1, 1)',
+            [Parameter.POSITION]: '(0, 0, 0)',
+            [Parameter.ROTATION]: '(0, 0, 0)',
+        };
+    }
+    /**
+     * Gets the default {@link ParameterValue} for a given {@link Parameter} declared in this class.
+     */
+    static getDefaultValue(parameter) {
+        return Parameter.defaultValues[parameter];
+    }
+    /**
+     * All parameters defined in this class.
+     */
+    static get all() {
+        const all = [];
+        for (const parameter in Parameter) {
+            const property = Object.getOwnPropertyDescriptor(Parameter, parameter);
+            if (parameter.toUpperCase() === parameter && property && (0, lodash_es_1.isString)(property.value)) {
+                all.push(property.value);
+            }
+        }
+        return all;
+    }
+    /**
+     * Asserts whether given parameter is declared and valid.
+     */
+    static assertParameter(parameterDeclaration, parameter, value) {
+        if (!(parameter in parameterDeclaration)) {
+            // This is a valid case since we are not able to check parameters that are not declared.
+            // We just ignore parameters that are not declared.
+            return;
+        }
+        const declaration = parameterDeclaration[parameter];
+        const errorPrefix = `Invalid value for parameter "${parameter}" of type "${declaration.type}" given:`;
+        if (declaration.parser) {
+            try {
+                declaration.parser(value);
+            }
+            catch (e) {
+                throw new viewerError_1.ViewerError({
+                    id: viewerError_1.ViewerErrorIds.InvalidParameterValue,
+                    message: `${errorPrefix}\n${e.message}.\nGiven value: ${value}`,
+                });
+            }
+        }
+        switch (declaration.type) {
+            case 'select':
+                if (!declaration.options) {
+                    throw new viewerError_1.ViewerError({
+                        id: viewerError_1.ViewerErrorIds.UnknownParameterOption,
+                        message: `No options defined for parameter declaration "${parameter}" of type "${declaration.type}".`,
+                    });
+                }
+                if (declaration.options.indexOf(value) === -1) {
+                    throw Error(`${errorPrefix}\nValid values are: "${declaration.options.join('", "')}".\nGiven value: ${value}`);
+                }
+                break;
+        }
+    }
+    /**
+     * Parses given {@link ParameterBag} with given {@link ParameterDeclarations}.
+     */
+    static parseFromDeclarations(declarations, parameterBag) {
+        const parameters = {};
+        for (const parameter in parameterBag) {
+            const value = (0, lodash_es_1.get)(parameterBag, parameter);
+            parameters[parameter] = value;
+            const declaration = declarations[parameter];
+            if (declaration) {
+                if (!(0, lodash_es_1.isEmpty)(value) && declaration.parser) {
+                    parameters[parameter] = declaration.parser(value);
+                }
+            }
+        }
+        return parameters;
+    }
+    /**
+     * Parses a string of format `'(x,y,z)'` to a `Vector3`.
+     */
+    static parseVector(value) {
+        if (!(0, lodash_es_1.isString)(value)) {
+            throw new Error(`Unable to convert "${value}" into a Vector: not a string.`);
+        }
+        let cleanedValue = value.split(' ').join('');
+        if (cleanedValue.startsWith('(') && cleanedValue.endsWith(')')) {
+            cleanedValue = cleanedValue.substring(1, cleanedValue.length - 1);
+            const [x, y, z] = cleanedValue.split(',').map(value => parseFloat(value));
+            return new math_vector_1.Vector3(x, y, z);
+        }
+        else {
+            throw new Error(`Unable to parse "${value}" to a Vector: expected "(x,y,z)".`);
+        }
+    }
+    /**
+     * Stringifies a Vector3 to format `(x,y,z)`.
+     */
+    static stringifyVector(value) {
+        return `(${value.x},${value.y},${value.z})`;
+    }
+    /**
+     * Parses a string of format `'(x,y,z)'` with angular degrees to a `Vector3` with rotation information in radians.
+     */
+    static parseRotation(value) {
+        const rotation = Parameter.parseVector(value);
+        const deg2rad = function (deg) {
+            return (deg * Math.PI) / 180;
+        };
+        return rotation.set(deg2rad(rotation.x), deg2rad(rotation.y), deg2rad(rotation.z));
+    }
+    /**
+     * Parses a string of format `'(x,y,z)'` or a simple `number` to a `Vector3` for scaling.
+     */
+    static parseScaling(value) {
+        let scaling = new math_vector_1.Vector3();
+        if ((0, lodash_es_1.isString)(value)) {
+            const cleanedFactor = value.split(' ').join('');
+            if (cleanedFactor.startsWith('(') && cleanedFactor.endsWith(')')) {
+                scaling = Parameter.parseVector(cleanedFactor);
+            }
+            else {
+                const _factor = parseFloat(value);
+                scaling = new math_vector_1.Vector3(_factor, _factor, _factor);
+            }
+        }
+        else if ((0, lodash_es_1.isNumber)(value)) {
+            scaling = new math_vector_1.Vector3(value, value, value);
+        }
+        else {
+            throw new Error(`Unable to convert "${value}" to a Vector: expected "(x,y,z)".`);
+        }
+        return scaling;
+    }
+    /**
+     * Parses a string of format `'#rrggbb'` or `'(r,g,b)'` to a `Color3`.
+     */
+    static parseColor(value) {
+        const cleanedValue = value.toString().split(' ').join('');
+        if (cleanedValue.startsWith('#')) {
+            return math_color_1.Color3.FromHexString(value.toString());
+        }
+        if (cleanedValue.startsWith('(') && cleanedValue.endsWith(')')) {
+            const rgb = cleanedValue.substring(1, cleanedValue.length - 1);
+            const [r, g, b] = rgb.split(',').map(value => parseFloat(value));
+            return math_color_1.Color3.FromInts(r, g, b);
+        }
+        const humanReadable = (0, lodash_es_1.capitalize)(cleanedValue);
+        // disable lint for this rule as there is no smoother option for checking static class functions (eg Color.Red())
+        // eslint-disable-next-line no-prototype-builtins
+        if (math_color_1.Color3.hasOwnProperty(humanReadable)) {
+            // @ts-ignore same as above
+            return math_color_1.Color3[humanReadable]();
+        }
+        throw new Error(`Unable to parse "${value}" to a Color: expected "#rrggbb", "(r,g,b)" or any human readable property implemented in Color3.`);
+    }
+    /**
+     * Parses a `boolean` string (`'true'`/`'1'` or `'false'`/`'0'`) or `number` (`1` or `0`) to a `boolean` or
+     * `undefined`.
+     */
+    static parseBoolean(value) {
+        if (value.toString() === 'true' || value.toString() === '1') {
+            return true;
+        }
+        else if (value.toString() === 'false' || value.toString() === '0') {
+            return false;
+        }
+        throw new Error(`Unable to parse "${value}" to a boolean.`);
+    }
+    /**
+     * Parses a number `string` to a `number`.
+     */
+    static parseNumber(value) {
+        return parseFloat(value.toString());
+    }
+    /**
+     * Parses string defintion of a paintable into a paintable object.\
+     * Here are some examples:
+     * ```ts
+     * // Default definition as JSON object:
+     * '{ "src": "https://path.to/image.jpg", "uScale": 0.5 }'
+     *
+     * // Short hand definition, only contains source string:
+     * 'https://path.to/image.jpg'
+     *
+     * // Full content, paintable texture is flipped in both directions
+     * '{ "src": "https://path.to/image.jpg", "uScale": -1, "vScale": -1, "uOffset": 0, "vOffset": 0 }'
+     *
+     * // SVG content can be used directly:
+     * '<svg>...</svg>'
+     *
+     * // SVG in src property works as well:
+     * '{ "src": "<svg>...</svg>", "uScale": 0.5 }'
+     * ```
+     */
+    static parsePaintable(value) {
+        if (!(0, lodash_es_1.isString)(value)) {
+            throw new Error(`Not a string.`);
+        }
+        const paintableValue = { src: '' };
+        let valObj = null;
+        try {
+            valObj = JSON.parse(value);
+        }
+        catch (_a) {
+            // use string directly
+            paintableValue.src = value;
+            if (value.startsWith('{')) {
+                // seems like the user tried to use a JSON string, as the input starts with {
+                throw new Error(`Not a valid JSON string.`);
+            }
+        }
+        if (valObj) {
+            // input string is JSON, src attribute is required
+            if (!valObj.src) {
+                throw new Error(`Property "src" is missing.`);
+            }
+            if (!(0, lodash_es_1.isString)(valObj.src)) {
+                throw new Error(`Property "src" is not a string.`);
+            }
+            // split src and options
+            const { src } = valObj, options = __rest(valObj, ["src"]);
+            paintableValue.src = src;
+            // only forward valid paintable options
+            const validOptionKeys = ['uScale', 'vScale', 'uOffset', 'vOffset'];
+            const { validOptions, invalidKeys } = Object.entries(options).reduce((accRes, [curKey, curValue]) => {
+                const isValidKey = validOptionKeys.includes(curKey);
+                if (isValidKey) {
+                    accRes.validOptions[curKey] = curValue;
+                }
+                else {
+                    accRes.invalidKeys.push(curKey);
+                }
+                return accRes;
+            }, { validOptions: {}, invalidKeys: [] });
+            if (invalidKeys.length) {
+                console.warn('parsePaintable: invalid paintable options provided: ' + invalidKeys.toString());
+            }
+            paintableValue.options = validOptions;
+        }
+        return paintableValue;
+    }
+    /**
+     * Parses a string with comma separated values to a list of strings.
+     */
+    static parseCommaSeparatedList(value) {
+        return value
+            .toString()
+            .split(',')
+            .map(s => s.trim());
+    }
+}
+exports.Parameter = Parameter;
+/**
+ * Mutates the visibility. Helper methods are {@link VariantParameterizable.show} and
+ * {@link VariantParameterizable.hide}. Getter and setter is {@link VariantParameterizable.visible}.
+ *
+ * Scopes:
+ * * {@link Element}
+ * * {@link Variant}
+ * * {@link ViewerLight} Available for all light types
+ *
+ * @parser {@link parseBoolean}
+ */
+Parameter.VISIBLE = 'visible';
+/**
+ * Stretches or compresses some meshes. Getter and setter is {@link VariantParameterizable.scaling}.
+ *
+ * Scopes:
+ * * {@link Element}
+ * * {@link Variant}
+ *
+ * @parser {@link parseScaling}
+ */
+Parameter.SCALING = 'scaling';
+/**
+ * Mutates the material. Getter and setter is {@link VariantParameterizable.material}. The value of this parameter
+ * represents the ID of a baked-in glTF or custom created material in the {@link Variant} tree.
+ *
+ * Scopes:
+ * * {@link Element}
+ * * {@link Variant}
+ *
+ * @parser string
+ */
+Parameter.MATERIAL = 'material';
+/**
+ * Mutates the material color.
+ *
+ * Scopes:
+ * * {@link Element}
+ * * {@link Variant}
+ *
+ * @parser {@link parseColor}
+ */
+Parameter.MATERIAL_COLOR = 'material.color';
+/**
+ * Mutates the material metallness.
+ *
+ * Scopes:
+ * * {@link Element}
+ * * {@link Variant}
+ *
+ * @parser {@link parseNumber}
+ */
+Parameter.MATERIAL_METALLNESS = 'material.metallness';
+/**
+ * Mutates the material roughness.
+ *
+ * Scopes:
+ * * {@link Element}
+ * * {@link Variant}
+ *
+ * @parser {@link parseNumber}
+ */
+Parameter.MATERIAL_ROUGHNESS = 'material.roughness';
+/**
+ * Mutates whether a highlight layer should be enabled.
+ *
+ * Scopes:
+ * * {@link Element}
+ * * {@link Variant}
+ *
+ * @parser {@link parseBoolean}
+ */
+Parameter.HIGHLIGHT_ENABLED = 'highlight.enabled';
+/**
+ * Changes the highlight color.
+ *
+ * Scopes:
+ * * {@link Element}
+ * * {@link Variant}
+ *
+ * @parser {@link parseColor}
+ */
+Parameter.HIGHLIGHT_COLOR = 'highlight.color';
+/**
+ * Mutates the highlighted state. Getter and setter is {@link VariantParameterizable.highlighted}.
+ *
+ * Scopes:
+ * * {@link Element}
+ * * {@link Variant}
+ *
+ * @parser {@link parseBoolean}
+ */
+Parameter.HIGHLIGHTED = 'highlighted';
+/**
+ * Mutates the position relative to its origin position. Getter and setter is {@link VariantParameterizable.position}.
+ *
+ * Scopes:
+ * * {@link Element}
+ * * {@link Variant}
+ * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#position), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#position), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#position)
+ *
+ * @parser {@link parseVector}
+ */
+Parameter.POSITION = 'position';
+/**
+ * Mutates the rotation relative to its origin rotation. Getter and setter is {@link VariantParameterizable.rotation}.
+ *
+ * Scopes:
+ * * {@link Element}
+ * * {@link Variant}
+ *
+ * @parser {@link parseRotation}
+ */
+Parameter.ROTATION = 'rotation';
+/**
+ * Mutates the color.
+ *
+ * Scopes:
+ * * {@link Material} via {@link TagManager}
+ *
+ * @parser {@link parseColor}
+ */
+Parameter.COLOR = 'color';
+/**
+ * Mutates the metallic.
+ *
+ * Scopes:
+ * * {@link Material} via {@link TagManager}
+ *
+ * @parser {@link parseNumber}
+ */
+Parameter.METALLIC = 'metallic';
+/**
+ * Paintables can be used to let the client/browser draw graphics on a 3d model by mutating the texture of a
+ * material.\
+ * For detailed information have a look at the [paintables](./../pages/documentation/Paintables.html) page.
+ *
+ * Also see {@link parsePaintable} for detailed information on which values you can pass to the `paintable`
+ * parameter.
+ *
+ * Scopes:
+ * * {@link Material} via {@link TagManager}
+ *
+ * @parser {@link parsePaintable}
+ *
+ */
+Parameter.PAINTABLE = 'paintable';
+/**
+ * Mutates the roughness.
+ *
+ * Scopes:
+ * * {@link Material} via {@link TagManager}
+ *
+ * @parser {@link parseNumber}
+ */
+Parameter.ROUGHNESS = 'roughness';
+/**
+ * Mutates whether a shadow should be casted or not.
+ *
+ * Scopes:
+ * * {@link Element}
+ * * {@link Variant}
+ *
+ * @parser {@link parseBoolean}
+ */
+Parameter.CAST_SHADOW = 'castShadow';
+/**
+ * Mutates from which lights a shadow should be casted.
+ *
+ * Scopes:
+ * * {@link Element}
+ * * {@link Variant}
+ *
+ * @parser {@link parseCommaSeparatedList}
+ */
+Parameter.CAST_SHADOW_FROM_LIGHTS = 'castShadow.fromLights';
+/**
+ * Mutates whether to receive shadows or not.
+ *
+ * Scopes:
+ * * {@link Element}
+ * * {@link Variant}
+ *
+ * @parser {@link parseBoolean}
+ */
+Parameter.RECEIVE_SHADOWS = 'receiveShadows';
+/**
+ * Mutates the intensity of Lights.
+ *
+ * Scopes:
+ * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#intensity), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#intensity), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#intensity), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#intensity)
+ *
+ * @parser {@link parseNumber}
+ */
+Parameter.INTENSITY = 'intensity';
+/**
+ * Mutates the direction of Lights.
+ *
+ * Scopes:
+ * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#direction), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#direction), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#direction), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#direction)
+ *
+ * @parser {@link parseNumber}
+ */
+Parameter.DIRECTION = 'direction';
+/**
+ * Mutates the angle of Lights.
+ *
+ * Scopes:
+ * * {@link ViewerLight} Available for [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#angle)
+ *
+ * @parser {@link parseNumber}
+ */
+Parameter.ANGLE = 'angle';
+/**
+ * Mutates the exponent of Lights.
+ *
+ * Scopes:
+ * * {@link ViewerLight} Available for [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#exponent)
+ *
+ * @parser {@link parseNumber}
+ */
+Parameter.EXPONENT = 'exponent';
+/**
+ * Mutates the diffuse color of Lights.
+ *
+ * Scopes:
+ * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#diffuse), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#diffuse), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#diffuse), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#diffuse)
+ *
+ * @parser {@link parseNumber}
+ */
+Parameter.DIFFUSE = 'diffuse';
+/**
+ * Mutates the specular color of Lights.
+ *
+ * Scopes:
+ * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#specular), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#specular), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#specular), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#specular)
+ *
+ * @parser {@link parseNumber}
+ */
+Parameter.SPECULAR = 'specular';
+/**
+ * Sets the environment. See [BABYLON.Scene.environmentTexture](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#environmentTexture).
+ *
+ * Usually the URL to an `*.env` file.
+ *
+ * See [environment page](./../pages/documentation/Environment.html) for details on how to use this.
+ *
+ * Scopes:
+ * * {@link SceneManager}
+ *
+ * @parser string
+ */
+Parameter.ENVIRONMENT = 'environment';
+/**
+ * Sets [BABYLON.Scene.clearColor](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#clearColor)
+ *
+ * See [environment page](./../pages/documentation/Environment.html) for details on how to use this.
+ *
+ * Scopes:
+ * * {@link SceneManager}
+ *
+ * @parser {@link parseColor}
+ */
+Parameter.ENVIRONMENT_COLOR = 'environment.color';
+/**
+ * Rotates connected textures, i.e. IBL, reflection, background, ...
+ * Rotation angle in degree.
+ *
+ * See [environment page](./../pages/documentation/Environment.html) for details on how to use this.
+ *
+ * Scopes:
+ * * {@link SceneManager}
+ *
+ * @parser {@link parseNumber}
+ */
+Parameter.ENVIRONMENT_ROTATION = 'environment.rotation';
+/**
+ * Intensity of IBL. Defaults to 1, usually between 0 & 2.
+ *
+ * See [environment page](./../pages/documentation/Environment.html) for details on how to use this.
+ *
+ * Scopes:
+ * * {@link SceneManager}
+ *
+ * @parser {@link parseNumber}
+ */
+Parameter.ENVIRONMENT_INTENSITY = 'environment.intensity';
+/**
+ * Background texture on a [PhotoDome](https://doc.babylonjs.com/divingDeeper/environment/360PhotoDome).
+ * Just background, no IBL or reflection.
+ *
+ * Recommended format is `*.jpg`. HDR files are not supported as background but can be converted to `*.jpg` using
+ * tools like Photoshop, Gimp or various free online converters.
+ *
+ * See [environment page](./../pages/documentation/Environment.html) for details on how to use this.
+ *
+ * Scopes:
+ * * {@link SceneManager}
+ *
+ * @parser string
+ */
+Parameter.ENVIRONMENT_BACKGROUND = 'environment.background';
+/**
+ * If `true`, sets a `scene.environmentTexture` and creates a *BackgroundHelper* Node (via
+ * [scene.createDefaultEnvironment](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#createDefaultEnvironment))
+ * with two subnodes/meshes:
+ * - BackgroundPlane
+ * - BackgroundSkybox
+ *
+ * The value of this parameter is ignored if {@link ENVIRONMENT_BACKGROUND} is also set.
+ *
+ * See [environment page](./../pages/documentation/Environment.html) for details on how to use this.
+ *
+ * Scopes:
+ * * {@link SceneManager}
+ *
+ * @parser {@link parseBoolean}
+ */
+Parameter.ENVIRONMENT_USEDEFAULT = 'environment.usedefault';
 //# sourceMappingURL=parameter.js.map