@combeenation/3d-viewer 4.0.0-beta3 → 4.0.0-beta4

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

@@ -1,268 +1,268 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Parameter = void 0;
-var math_color_1 = require("@babylonjs/core/Maths/math.color");
-var math_vector_1 = require("@babylonjs/core/Maths/math.vector");
-var 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.
- */
-var Parameter = /** @class */ (function () {
-    /**
-     * Constructor.
-     */
-    function Parameter() {
-    }
-    Object.defineProperty(Parameter, "declarations", {
-        /**
-         * The {@link ParameterDeclarations} for all parameters in this class.
-         */
-        get: function () {
-            var declaration = {};
-            declaration[Parameter.VISIBLE] = { type: 'boolean' };
-            declaration[Parameter.SCALING] = { type: 'number' };
-            declaration[Parameter.HIGHLIGHTED] = { type: 'boolean' };
-            declaration[Parameter.MATERIAL] = { type: 'string' };
-            declaration[Parameter.MATERIAL_COLOR] = { type: 'color' };
-            declaration[Parameter.MATERIAL_METALLNESS] = { type: 'number' };
-            declaration[Parameter.MATERIAL_ROUGHNESS] = { type: 'number' };
-            declaration[Parameter.HIGHLIGHT_ENABLED] = { type: 'boolean' };
-            declaration[Parameter.HIGHLIGHT_COLOR] = { type: 'color' };
-            declaration[Parameter.HIGHLIGHTED] = { type: 'boolean' };
-            declaration[Parameter.POSITION] = { type: 'vector' };
-            declaration[Parameter.ROTATION] = { type: 'vector' };
-            return declaration;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    /**
-     * Gets the {@link ParameterDeclaration} for a given {@link Parameter} declared in this class.
-     */
-    Parameter.getDeclaration = function (parameter) {
-        return Parameter.declarations[parameter];
-    };
-    Object.defineProperty(Parameter, "all", {
-        /**
-         * All parameters defined in this class.
-         */
-        get: function () {
-            var all = [];
-            for (var parameter in Parameter) {
-                var property = Object.getOwnPropertyDescriptor(Parameter, parameter);
-                if (parameter.toUpperCase() === parameter && property && lodash_es_1.isString(property.value)) {
-                    all.push(property.value);
-                }
-            }
-            return all;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    /**
-     * Parses a string of format `'(x,y,z)'` to a `Vector3`.
-     */
-    Parameter.parseVector = function (value) {
-        if (!lodash_es_1.isString(value)) {
-            throw new Error("Unable to convert \"" + value + "\" into a Vector: not a string.");
-        }
-        var cleanedValue = value.split(' ').join('');
-        if (cleanedValue.startsWith('(') && cleanedValue.endsWith(')')) {
-            cleanedValue = cleanedValue.substring(1, cleanedValue.length - 1);
-            var _a = cleanedValue.split(',').map(function (value) { return parseFloat(value); }), x = _a[0], y = _a[1], z = _a[2];
-            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)`.
-     */
-    Parameter.stringifyVector = function (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.
-     */
-    Parameter.parseRotation = function (value) {
-        var rotation = Parameter.parseVector(value);
-        var 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.
-     */
-    Parameter.parseScaling = function (value) {
-        var scaling = new math_vector_1.Vector3();
-        if (lodash_es_1.isString(value)) {
-            var cleanedFactor = value.split(' ').join('');
-            if (cleanedFactor.startsWith('(') && cleanedFactor.endsWith(')')) {
-                scaling = Parameter.parseVector(cleanedFactor);
-            }
-            else {
-                var _factor = parseFloat(value);
-                scaling = new math_vector_1.Vector3(_factor, _factor, _factor);
-            }
-        }
-        else if (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`.
-     */
-    Parameter.parseColor = function (value) {
-        var cleanedValue = value.toString().split(' ').join('');
-        if (cleanedValue.startsWith('#')) {
-            return math_color_1.Color3.FromHexString(value.toString());
-        }
-        if (cleanedValue.startsWith('(') && cleanedValue.endsWith(')')) {
-            cleanedValue = cleanedValue.substring(1, cleanedValue.length - 1);
-            var _a = cleanedValue.split(',').map(function (value) { return parseFloat(value); }), r = _a[0], g = _a[1], b = _a[2];
-            return math_color_1.Color3.FromInts(r, g, b);
-        }
-        throw new Error("Unable to parse \"" + value + "\" to a Color: expected \"#rrggbb\" or \"(r,g,b)\".");
-    };
-    /**
-     * Parses a `boolean` string (`'true'`/`'1'` or `'false'`/`'0'`) or `number` (`1` or `0`) to a `boolean` or `undefined`.
-     */
-    Parameter.parseBoolean = function (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`.
-     */
-    Parameter.parseNumber = function (value) {
-        return parseFloat(value.toString());
-    };
-    /**
-     * Mutates the visibility. Helper methods are {@link ElementParameterizable.show} and
-     * {@link ElementParameterizable.hide}. Getter and setter is {@link ElementParameterizable.visible}.
-     *
-     * Scopes:
-     * * {@link Element}
-     * * {@link Variant}
-     *
-     * @parser {@link parseBoolean}
-     */
-    Parameter.VISIBLE = 'visible';
-    /**
-     * Stretches or compresses some meshes. Getter and setter is {@link ElementParameterizable.scaling}.
-     *
-     * Scopes:
-     * * {@link Element}
-     * * {@link Variant}
-     *
-     * @parser {@link parseScaling}
-     */
-    Parameter.SCALING = 'scaling';
-    /**
-     * Mutates the material. Getter and setter is {@link ElementParameterizable.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 ElementParameterizable.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 ElementParameterizable.position}.
-     *
-     * Scopes:
-     * * {@link Element}
-     * * {@link Variant}
-     *
-     * @parser {@link parseVector}
-     */
-    Parameter.POSITION = 'position';
-    /**
-     * Mutates the rotation relative to its origin rotation. Getter and setter is {@link ElementParameterizable.rotation}.
-     *
-     * Scopes:
-     * * {@link Element}
-     * * {@link Variant}
-     *
-     * @parser {@link parseRotation}
-     */
-    Parameter.ROTATION = 'rotation';
-    return Parameter;
-}());
-exports.Parameter = Parameter;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Parameter = void 0;
+var math_color_1 = require("@babylonjs/core/Maths/math.color");
+var math_vector_1 = require("@babylonjs/core/Maths/math.vector");
+var 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.
+ */
+var Parameter = /** @class */ (function () {
+    /**
+     * Constructor.
+     */
+    function Parameter() {
+    }
+    Object.defineProperty(Parameter, "declarations", {
+        /**
+         * The {@link ParameterDeclarations} for all parameters in this class.
+         */
+        get: function () {
+            var declaration = {};
+            declaration[Parameter.VISIBLE] = { type: 'boolean' };
+            declaration[Parameter.SCALING] = { type: 'number' };
+            declaration[Parameter.HIGHLIGHTED] = { type: 'boolean' };
+            declaration[Parameter.MATERIAL] = { type: 'string' };
+            declaration[Parameter.MATERIAL_COLOR] = { type: 'color' };
+            declaration[Parameter.MATERIAL_METALLNESS] = { type: 'number' };
+            declaration[Parameter.MATERIAL_ROUGHNESS] = { type: 'number' };
+            declaration[Parameter.HIGHLIGHT_ENABLED] = { type: 'boolean' };
+            declaration[Parameter.HIGHLIGHT_COLOR] = { type: 'color' };
+            declaration[Parameter.HIGHLIGHTED] = { type: 'boolean' };
+            declaration[Parameter.POSITION] = { type: 'vector' };
+            declaration[Parameter.ROTATION] = { type: 'vector' };
+            return declaration;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Gets the {@link ParameterDeclaration} for a given {@link Parameter} declared in this class.
+     */
+    Parameter.getDeclaration = function (parameter) {
+        return Parameter.declarations[parameter];
+    };
+    Object.defineProperty(Parameter, "all", {
+        /**
+         * All parameters defined in this class.
+         */
+        get: function () {
+            var all = [];
+            for (var parameter in Parameter) {
+                var property = Object.getOwnPropertyDescriptor(Parameter, parameter);
+                if (parameter.toUpperCase() === parameter && property && lodash_es_1.isString(property.value)) {
+                    all.push(property.value);
+                }
+            }
+            return all;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Parses a string of format `'(x,y,z)'` to a `Vector3`.
+     */
+    Parameter.parseVector = function (value) {
+        if (!lodash_es_1.isString(value)) {
+            throw new Error("Unable to convert \"" + value + "\" into a Vector: not a string.");
+        }
+        var cleanedValue = value.split(' ').join('');
+        if (cleanedValue.startsWith('(') && cleanedValue.endsWith(')')) {
+            cleanedValue = cleanedValue.substring(1, cleanedValue.length - 1);
+            var _a = cleanedValue.split(',').map(function (value) { return parseFloat(value); }), x = _a[0], y = _a[1], z = _a[2];
+            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)`.
+     */
+    Parameter.stringifyVector = function (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.
+     */
+    Parameter.parseRotation = function (value) {
+        var rotation = Parameter.parseVector(value);
+        var 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.
+     */
+    Parameter.parseScaling = function (value) {
+        var scaling = new math_vector_1.Vector3();
+        if (lodash_es_1.isString(value)) {
+            var cleanedFactor = value.split(' ').join('');
+            if (cleanedFactor.startsWith('(') && cleanedFactor.endsWith(')')) {
+                scaling = Parameter.parseVector(cleanedFactor);
+            }
+            else {
+                var _factor = parseFloat(value);
+                scaling = new math_vector_1.Vector3(_factor, _factor, _factor);
+            }
+        }
+        else if (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`.
+     */
+    Parameter.parseColor = function (value) {
+        var cleanedValue = value.toString().split(' ').join('');
+        if (cleanedValue.startsWith('#')) {
+            return math_color_1.Color3.FromHexString(value.toString());
+        }
+        if (cleanedValue.startsWith('(') && cleanedValue.endsWith(')')) {
+            cleanedValue = cleanedValue.substring(1, cleanedValue.length - 1);
+            var _a = cleanedValue.split(',').map(function (value) { return parseFloat(value); }), r = _a[0], g = _a[1], b = _a[2];
+            return math_color_1.Color3.FromInts(r, g, b);
+        }
+        throw new Error("Unable to parse \"" + value + "\" to a Color: expected \"#rrggbb\" or \"(r,g,b)\".");
+    };
+    /**
+     * Parses a `boolean` string (`'true'`/`'1'` or `'false'`/`'0'`) or `number` (`1` or `0`) to a `boolean` or `undefined`.
+     */
+    Parameter.parseBoolean = function (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`.
+     */
+    Parameter.parseNumber = function (value) {
+        return parseFloat(value.toString());
+    };
+    /**
+     * Mutates the visibility. Helper methods are {@link ElementParameterizable.show} and
+     * {@link ElementParameterizable.hide}. Getter and setter is {@link ElementParameterizable.visible}.
+     *
+     * Scopes:
+     * * {@link Element}
+     * * {@link Variant}
+     *
+     * @parser {@link parseBoolean}
+     */
+    Parameter.VISIBLE = 'visible';
+    /**
+     * Stretches or compresses some meshes. Getter and setter is {@link ElementParameterizable.scaling}.
+     *
+     * Scopes:
+     * * {@link Element}
+     * * {@link Variant}
+     *
+     * @parser {@link parseScaling}
+     */
+    Parameter.SCALING = 'scaling';
+    /**
+     * Mutates the material. Getter and setter is {@link ElementParameterizable.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 ElementParameterizable.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 ElementParameterizable.position}.
+     *
+     * Scopes:
+     * * {@link Element}
+     * * {@link Variant}
+     *
+     * @parser {@link parseVector}
+     */
+    Parameter.POSITION = 'position';
+    /**
+     * Mutates the rotation relative to its origin rotation. Getter and setter is {@link ElementParameterizable.rotation}.
+     *
+     * Scopes:
+     * * {@link Element}
+     * * {@link Variant}
+     *
+     * @parser {@link parseRotation}
+     */
+    Parameter.ROTATION = 'rotation';
+    return Parameter;
+}());
+exports.Parameter = Parameter;
 //# sourceMappingURL=parameter.js.map

package/dist/lib-cjs/api/classes/parameterObservable.d.ts

@@ -1,36 +1,36 @@
-import { EventBroadcaster } from './eventBroadcaster';
-export declare abstract class ParameterObservable extends EventBroadcaster {
-    readonly uuid: string;
-    readonly parameters: ParameterBag;
-    protected readonly parameterDeclaration: ParameterDeclarations;
-    protected parameterObservers: Map<string, ParameterObserver[]>;
-    protected constructor(parameterDeclaration?: ParameterDeclarations, parameters?: ParameterBag);
-    /**
-     * The uuid (if not overloaded).
-     */
-    get id(): string;
-    /**
-     * Adds an observer function for parameter changes.
-     * The {@link ParameterObserver} gets 3 parameters: the {@link ParameterObservable}, the old {@link ParameterValue}
-     * and the new {@link ParameterValue}.
-     *
-     * See {@page Parameters} for an example.
-     */
-    addParameterObserver(parameter: string, observer: ParameterObserver): ParameterObservable;
-    /**
-     * Removes all {@link ParameterObserver}s for given parameter.
-     */
-    removeParameterObservers(parameter: string): ParameterObservable;
-    /**
-     * Invoke parameter observers for given parameter.
-     */
-    commitParameter(parameter: string, value: ParameterValue): Promise<ParameterObservable>;
-    /**
-     * Invoke parameter observers for given parameters.
-     */
-    abstract commitParameters(parameters?: ParameterBag): Promise<ParameterObservable>;
-    /**
-     * Asserts whether given parameter is declared and valid.
-     */
-    assertParameter(parameterDeclaration: ParameterDeclarations, parameter: string, value: ParameterValue): void;
-}
+import { EventBroadcaster } from './eventBroadcaster';
+export declare abstract class ParameterObservable extends EventBroadcaster {
+    readonly uuid: string;
+    readonly parameters: ParameterBag;
+    protected readonly parameterDeclaration: ParameterDeclarations;
+    protected parameterObservers: Map<string, ParameterObserver[]>;
+    protected constructor(parameterDeclaration?: ParameterDeclarations, parameters?: ParameterBag);
+    /**
+     * The uuid (if not overloaded).
+     */
+    get id(): string;
+    /**
+     * Adds an observer function for parameter changes.
+     * The {@link ParameterObserver} gets 3 parameters: the {@link ParameterObservable}, the old {@link ParameterValue}
+     * and the new {@link ParameterValue}.
+     *
+     * See {@page Parameters} for an example.
+     */
+    addParameterObserver(parameter: string, observer: ParameterObserver): ParameterObservable;
+    /**
+     * Removes all {@link ParameterObserver}s for given parameter.
+     */
+    removeParameterObservers(parameter: string): ParameterObservable;
+    /**
+     * Invoke parameter observers for given parameter.
+     */
+    commitParameter(parameter: string, value: ParameterValue): Promise<ParameterObservable>;
+    /**
+     * Invoke parameter observers for given parameters.
+     */
+    abstract commitParameters(parameters?: ParameterBag): Promise<ParameterObservable>;
+    /**
+     * Asserts whether given parameter is declared and valid.
+     */
+    assertParameter(parameterDeclaration: ParameterDeclarations, parameter: string, value: ParameterValue): void;
+}