@combeenation/3d-viewer 6.1.0 → 6.2.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 ../../../doc/documentation/Parameters.md} 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 ../../../doc/documentation/Parameters.md} 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,98 +1,98 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ParameterObservable = void 0;
-const stringHelper_1 = require("../util/stringHelper");
-const eventBroadcaster_1 = require("./eventBroadcaster");
-const lodash_es_1 = require("lodash-es");
-class ParameterObservable extends eventBroadcaster_1.EventBroadcaster {
-    constructor(parameterDeclaration = {}, parameters = {}) {
-        super();
-        this.parameters = {};
-        this.parameterDeclaration = {};
-        this.parameterObservers = new Map();
-        this.uuid = (0, stringHelper_1.uuidv4)();
-        this.parameterDeclaration = (0, lodash_es_1.merge)(this.parameterDeclaration, parameterDeclaration);
-        this.parameters = (0, lodash_es_1.merge)(this.parameters, parameters);
-    }
-    /**
-     * The uuid (if not overloaded).
-     */
-    get id() {
-        return this.uuid;
-    }
-    /**
-     * 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 ../../../doc/documentation/Parameters.md} for an example.
-     */
-    addParameterObserver(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.
-     */
-    removeParameterObservers(parameter) {
-        this.parameterObservers.delete(parameter);
-        return this;
-    }
-    /**
-     * Invoke parameter observers for given parameter.
-     */
-    commitParameter(parameter, value) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const parameters = {};
-            parameters[parameter] = value;
-            return this.commitParameters(parameters);
-        });
-    }
-    /**
-     * Asserts whether given parameter is declared and valid.
-     */
-    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 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;
-        }
-    }
-}
-exports.ParameterObservable = ParameterObservable;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParameterObservable = void 0;
+const stringHelper_1 = require("../util/stringHelper");
+const eventBroadcaster_1 = require("./eventBroadcaster");
+const lodash_es_1 = require("lodash-es");
+class ParameterObservable extends eventBroadcaster_1.EventBroadcaster {
+    constructor(parameterDeclaration = {}, parameters = {}) {
+        super();
+        this.parameters = {};
+        this.parameterDeclaration = {};
+        this.parameterObservers = new Map();
+        this.uuid = (0, stringHelper_1.uuidv4)();
+        this.parameterDeclaration = (0, lodash_es_1.merge)(this.parameterDeclaration, parameterDeclaration);
+        this.parameters = (0, lodash_es_1.merge)(this.parameters, parameters);
+    }
+    /**
+     * The uuid (if not overloaded).
+     */
+    get id() {
+        return this.uuid;
+    }
+    /**
+     * 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 ../../../doc/documentation/Parameters.md} for an example.
+     */
+    addParameterObserver(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.
+     */
+    removeParameterObservers(parameter) {
+        this.parameterObservers.delete(parameter);
+        return this;
+    }
+    /**
+     * Invoke parameter observers for given parameter.
+     */
+    commitParameter(parameter, value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const parameters = {};
+            parameters[parameter] = value;
+            return this.commitParameters(parameters);
+        });
+    }
+    /**
+     * Asserts whether given parameter is declared and valid.
+     */
+    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 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;
+        }
+    }
+}
+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,103 +1,103 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Parameterizable = void 0;
-const parameter_1 = require("./parameter");
-const parameterObservable_1 = require("./parameterObservable");
-class Parameterizable extends parameterObservable_1.ParameterObservable {
-    constructor() {
-        super(...arguments);
-        this.parameterDeclaration = parameter_1.Parameter.declarations;
-    }
-    get visible() {
-        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;
-        }
-    }
-    get highlighted() {
-        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;
-        }
-    }
-    get material() {
-        if (!(parameter_1.Parameter.MATERIAL in this.parameters)) {
-            return undefined;
-        }
-        return this.parameters[parameter_1.Parameter.MATERIAL].toString();
-    }
-    get scaling() {
-        if (!(parameter_1.Parameter.SCALING in this.parameters)) {
-            return undefined;
-        }
-        return this.parameters[parameter_1.Parameter.SCALING].toString();
-    }
-    get position() {
-        if (!(parameter_1.Parameter.POSITION in this.parameters)) {
-            return undefined;
-        }
-        return this.parameters[parameter_1.Parameter.POSITION].toString();
-    }
-    get rotation() {
-        if (!(parameter_1.Parameter.ROTATION in this.parameters)) {
-            return undefined;
-        }
-        return this.parameters[parameter_1.Parameter.ROTATION].toString();
-    }
-    get castShadow() {
-        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;
-        }
-    }
-    show() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.commitParameter(parameter_1.Parameter.VISIBLE, true);
-            return this;
-        });
-    }
-    hide() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.commitParameter(parameter_1.Parameter.VISIBLE, false);
-            return this;
-        });
-    }
-    toggle() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.commitParameter(parameter_1.Parameter.VISIBLE, !this.visible);
-            return this;
-        });
-    }
-    toggleHighlight() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.commitParameter(parameter_1.Parameter.HIGHLIGHTED, !this.highlighted);
-            return this;
-        });
-    }
-}
-exports.Parameterizable = Parameterizable;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Parameterizable = void 0;
+const parameter_1 = require("./parameter");
+const parameterObservable_1 = require("./parameterObservable");
+class Parameterizable extends parameterObservable_1.ParameterObservable {
+    constructor() {
+        super(...arguments);
+        this.parameterDeclaration = parameter_1.Parameter.declarations;
+    }
+    get visible() {
+        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;
+        }
+    }
+    get highlighted() {
+        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;
+        }
+    }
+    get material() {
+        if (!(parameter_1.Parameter.MATERIAL in this.parameters)) {
+            return undefined;
+        }
+        return this.parameters[parameter_1.Parameter.MATERIAL].toString();
+    }
+    get scaling() {
+        if (!(parameter_1.Parameter.SCALING in this.parameters)) {
+            return undefined;
+        }
+        return this.parameters[parameter_1.Parameter.SCALING].toString();
+    }
+    get position() {
+        if (!(parameter_1.Parameter.POSITION in this.parameters)) {
+            return undefined;
+        }
+        return this.parameters[parameter_1.Parameter.POSITION].toString();
+    }
+    get rotation() {
+        if (!(parameter_1.Parameter.ROTATION in this.parameters)) {
+            return undefined;
+        }
+        return this.parameters[parameter_1.Parameter.ROTATION].toString();
+    }
+    get castShadow() {
+        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;
+        }
+    }
+    show() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.commitParameter(parameter_1.Parameter.VISIBLE, true);
+            return this;
+        });
+    }
+    hide() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.commitParameter(parameter_1.Parameter.VISIBLE, false);
+            return this;
+        });
+    }
+    toggle() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.commitParameter(parameter_1.Parameter.VISIBLE, !this.visible);
+            return this;
+        });
+    }
+    toggleHighlight() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.commitParameter(parameter_1.Parameter.HIGHLIGHTED, !this.highlighted);
+            return this;
+        });
+    }
+}
+exports.Parameterizable = Parameterizable;
 //# sourceMappingURL=parameterizable.js.map

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

@@ -1,45 +1,45 @@
-/// <reference types="gsap" />
-import { AnimationInterface } from './animationInterface';
-/**
- * An {@link PlacementAnimation} handling `Tweens` of the `GSAP` API using configured {@link PlacementDefinition}s
- * and {@link AnimationDefinition}s. It mutates the attributes in the given {@link PlacementDefinition} with the given
- * {@link AnimationDefinition}. The latter can be anything the `GSAP` allows in its API. Please consider using the
- * API of the {@link AnimationManager} to handle instances of this class in your consuming project.
- */
-export declare class PlacementAnimation implements AnimationInterface {
-    readonly mutable: object;
-    protected _placement: PlacementDefinition | string;
-    protected _animation?: string | AnimationDefinition | undefined;
-    protected _placementDefinition: PlacementDefinition;
-    protected _animationDefinition: AnimationDefinition;
-    protected _timeline: GSAPTimeline;
-    /**
-     * Constructor.
-     */
-    constructor(mutable: object, _placement: PlacementDefinition | string, _animation?: string | AnimationDefinition | undefined);
-    /**
-     * Plays all `Tweens` of this {@link PlacementAnimation}.
-     */
-    play(): Promise<AnimationInterface>;
-    /**
-     * Pause all `Tweens` of this {@link PlacementAnimation}.
-     */
-    pause(): AnimationInterface;
-    /**
-     * Kills all `Tweens` of this {@link PlacementAnimation}.
-     */
-    kill(): AnimationInterface;
-    /**
-     * Creates a {@link AnimationDefinition} definition if not provided in the constructor and sets some defaults.
-     * Only custom properties from {@link AnimationDefinition} are adjusted, all {@link GSAPTweenVars} remain untouched.
-     */
-    protected prepareAnimationDefinition(): void;
-    /**
-     * Prepares different types of {@link PlacementDefinition} and sets some defaults.
-     */
-    protected preparePlacementDefinition(): void;
-    /**
-     * Creates `Tweens` for the {@link PlacementDefinition} configured for this {@link PlacementAnimation}.
-     */
-    protected createTweens(): void;
-}
+/// <reference types="gsap" />
+import { AnimationInterface } from './animationInterface';
+/**
+ * An {@link PlacementAnimation} handling `Tweens` of the `GSAP` API using configured {@link PlacementDefinition}s
+ * and {@link AnimationDefinition}s. It mutates the attributes in the given {@link PlacementDefinition} with the given
+ * {@link AnimationDefinition}. The latter can be anything the `GSAP` allows in its API. Please consider using the
+ * API of the {@link AnimationManager} to handle instances of this class in your consuming project.
+ */
+export declare class PlacementAnimation implements AnimationInterface {
+    readonly mutable: object;
+    protected _placement: PlacementDefinition | string;
+    protected _animation?: string | AnimationDefinition | undefined;
+    protected _placementDefinition: PlacementDefinition;
+    protected _animationDefinition: AnimationDefinition;
+    protected _timeline: GSAPTimeline;
+    /**
+     * Constructor.
+     */
+    constructor(mutable: object, _placement: PlacementDefinition | string, _animation?: string | AnimationDefinition | undefined);
+    /**
+     * Plays all `Tweens` of this {@link PlacementAnimation}.
+     */
+    play(): Promise<AnimationInterface>;
+    /**
+     * Pause all `Tweens` of this {@link PlacementAnimation}.
+     */
+    pause(): AnimationInterface;
+    /**
+     * Kills all `Tweens` of this {@link PlacementAnimation}.
+     */
+    kill(): AnimationInterface;
+    /**
+     * Creates a {@link AnimationDefinition} definition if not provided in the constructor and sets some defaults.
+     * Only custom properties from {@link AnimationDefinition} are adjusted, all {@link GSAPTweenVars} remain untouched.
+     */
+    protected prepareAnimationDefinition(): void;
+    /**
+     * Prepares different types of {@link PlacementDefinition} and sets some defaults.
+     */
+    protected preparePlacementDefinition(): void;
+    /**
+     * Creates `Tweens` for the {@link PlacementDefinition} configured for this {@link PlacementAnimation}.
+     */
+    protected createTweens(): void;
+}