@combeenation/3d-viewer 4.0.0-rc1 → 4.0.0

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;
+}

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

@@ -1,102 +1,102 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ParameterObservable = void 0;
-var tslib_1 = require("tslib");
-var lodash_es_1 = require("lodash-es");
-var stringHelper_1 = require("../util/stringHelper");
-var eventBroadcaster_1 = require("./eventBroadcaster");
-var ParameterObservable = /** @class */ (function (_super) {
-    tslib_1.__extends(ParameterObservable, _super);
-    function ParameterObservable(parameterDeclaration, parameters) {
-        if (parameterDeclaration === void 0) { parameterDeclaration = {}; }
-        if (parameters === void 0) { parameters = {}; }
-        var _this = _super.call(this) || this;
-        _this.parameters = {};
-        _this.parameterDeclaration = {};
-        _this.parameterObservers = new Map();
-        _this.uuid = stringHelper_1.uuidv4();
-        _this.parameterDeclaration = lodash_es_1.merge(_this.parameterDeclaration, parameterDeclaration);
-        _this.parameters = lodash_es_1.merge(_this.parameters, parameters);
-        return _this;
-    }
-    Object.defineProperty(ParameterObservable.prototype, "id", {
-        /**
-         * The uuid (if not overloaded).
-         */
-        get: function () {
-            return this.uuid;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    /**
-     * 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.
-     */
-    ParameterObservable.prototype.addParameterObserver = function (parameter, observer) {
-        if (this.parameterObservers.has(parameter)) {
-            this.parameterObservers.get(parameter).push(observer);
-            return this;
-        }
-        this.parameterObservers.set(parameter, [observer]);
-        return this;
-    };
-    /**
-     * Removes all {@link ParameterObserver}s for given parameter.
-     */
-    ParameterObservable.prototype.removeParameterObservers = function (parameter) {
-        this.parameterObservers.delete(parameter);
-        return this;
-    };
-    /**
-     * Invoke parameter observers for given parameter.
-     */
-    ParameterObservable.prototype.commitParameter = function (parameter, value) {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var parameters;
-            return tslib_1.__generator(this, function (_a) {
-                parameters = {};
-                parameters[parameter] = value;
-                return [2 /*return*/, this.commitParameters(parameters)];
-            });
-        });
-    };
-    /**
-     * Asserts whether given parameter is declared and valid.
-     */
-    ParameterObservable.prototype.assertParameter = function (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;
-        }
-        var declaration = parameterDeclaration[parameter];
-        var genericError = "\"" + value + "\" is not a valid value for parameter \"" + parameter + "\" of type. " +
-            ("\"" + declaration.type + "\" for " + this.constructor.name + " \"" + this.id + "\".");
-        if (declaration.parser) {
-            try {
-                declaration.parser(value);
-            }
-            catch (e) {
-                throw Error(genericError + e.message);
-            }
-        }
-        switch (declaration.type) {
-            case 'select':
-                if (!declaration.options) {
-                    throw Error("No options defined for parameter declaration \"" + parameter + "\"" +
-                        ("of type \"" + declaration.type + "\" for " + this.constructor.name + " \"" + this.id + "\"."));
-                }
-                if (declaration.options.indexOf(value) === -1) {
-                    throw Error(genericError + (" Valid values are: \"" + declaration.options.join('", "') + "\"."));
-                }
-                break;
-        }
-    };
-    return ParameterObservable;
-}(eventBroadcaster_1.EventBroadcaster));
-exports.ParameterObservable = ParameterObservable;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParameterObservable = void 0;
+var tslib_1 = require("tslib");
+var lodash_es_1 = require("lodash-es");
+var stringHelper_1 = require("../util/stringHelper");
+var eventBroadcaster_1 = require("./eventBroadcaster");
+var ParameterObservable = /** @class */ (function (_super) {
+    tslib_1.__extends(ParameterObservable, _super);
+    function ParameterObservable(parameterDeclaration, parameters) {
+        if (parameterDeclaration === void 0) { parameterDeclaration = {}; }
+        if (parameters === void 0) { parameters = {}; }
+        var _this = _super.call(this) || this;
+        _this.parameters = {};
+        _this.parameterDeclaration = {};
+        _this.parameterObservers = new Map();
+        _this.uuid = stringHelper_1.uuidv4();
+        _this.parameterDeclaration = lodash_es_1.merge(_this.parameterDeclaration, parameterDeclaration);
+        _this.parameters = lodash_es_1.merge(_this.parameters, parameters);
+        return _this;
+    }
+    Object.defineProperty(ParameterObservable.prototype, "id", {
+        /**
+         * The uuid (if not overloaded).
+         */
+        get: function () {
+            return this.uuid;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * 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.
+     */
+    ParameterObservable.prototype.addParameterObserver = function (parameter, observer) {
+        if (this.parameterObservers.has(parameter)) {
+            this.parameterObservers.get(parameter).push(observer);
+            return this;
+        }
+        this.parameterObservers.set(parameter, [observer]);
+        return this;
+    };
+    /**
+     * Removes all {@link ParameterObserver}s for given parameter.
+     */
+    ParameterObservable.prototype.removeParameterObservers = function (parameter) {
+        this.parameterObservers.delete(parameter);
+        return this;
+    };
+    /**
+     * Invoke parameter observers for given parameter.
+     */
+    ParameterObservable.prototype.commitParameter = function (parameter, value) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var parameters;
+            return tslib_1.__generator(this, function (_a) {
+                parameters = {};
+                parameters[parameter] = value;
+                return [2 /*return*/, this.commitParameters(parameters)];
+            });
+        });
+    };
+    /**
+     * Asserts whether given parameter is declared and valid.
+     */
+    ParameterObservable.prototype.assertParameter = function (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;
+        }
+        var declaration = parameterDeclaration[parameter];
+        var genericError = "\"" + value + "\" is not a valid value for parameter \"" + parameter + "\" of type. " +
+            ("\"" + declaration.type + "\" for " + this.constructor.name + " \"" + this.id + "\".");
+        if (declaration.parser) {
+            try {
+                declaration.parser(value);
+            }
+            catch (e) {
+                throw Error(genericError + e.message);
+            }
+        }
+        switch (declaration.type) {
+            case 'select':
+                if (!declaration.options) {
+                    throw Error("No options defined for parameter declaration \"" + parameter + "\"" +
+                        ("of type \"" + declaration.type + "\" for " + this.constructor.name + " \"" + this.id + "\"."));
+                }
+                if (declaration.options.indexOf(value) === -1) {
+                    throw Error(genericError + (" Valid values are: \"" + declaration.options.join('", "') + "\"."));
+                }
+                break;
+        }
+    };
+    return ParameterObservable;
+}(eventBroadcaster_1.EventBroadcaster));
+exports.ParameterObservable = ParameterObservable;
 //# sourceMappingURL=parameterObservable.js.map

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

@@ -1,15 +1,15 @@
-import { ParameterObservable } from './parameterObservable';
-export declare abstract class Parameterizable extends ParameterObservable {
-    protected parameterDeclaration: ParameterDeclarations;
-    get visible(): boolean | undefined;
-    get highlighted(): boolean | undefined;
-    get material(): string | undefined;
-    get scaling(): string | undefined;
-    get position(): string | undefined;
-    get rotation(): string | undefined;
-    get castShadow(): boolean | undefined;
-    show(): Promise<ParameterObservable>;
-    hide(): Promise<ParameterObservable>;
-    toggle(): Promise<ParameterObservable>;
-    toggleHighlight(): Promise<ParameterObservable>;
-}
+import { ParameterObservable } from './parameterObservable';
+export declare abstract class Parameterizable extends ParameterObservable {
+    protected parameterDeclaration: ParameterDeclarations;
+    get visible(): boolean | undefined;
+    get highlighted(): boolean | undefined;
+    get material(): string | undefined;
+    get scaling(): string | undefined;
+    get position(): string | undefined;
+    get rotation(): string | undefined;
+    get castShadow(): boolean | undefined;
+    show(): Promise<ParameterObservable>;
+    hide(): Promise<ParameterObservable>;
+    toggle(): Promise<ParameterObservable>;
+    toggleHighlight(): Promise<ParameterObservable>;
+}

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

@@ -1,150 +1,150 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Parameterizable = void 0;
-var tslib_1 = require("tslib");
-var parameter_1 = require("./parameter");
-var parameterObservable_1 = require("./parameterObservable");
-var Parameterizable = /** @class */ (function (_super) {
-    tslib_1.__extends(Parameterizable, _super);
-    function Parameterizable() {
-        var _this = _super !== null && _super.apply(this, arguments) || this;
-        _this.parameterDeclaration = parameter_1.Parameter.declarations;
-        return _this;
-    }
-    Object.defineProperty(Parameterizable.prototype, "visible", {
-        get: function () {
-            if (!(parameter_1.Parameter.VISIBLE in this.parameters)) {
-                return undefined;
-            }
-            try {
-                return parameter_1.Parameter.parseBoolean(this.parameters[parameter_1.Parameter.VISIBLE]);
-            }
-            catch (e) {
-                return undefined;
-            }
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(Parameterizable.prototype, "highlighted", {
-        get: function () {
-            if (!(parameter_1.Parameter.HIGHLIGHTED in this.parameters)) {
-                return undefined;
-            }
-            try {
-                return parameter_1.Parameter.parseBoolean(this.parameters[parameter_1.Parameter.HIGHLIGHTED]);
-            }
-            catch (e) {
-                return undefined;
-            }
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(Parameterizable.prototype, "material", {
-        get: function () {
-            if (!(parameter_1.Parameter.MATERIAL in this.parameters)) {
-                return undefined;
-            }
-            return this.parameters[parameter_1.Parameter.MATERIAL].toString();
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(Parameterizable.prototype, "scaling", {
-        get: function () {
-            if (!(parameter_1.Parameter.SCALING in this.parameters)) {
-                return undefined;
-            }
-            return this.parameters[parameter_1.Parameter.SCALING].toString();
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(Parameterizable.prototype, "position", {
-        get: function () {
-            if (!(parameter_1.Parameter.POSITION in this.parameters)) {
-                return undefined;
-            }
-            return this.parameters[parameter_1.Parameter.POSITION].toString();
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(Parameterizable.prototype, "rotation", {
-        get: function () {
-            if (!(parameter_1.Parameter.ROTATION in this.parameters)) {
-                return undefined;
-            }
-            return this.parameters[parameter_1.Parameter.ROTATION].toString();
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(Parameterizable.prototype, "castShadow", {
-        get: function () {
-            if (!(parameter_1.Parameter.CAST_SHADOW in this.parameters)) {
-                return undefined;
-            }
-            try {
-                return parameter_1.Parameter.parseBoolean(this.parameters[parameter_1.Parameter.CAST_SHADOW]);
-            }
-            catch (e) {
-                return undefined;
-            }
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Parameterizable.prototype.show = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            return tslib_1.__generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.commitParameter(parameter_1.Parameter.VISIBLE, true)];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, this];
-                }
-            });
-        });
-    };
-    Parameterizable.prototype.hide = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            return tslib_1.__generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.commitParameter(parameter_1.Parameter.VISIBLE, false)];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, this];
-                }
-            });
-        });
-    };
-    Parameterizable.prototype.toggle = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            return tslib_1.__generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.commitParameter(parameter_1.Parameter.VISIBLE, !this.visible)];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, this];
-                }
-            });
-        });
-    };
-    Parameterizable.prototype.toggleHighlight = function () {
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            return tslib_1.__generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.commitParameter(parameter_1.Parameter.HIGHLIGHTED, !this.highlighted)];
-                    case 1:
-                        _a.sent();
-                        return [2 /*return*/, this];
-                }
-            });
-        });
-    };
-    return Parameterizable;
-}(parameterObservable_1.ParameterObservable));
-exports.Parameterizable = Parameterizable;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Parameterizable = void 0;
+var tslib_1 = require("tslib");
+var parameter_1 = require("./parameter");
+var parameterObservable_1 = require("./parameterObservable");
+var Parameterizable = /** @class */ (function (_super) {
+    tslib_1.__extends(Parameterizable, _super);
+    function Parameterizable() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.parameterDeclaration = parameter_1.Parameter.declarations;
+        return _this;
+    }
+    Object.defineProperty(Parameterizable.prototype, "visible", {
+        get: function () {
+            if (!(parameter_1.Parameter.VISIBLE in this.parameters)) {
+                return undefined;
+            }
+            try {
+                return parameter_1.Parameter.parseBoolean(this.parameters[parameter_1.Parameter.VISIBLE]);
+            }
+            catch (e) {
+                return undefined;
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Parameterizable.prototype, "highlighted", {
+        get: function () {
+            if (!(parameter_1.Parameter.HIGHLIGHTED in this.parameters)) {
+                return undefined;
+            }
+            try {
+                return parameter_1.Parameter.parseBoolean(this.parameters[parameter_1.Parameter.HIGHLIGHTED]);
+            }
+            catch (e) {
+                return undefined;
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Parameterizable.prototype, "material", {
+        get: function () {
+            if (!(parameter_1.Parameter.MATERIAL in this.parameters)) {
+                return undefined;
+            }
+            return this.parameters[parameter_1.Parameter.MATERIAL].toString();
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Parameterizable.prototype, "scaling", {
+        get: function () {
+            if (!(parameter_1.Parameter.SCALING in this.parameters)) {
+                return undefined;
+            }
+            return this.parameters[parameter_1.Parameter.SCALING].toString();
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Parameterizable.prototype, "position", {
+        get: function () {
+            if (!(parameter_1.Parameter.POSITION in this.parameters)) {
+                return undefined;
+            }
+            return this.parameters[parameter_1.Parameter.POSITION].toString();
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Parameterizable.prototype, "rotation", {
+        get: function () {
+            if (!(parameter_1.Parameter.ROTATION in this.parameters)) {
+                return undefined;
+            }
+            return this.parameters[parameter_1.Parameter.ROTATION].toString();
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(Parameterizable.prototype, "castShadow", {
+        get: function () {
+            if (!(parameter_1.Parameter.CAST_SHADOW in this.parameters)) {
+                return undefined;
+            }
+            try {
+                return parameter_1.Parameter.parseBoolean(this.parameters[parameter_1.Parameter.CAST_SHADOW]);
+            }
+            catch (e) {
+                return undefined;
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Parameterizable.prototype.show = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.commitParameter(parameter_1.Parameter.VISIBLE, true)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, this];
+                }
+            });
+        });
+    };
+    Parameterizable.prototype.hide = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.commitParameter(parameter_1.Parameter.VISIBLE, false)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, this];
+                }
+            });
+        });
+    };
+    Parameterizable.prototype.toggle = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.commitParameter(parameter_1.Parameter.VISIBLE, !this.visible)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, this];
+                }
+            });
+        });
+    };
+    Parameterizable.prototype.toggleHighlight = function () {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.commitParameter(parameter_1.Parameter.HIGHLIGHTED, !this.highlighted)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, this];
+                }
+            });
+        });
+    };
+    return Parameterizable;
+}(parameterObservable_1.ParameterObservable));
+exports.Parameterizable = Parameterizable;
 //# sourceMappingURL=parameterizable.js.map