@combeenation/3d-viewer 5.1.0-rc2 → 5.1.0-rc4

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

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

package/dist/lib-es6/api/classes/parameterizable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameterizable.js","sourceRoot":"","sources":["../../../../src/api/classes/parameterizable.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D;IAA8C,mCAAmB;IAAjE;QAAA,qEAmFC;QAlFW,0BAAoB,GAA0B,SAAS,CAAC,YAAY,CAAC;;IAkFjF,CAAC;IAhFC,sBAAI,oCAAO;aAAX;YACE,IAAI,CAAC,CAAC,SAAS,CAAC,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE;gBAC3C,OAAO,SAAS,CAAC;aAClB;YACD,IAAI;gBACF,OAAO,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;aACnE;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,SAAS,CAAC;aAClB;QACH,CAAC;;;OAAA;IAED,sBAAI,wCAAW;aAAf;YACE,IAAI,CAAC,CAAC,SAAS,CAAC,WAAW,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE;gBAC/C,OAAO,SAAS,CAAC;aAClB;YACD,IAAI;gBACF,OAAO,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;aACvE;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,SAAS,CAAC;aAClB;QACH,CAAC;;;OAAA;IAED,sBAAI,qCAAQ;aAAZ;YACE,IAAI,CAAC,CAAC,SAAS,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE;gBAC5C,OAAO,SAAS,CAAC;aAClB;YACD,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;QACxD,CAAC;;;OAAA;IAED,sBAAI,oCAAO;aAAX;YACE,IAAI,CAAC,CAAC,SAAS,CAAC,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE;gBAC3C,OAAO,SAAS,CAAC;aAClB;YACD,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;QACvD,CAAC;;;OAAA;IAED,sBAAI,qCAAQ;aAAZ;YACE,IAAI,CAAC,CAAC,SAAS,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE;gBAC5C,OAAO,SAAS,CAAC;aAClB;YACD,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;QACxD,CAAC;;;OAAA;IAED,sBAAI,qCAAQ;aAAZ;YACE,IAAI,CAAC,CAAC,SAAS,CAAC,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE;gBAC5C,OAAO,SAAS,CAAC;aAClB;YACD,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,CAAC;QACxD,CAAC;;;OAAA;IAED,sBAAI,uCAAU;aAAd;YACE,IAAI,CAAC,CAAC,SAAS,CAAC,WAAW,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE;gBAC/C,OAAO,SAAS,CAAC;aAClB;YACD,IAAI;gBACF,OAAO,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;aACvE;YAAC,OAAO,CAAC,EAAE;gBACV,OAAO,SAAS,CAAC;aAClB;QACH,CAAC;;;OAAA;IAEY,8BAAI,GAAjB;;;;4BACE,qBAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,EAAA;;wBAAnD,SAAmD,CAAC;wBACpD,sBAAO,IAAI,EAAC;;;;KACb;IAEY,8BAAI,GAAjB;;;;4BACE,qBAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,EAAA;;wBAApD,SAAoD,CAAC;wBACrD,sBAAO,IAAI,EAAC;;;;KACb;IAEY,gCAAM,GAAnB;;;;4BACE,qBAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,EAAA;;wBAA5D,SAA4D,CAAC;wBAC7D,sBAAO,IAAI,EAAC;;;;KACb;IAEY,yCAAe,GAA5B;;;;4BACE,qBAAM,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,EAAA;;wBAApE,SAAoE,CAAC;wBACrE,sBAAO,IAAI,EAAC;;;;KACb;IACH,sBAAC;AAAD,CAAC,AAnFD,CAA8C,mBAAmB,GAmFhE"}

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

@@ -0,0 +1,44 @@
+/// <reference types="gsap" />
+/**
+ * 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;
+}

package/dist/lib-es6/api/classes/placementAnimation.js

@@ -0,0 +1,161 @@
+import { __awaiter, __generator, __rest } from "tslib";
+import { ArcRotateCamera } from '@babylonjs/core/Cameras/arcRotateCamera';
+import { Vector3 } from '@babylonjs/core/Maths/math.vector';
+import { gsap } from 'gsap';
+import { cloneDeep, get, isString, merge, set } from 'lodash-es';
+import { Parameter } from '../classes/parameter';
+import { SpecStorage } from '../store/specStorage';
+/**
+ * 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.
+ */
+var PlacementAnimation = /** @class */ (function () {
+    /**
+     * Constructor.
+     */
+    function PlacementAnimation(mutable, _placement, _animation) {
+        var _a;
+        this.mutable = mutable;
+        this._placement = _placement;
+        this._animation = _animation;
+        if (isString(_placement)) {
+            var placementDefinitions = SpecStorage.get('scene.placements');
+            if (!placementDefinitions) {
+                throw new Error("No PlacementDefinitions defined in JSON structure.");
+            }
+            var placementDefinition = placementDefinitions[_placement];
+            if (!placementDefinition) {
+                throw new Error("PlacementDefinition \"" + _placement + "\" not defined in JSON structure.");
+            }
+            this._placementDefinition = cloneDeep(placementDefinition);
+        }
+        else {
+            this._placementDefinition = cloneDeep(_placement);
+        }
+        if (isString(_animation)) {
+            var animationDefinition = (_a = SpecStorage.get('scene.animations')) === null || _a === void 0 ? void 0 : _a[_animation];
+            if (!animationDefinition) {
+                throw new Error("AnimationDefinition \"" + _animation + "\" not defined in JSON structure.");
+            }
+            this._animationDefinition = cloneDeep(animationDefinition);
+        }
+        else {
+            this._animationDefinition = cloneDeep(_animation);
+        }
+        this.prepareAnimationDefinition();
+        // create (shallow) copy for GSAP which doesn't contain `shortestWay`,
+        // because that's not part of the original `TweenVars` input typing and therefore leads to warnings
+        var _b = this._animationDefinition, shortestWay = _b.shortestWay, gsapTweenVars = __rest(_b, ["shortestWay"]);
+        this._timeline = gsap.timeline({
+            defaults: gsapTweenVars,
+            paused: true,
+        });
+        this.preparePlacementDefinition();
+        this.createTweens();
+    }
+    /**
+     * Plays all `Tweens` of this {@link PlacementAnimation}.
+     */
+    PlacementAnimation.prototype.play = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this._timeline.play().then()];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/, this];
+                }
+            });
+        });
+    };
+    /**
+     * Pause all `Tweens` of this {@link PlacementAnimation}.
+     */
+    PlacementAnimation.prototype.pause = function () {
+        this._timeline.pause();
+        return this;
+    };
+    /**
+     * Kills all `Tweens` of this {@link PlacementAnimation}.
+     */
+    PlacementAnimation.prototype.kill = function () {
+        this._timeline.kill();
+        return this;
+    };
+    /**
+     * 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.
+     */
+    PlacementAnimation.prototype.prepareAnimationDefinition = function () {
+        // create an animation definition if not available yet
+        this._animationDefinition = this._animationDefinition || {};
+        // parse shortest way flag or set to `true` if not configured
+        if (this._animationDefinition.shortestWay !== undefined) {
+            this._animationDefinition.shortestWay = Parameter.parseBoolean(this._animationDefinition.shortestWay);
+        }
+        else {
+            this._animationDefinition.shortestWay = true;
+        }
+    };
+    /**
+     * Prepares different types of {@link PlacementDefinition} and sets some defaults.
+     */
+    PlacementAnimation.prototype.preparePlacementDefinition = function () {
+        var position = this._placementDefinition.position;
+        if (isString(position)) {
+            position = Parameter.parseVector(position);
+            this._placementDefinition.position = position;
+        }
+        if (this.mutable instanceof ArcRotateCamera) {
+            // parse the target
+            if (isString(this._placementDefinition.target)) {
+                this._placementDefinition.target = Parameter.parseVector(this._placementDefinition.target);
+            }
+            if (position) {
+                // parse the position and calculate alpha, beta and radius with a "ghost camera"
+                // @see https://www.babylonjs-playground.com/#4IVMG#0
+                var ghostCam = this.mutable.clone('ghost');
+                ghostCam.setPosition(position);
+                merge(this._placementDefinition, {
+                    alpha: ghostCam.alpha,
+                    beta: ghostCam.beta,
+                    radius: ghostCam.radius,
+                });
+                delete this._placementDefinition.position;
+                ghostCam.dispose();
+            }
+            else if (this._animationDefinition.shortestWay && this._placementDefinition.alpha !== undefined) {
+                // transform the target's alpha value into the same turn as the current camera position to avoid movements > 360 degrees
+                var alphaGap = this.mutable.alpha - this._placementDefinition.alpha;
+                var cntTurns = Math.round(alphaGap / (2 * Math.PI));
+                this._placementDefinition.alpha += 2 * Math.PI * cntTurns;
+            }
+        }
+    };
+    /**
+     * Creates `Tweens` for the {@link PlacementDefinition} configured for this {@link PlacementAnimation}.
+     */
+    PlacementAnimation.prototype.createTweens = function () {
+        for (var property in this._placementDefinition) {
+            var propertyValue = get(this._placementDefinition, property);
+            var tweenVars = {};
+            var _mutable = this.mutable;
+            if (propertyValue instanceof Vector3) {
+                // GSAP does not support mutation of complex objects, so we are forced
+                // to use the properties on the object as mutable directly and mutate
+                // the coordinates separately.
+                _mutable = get(this.mutable, property);
+                merge(tweenVars, { x: propertyValue.x, y: propertyValue.y, z: propertyValue.z });
+            }
+            else {
+                set(tweenVars, property, propertyValue);
+            }
+            this._timeline.to(_mutable, tweenVars, 0); // Note: position 0 does the "parallel" stuff here
+        }
+    };
+    return PlacementAnimation;
+}());
+export { PlacementAnimation };
+//# sourceMappingURL=placementAnimation.js.map

package/dist/lib-es6/api/classes/placementAnimation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"placementAnimation.js","sourceRoot":"","sources":["../../../../src/api/classes/placementAnimation.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,yCAAyC,CAAC;AAC1E,OAAO,EAAE,OAAO,EAAE,MAAM,mCAAmC,CAAC;AAC5D,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAEnD;;;;;GAKG;AACH;IAOE;;OAEG;IACH,4BACkB,OAAe,EACrB,UAAwC,EACxC,UAAyC;;QAFnC,YAAO,GAAP,OAAO,CAAQ;QACrB,eAAU,GAAV,UAAU,CAA8B;QACxC,eAAU,GAAV,UAAU,CAA+B;QAEnD,IAAI,QAAQ,CAAC,UAAU,CAAC,EAAE;YACxB,IAAM,oBAAoB,GAAG,WAAW,CAAC,GAAG,CAAuB,kBAAkB,CAAC,CAAC;YACvF,IAAI,CAAC,oBAAoB,EAAE;gBACzB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;aACvE;YACD,IAAM,mBAAmB,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC;YAC7D,IAAI,CAAC,mBAAmB,EAAE;gBACxB,MAAM,IAAI,KAAK,CAAC,2BAAwB,UAAU,sCAAkC,CAAC,CAAC;aACvF;YACD,IAAI,CAAC,oBAAoB,GAAG,SAAS,CAAC,mBAAmB,CAAC,CAAC;SAC5D;aAAM;YACL,IAAI,CAAC,oBAAoB,GAAG,SAAS,CAAC,UAAU,CAAwB,CAAC;SAC1E;QACD,IAAI,QAAQ,CAAC,UAAU,CAAC,EAAE;YACxB,IAAM,mBAAmB,SAAG,WAAW,CAAC,GAAG,CAAuB,kBAAkB,CAAC,0CAAG,UAAU,CAAC,CAAC;YACpG,IAAI,CAAC,mBAAmB,EAAE;gBACxB,MAAM,IAAI,KAAK,CAAC,2BAAwB,UAAU,sCAAkC,CAAC,CAAC;aACvF;YACD,IAAI,CAAC,oBAAoB,GAAG,SAAS,CAAC,mBAAmB,CAAC,CAAC;SAC5D;aAAM;YACL,IAAI,CAAC,oBAAoB,GAAG,SAAS,CAAC,UAAU,CAAwB,CAAC;SAC1E;QAED,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAClC,sEAAsE;QACtE,mGAAmG;QACnG,IAAM,KAAoC,IAAI,CAAC,oBAAoB,EAA3D,WAAW,iBAAA,EAAK,aAAa,cAA/B,eAAiC,CAA4B,CAAC;QACpE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC;YAC7B,QAAQ,EAAE,aAAa;YACvB,MAAM,EAAE,IAAI;SACb,CAAC,CAAC;QAEH,IAAI,CAAC,0BAA0B,EAAE,CAAC;QAClC,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED;;OAEG;IACU,iCAAI,GAAjB;;;;4BACE,qBAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAA;;wBAAlC,SAAkC,CAAC;wBACnC,sBAAO,IAAI,EAAC;;;;KACb;IAED;;OAEG;IACI,kCAAK,GAAZ;QACE,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,iCAAI,GAAX;QACE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACO,uDAA0B,GAApC;QACE,sDAAsD;QACtD,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,oBAAoB,IAAI,EAAE,CAAC;QAE5D,6DAA6D;QAC7D,IAAI,IAAI,CAAC,oBAAoB,CAAC,WAAW,KAAK,SAAS,EAAE;YACvD,IAAI,CAAC,oBAAoB,CAAC,WAAW,GAAG,SAAS,CAAC,YAAY,CAAC,IAAI,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC;SACvG;aAAM;YACL,IAAI,CAAC,oBAAoB,CAAC,WAAW,GAAG,IAAI,CAAC;SAC9C;IACH,CAAC;IAED;;OAEG;IACO,uDAA0B,GAApC;QACE,IAAI,QAAQ,GAAG,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC;QAClD,IAAI,QAAQ,CAAC,QAAQ,CAAC,EAAE;YACtB,QAAQ,GAAG,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAC3C,IAAI,CAAC,oBAAoB,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC/C;QACD,IAAI,IAAI,CAAC,OAAO,YAAY,eAAe,EAAE;YAC3C,mBAAmB;YACnB,IAAI,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,EAAE;gBAC9C,IAAI,CAAC,oBAAoB,CAAC,MAAM,GAAG,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;aAC5F;YACD,IAAI,QAAQ,EAAE;gBACZ,gFAAgF;gBAChF,qDAAqD;gBACrD,IAAM,QAAQ,GAAI,IAAI,CAAC,OAA2B,CAAC,KAAK,CAAC,OAAO,CAAoB,CAAC;gBACrF,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;gBAC/B,KAAK,CAAC,IAAI,CAAC,oBAAoB,EAAE;oBAC/B,KAAK,EAAE,QAAQ,CAAC,KAAK;oBACrB,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,MAAM,EAAE,QAAQ,CAAC,MAAM;iBACxB,CAAC,CAAC;gBACH,OAAO,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC;gBAC1C,QAAQ,CAAC,OAAO,EAAE,CAAC;aACpB;iBAAM,IAAI,IAAI,CAAC,oBAAoB,CAAC,WAAW,IAAI,IAAI,CAAC,oBAAoB,CAAC,KAAK,KAAK,SAAS,EAAE;gBACjG,wHAAwH;gBACxH,IAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC;gBACtE,IAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;gBACtD,IAAI,CAAC,oBAAoB,CAAC,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE,GAAG,QAAQ,CAAC;aAC3D;SACF;IACH,CAAC;IAED;;OAEG;IACO,yCAAY,GAAtB;QACE,KAAK,IAAM,QAAQ,IAAI,IAAI,CAAC,oBAAoB,EAAE;YAChD,IAAM,aAAa,GAAG,GAAG,CAAC,IAAI,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAC;YAC/D,IAAM,SAAS,GAAW,EAAE,CAAC;YAC7B,IAAI,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;YAC5B,IAAI,aAAa,YAAY,OAAO,EAAE;gBACpC,sEAAsE;gBACtE,qEAAqE;gBACrE,8BAA8B;gBAC9B,QAAQ,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;gBACvC,KAAK,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;aAClF;iBAAM;gBACL,GAAG,CAAC,SAAS,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC;aACzC;YACD,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC,kDAAkD;SAC9F;IACH,CAAC;IACH,yBAAC;AAAD,CAAC,AAlJD,IAkJC"}

package/dist/lib-es6/api/classes/variant.d.ts

@@ -0,0 +1,234 @@
+import { AssetContainer } from '@babylonjs/core/assetContainer';
+import { Light } from '@babylonjs/core/Lights/light';
+import '@babylonjs/core/Loading/Plugins/babylonFileLoader';
+import { Material } from '@babylonjs/core/Materials/material';
+import { Mesh } from '@babylonjs/core/Meshes/mesh';
+import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
+import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_draco_mesh_compression';
+import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_texture_transform';
+import '@babylonjs/loaders/glTF/2.0/glTFLoader';
+import { DottedPath } from './dottedPath';
+import { Element } from './element';
+import { Parameterizable } from './parameterizable';
+import { ParameterObservable } from './parameterObservable';
+import { VariantParameterizable } from './variantParameterizable';
+import { Viewer } from './viewer';
+import { ViewerLight } from './viewerLight';
+import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_texture_basisu';
+import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_materials_clearcoat';
+import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_materials_sheen';
+import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_materials_ior';
+import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_materials_pbrSpecularGlossiness';
+import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_materials_specular';
+import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_materials_translucency';
+import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_materials_transmission';
+import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_materials_unlit';
+import '@babylonjs/loaders/glTF/2.0/Extensions/KHR_materials_variants';
+/**
+ * A concrete "Variant". Most of these are handled by either the {@link Viewer} or {@link VariantInstance}.
+ */
+export declare class Variant extends Parameterizable {
+    readonly name: string;
+    protected readonly _structureJson: StructureJson;
+    readonly viewer: Viewer;
+    readonly parent?: Variant | undefined;
+    assetContainer: AssetContainer;
+    readonly elements: Element[];
+    readonly viewerLights: ViewerLight[];
+    structureJson: StructureJson;
+    protected _dottedNodes: Map<DottedPath, TransformNode> | undefined;
+    protected readonly _children: Map<string, Variant>;
+    protected readonly _parameterObservers: Map<string, ParameterObserver[]>;
+    /**
+     * @internal
+     */
+    private parametersInitialized;
+    /**
+     * Constructor.
+     */
+    protected constructor(name: string, _structureJson: StructureJson, viewer: Viewer, parent?: Variant | undefined);
+    /**
+     * Creates a {@link Variant} based on given parameters.
+     *
+     * @throws Error if "gltf" property is provided without a filename
+     */
+    static create(name: string, structureJson: StructureJson, viewer: Viewer, parent?: Variant): Promise<Variant>;
+    /**
+     * The ancestor {@link Variant}s ordered from top to bottom in the built tree.
+     */
+    get ancestors(): Variant[];
+    /**
+     * The root {@link Variant}.
+     */
+    get root(): Variant;
+    /**
+     * The {@link DottedPath} in the built tree of {@link Variant}s.
+     * E.g. "_.top-1.sub-2.sub-sub-3"
+     */
+    get dottedPath(): DottedPath;
+    /**
+     * The id representing a {@link DottedPath}.
+     */
+    get id(): string;
+    /**
+     * The defined glTF Asset.
+     */
+    get glTF(): Asset | undefined;
+    /**
+     * The defined glTF URI.
+     */
+    get glTFUri(): string | undefined;
+    /**
+     * The inherited defined glTF URI.
+     */
+    get inheritedGlTFUri(): string | undefined;
+    /**
+     * The TransformNodes of the {@link Variant}.
+     */
+    get nodes(): TransformNode[];
+    /**
+     * The {@link ViewerLight}s of the {@link Variant}.
+     */
+    get lights(): Light[];
+    /**
+     * All TransformNodes of the {@link Variant} mapped flat with a {@link DottedPath}.
+     */
+    get dottedNodes(): Map<DottedPath, TransformNode>;
+    /**
+     * The Materials of the {@link Variant}.
+     */
+    get materials(): Material[];
+    /**
+     * All {@link Element}s from this {@link Variant}'s parents.
+     */
+    get inheritedElements(): Element[];
+    /**
+     * All {@link ViewerLight}s inherited from this {@link Variant}'s parents.
+     */
+    get inheritedViewerLights(): ViewerLight[];
+    /**
+     * All TransformNodes inherited from this {@link Variant}'s parents.
+     */
+    get inheritedNodes(): TransformNode[];
+    /**
+     * All TransformNodes inherited from this {@link Variant}'s parents mapped flat with a {@link DottedPath}.
+     */
+    get inheritedDottedNodes(): Map<DottedPath, TransformNode>;
+    /**
+     * All Lights inherited from this {@link Variant}'s parents.
+     */
+    get inheritedLights(): Light[];
+    /**
+     * The {@link ParameterDeclarations} inherited from this {@link Variant}'s parents.
+     */
+    get inheritedParameterDeclaration(): ParameterDeclarations;
+    /**
+     * The {@link ParameterBag} inherited from this {@link Variant}'s parents.
+     */
+    get inheritedParameters(): ParameterBag;
+    /**
+     * All Materials from this {@link Variant}'s parents.
+     */
+    get inheritedMaterials(): Material[];
+    /**
+     * Gets the direct children of the current {@link Variant}.
+     */
+    getChildren(): Promise<Variant[]>;
+    /**
+     *  Gets a descendant {@link Variant} of the current {@link Variant} relative to its {@link DottedPath}.
+     *  If you have the dotted path `_.product_x.variant_blue.with_yellow_highlight` in a tree and you operate on the
+     *  `product_x`, you can call `this.getDescendant('variant_blue.with_yellow_highlight')` to get the lowermost
+     *  {@link Variant}.
+     */
+    getDescendant(dottedPath: DottedPathArgument): Promise<Variant>;
+    /**
+     * Gets the desired {@link Element} of the current {@link Variant} relative to its {@link DottedPath}.
+     * Uses the mechanism of {@link getDescendant} to resolve the appropriate variant in tree.
+     */
+    getElement(dottedPath: DottedPathArgument): Promise<Element>;
+    /**
+     * Gets the desired {@link ViewerLight} of the current {@link Variant} relative to its {@link DottedPath}.
+     * Uses the mechanism of {@link getDescendant} to resolve the appropriate variant in tree.
+     */
+    getViewerLight(dottedPath: DottedPathArgument): Promise<ViewerLight>;
+    /**
+     * A proxy for directly getting a Node from an {@link Element} by its {@link DottedPath}s.
+     */
+    getNode(elementDottedPath: DottedPathArgument, nodeDottedPath: DottedPathArgument): Promise<TransformNode>;
+    /**
+     * A proxy for directly getting a Mesh from an {@link Element} by its {@link DottedPath}s.
+     */
+    getMesh(elementDottedPath: DottedPathArgument, meshDottedPath: DottedPathArgument): Promise<Mesh | null>;
+    /**
+     * Gets the Material defined in one of the variants glTFs by its id.
+     */
+    getMaterial(id: string): Material;
+    /**
+     * Creates a living clone of this {@link Variant}. Will clone all parent {@link Variant}s in tree.
+     *
+     * @emit {@link Event.VARIANT_CREATED}
+     * @ignore
+     */
+    createLiving(parameters?: ParameterBag): Promise<Variant>;
+    /**
+     * Destroys this {@link Variant}, all parents and destroy the {@link Element}s.
+     */
+    destroy(): Variant;
+    /**
+     * Places the given {@link ParameterBag} in the {@link Variant}'s parameters, replaces all patterns in the
+     * {@link StructureJson}, broadcasts all {@link ParameterObserver}s and delegates them to its {@link Element}s.
+     *
+     * @emit {@link Event.VARIANT_PARAMETER_COMMITTED}
+     */
+    commitParameters(parameters?: ParameterBag): Promise<Variant>;
+    /**
+     * Adds an observer function for camera matrix changes for given `dottedPath` representing the {@link Element}
+     * and the `traceable`. The `observer` gets 2 parameters: the `AbstractMesh` and a `ClientRect` object.
+     */
+    addTraceableObserver(dottedPath: DottedPathArgument, observer: CallableFunction, payload?: any): Promise<Element>;
+    /**
+     * Loads {@link glTFUri} with assets, adds them to the {@link Variant}'s `assetContainer` and deactivates the meshes.
+     * (for further processing).
+     * @emits {@link Event.ASSET_LOADING_START}
+     * @emits {@link Event.ASSET_LOADING_END}
+     */
+    protected loadAssets(): Promise<Variant>;
+    /**
+     * Commits given parameters to all {@link Element}s.
+     */
+    protected commitParametersToElements(parameters: ParameterBag): Promise<void>;
+    /**
+     * Commits given parameters to all {@link ViewerLight}s.
+     */
+    protected commitParametersToViewerLights(parameters: ParameterBag): Promise<void>;
+    /**
+     * Commits given parameters to a {@link VariantParameterizable} and updates the according definition with given
+     * key in the {@link StructureJson}. The `definitionKey` "elements" for example will update the definition in
+     * `this.structureJson.elements`.
+     */
+    protected commitParametersToVariantParameterizable(parameters: ParameterBag, parameterizable: VariantParameterizable, definitionKey: string): Promise<ParameterObservable>;
+    /**
+     * Commits given {@link Parameter} to the {@link Variant}'s {@link Element}s.
+     */
+    protected commitParameterToElements(parameter: string, value: ParameterValue): Promise<Variant>;
+    /**
+     * Commits given {@link Parameter} to the {@link Variant}'s {@link Element}s.
+     */
+    protected commitParameterToViewerLights(parameter: string, value: ParameterValue): Promise<Variant>;
+    /**
+     * Adds the default {@link ParameterObserver}s which are called every time {@link commitParameters} is called.
+     */
+    protected addParameterObservers(): Variant;
+    /**
+     * Creates {@link Element}s and clones nodes into them.
+     */
+    protected createElements(): Promise<Variant>;
+    /**
+     * Creates {@link ViewerLight}s.
+     */
+    protected createViewerLights(): Promise<Variant>;
+    /**
+     * Bootstrapping for parameters. It sets the `parametersInitialized` to true for all ancestors.
+     */
+    protected bootstrapParameters(parameters?: ParameterBag): Promise<Variant>;
+}