@combeenation/3d-viewer 7.0.0 → 7.1.0

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

@@ -1,177 +1,177 @@
-"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());
-    });
-};
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PlacementAnimation = void 0;
-const parameter_1 = require("../classes/parameter");
-const specStorage_1 = require("../store/specStorage");
-const arcRotateCamera_1 = require("@babylonjs/core/Cameras/arcRotateCamera");
-const math_vector_1 = require("@babylonjs/core/Maths/math.vector");
-const gsap_1 = require("gsap");
-const lodash_es_1 = require("lodash-es");
-/**
- * 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.
- */
-class PlacementAnimation {
-    /**
-     * Constructor.
-     */
-    constructor(mutable, _placement, _animation) {
-        var _a;
-        this.mutable = mutable;
-        this._placement = _placement;
-        this._animation = _animation;
-        if ((0, lodash_es_1.isString)(_placement)) {
-            const placementDefinitions = specStorage_1.SpecStorage.get('scene.placements');
-            if (!placementDefinitions) {
-                throw new Error(`No PlacementDefinitions defined in JSON structure.`);
-            }
-            const placementDefinition = placementDefinitions[_placement];
-            if (!placementDefinition) {
-                throw new Error(`PlacementDefinition "${_placement}" not defined in JSON structure.`);
-            }
-            this._placementDefinition = (0, lodash_es_1.cloneDeep)(placementDefinition);
-        }
-        else {
-            this._placementDefinition = (0, lodash_es_1.cloneDeep)(_placement);
-        }
-        if ((0, lodash_es_1.isString)(_animation)) {
-            const animationDefinition = (_a = specStorage_1.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 = (0, lodash_es_1.cloneDeep)(animationDefinition);
-        }
-        else {
-            this._animationDefinition = (0, lodash_es_1.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
-        const _b = this._animationDefinition, { shortestWay } = _b, gsapTweenVars = __rest(_b, ["shortestWay"]);
-        this._timeline = gsap_1.gsap.timeline({
-            defaults: gsapTweenVars,
-            paused: true,
-        });
-        this.preparePlacementDefinition();
-        this.createTweens();
-    }
-    /**
-     * Plays all `Tweens` of this {@link PlacementAnimation}.
-     */
-    play() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this._timeline.play().then();
-            return this;
-        });
-    }
-    /**
-     * Pause all `Tweens` of this {@link PlacementAnimation}.
-     */
-    pause() {
-        this._timeline.pause();
-        return this;
-    }
-    /**
-     * Kills all `Tweens` of this {@link PlacementAnimation}.
-     */
-    kill() {
-        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.
-     */
-    prepareAnimationDefinition() {
-        // 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_1.Parameter.parseBoolean(this._animationDefinition.shortestWay);
-        }
-        else {
-            this._animationDefinition.shortestWay = true;
-        }
-    }
-    /**
-     * Prepares different types of {@link PlacementDefinition} and sets some defaults.
-     */
-    preparePlacementDefinition() {
-        let position = this._placementDefinition.position;
-        if ((0, lodash_es_1.isString)(position)) {
-            position = parameter_1.Parameter.parseVector(position);
-            this._placementDefinition.position = position;
-        }
-        if (this.mutable instanceof arcRotateCamera_1.ArcRotateCamera) {
-            // parse the target
-            if ((0, lodash_es_1.isString)(this._placementDefinition.target)) {
-                this._placementDefinition.target = parameter_1.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
-                const ghostCam = this.mutable.clone('ghost');
-                ghostCam.setPosition(position);
-                (0, lodash_es_1.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
-                const alphaGap = this.mutable.alpha - this._placementDefinition.alpha;
-                const 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}.
-     */
-    createTweens() {
-        for (const property in this._placementDefinition) {
-            const propertyValue = (0, lodash_es_1.get)(this._placementDefinition, property);
-            const tweenVars = {};
-            let _mutable = this.mutable;
-            if (propertyValue instanceof math_vector_1.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 = (0, lodash_es_1.get)(this.mutable, property);
-                (0, lodash_es_1.merge)(tweenVars, { x: propertyValue.x, y: propertyValue.y, z: propertyValue.z });
-            }
-            else {
-                (0, lodash_es_1.set)(tweenVars, property, propertyValue);
-            }
-            this._timeline.to(_mutable, tweenVars, 0); // Note: position 0 does the "parallel" stuff here
-        }
-    }
-}
-exports.PlacementAnimation = PlacementAnimation;
+"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());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlacementAnimation = void 0;
+const parameter_1 = require("../classes/parameter");
+const specStorage_1 = require("../store/specStorage");
+const arcRotateCamera_1 = require("@babylonjs/core/Cameras/arcRotateCamera");
+const math_vector_1 = require("@babylonjs/core/Maths/math.vector");
+const gsap_1 = require("gsap");
+const lodash_es_1 = require("lodash-es");
+/**
+ * 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.
+ */
+class PlacementAnimation {
+    /**
+     * Constructor.
+     */
+    constructor(mutable, _placement, _animation) {
+        var _a;
+        this.mutable = mutable;
+        this._placement = _placement;
+        this._animation = _animation;
+        if ((0, lodash_es_1.isString)(_placement)) {
+            const placementDefinitions = specStorage_1.SpecStorage.get('scene.placements');
+            if (!placementDefinitions) {
+                throw new Error(`No PlacementDefinitions defined in JSON structure.`);
+            }
+            const placementDefinition = placementDefinitions[_placement];
+            if (!placementDefinition) {
+                throw new Error(`PlacementDefinition "${_placement}" not defined in JSON structure.`);
+            }
+            this._placementDefinition = (0, lodash_es_1.cloneDeep)(placementDefinition);
+        }
+        else {
+            this._placementDefinition = (0, lodash_es_1.cloneDeep)(_placement);
+        }
+        if ((0, lodash_es_1.isString)(_animation)) {
+            const animationDefinition = (_a = specStorage_1.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 = (0, lodash_es_1.cloneDeep)(animationDefinition);
+        }
+        else {
+            this._animationDefinition = (0, lodash_es_1.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
+        const _b = this._animationDefinition, { shortestWay } = _b, gsapTweenVars = __rest(_b, ["shortestWay"]);
+        this._timeline = gsap_1.gsap.timeline({
+            defaults: gsapTweenVars,
+            paused: true,
+        });
+        this.preparePlacementDefinition();
+        this.createTweens();
+    }
+    /**
+     * Plays all `Tweens` of this {@link PlacementAnimation}.
+     */
+    play() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this._timeline.play().then();
+            return this;
+        });
+    }
+    /**
+     * Pause all `Tweens` of this {@link PlacementAnimation}.
+     */
+    pause() {
+        this._timeline.pause();
+        return this;
+    }
+    /**
+     * Kills all `Tweens` of this {@link PlacementAnimation}.
+     */
+    kill() {
+        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.
+     */
+    prepareAnimationDefinition() {
+        // 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_1.Parameter.parseBoolean(this._animationDefinition.shortestWay);
+        }
+        else {
+            this._animationDefinition.shortestWay = true;
+        }
+    }
+    /**
+     * Prepares different types of {@link PlacementDefinition} and sets some defaults.
+     */
+    preparePlacementDefinition() {
+        let position = this._placementDefinition.position;
+        if ((0, lodash_es_1.isString)(position)) {
+            position = parameter_1.Parameter.parseVector(position);
+            this._placementDefinition.position = position;
+        }
+        if (this.mutable instanceof arcRotateCamera_1.ArcRotateCamera) {
+            // parse the target
+            if ((0, lodash_es_1.isString)(this._placementDefinition.target)) {
+                this._placementDefinition.target = parameter_1.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
+                const ghostCam = this.mutable.clone('ghost');
+                ghostCam.setPosition(position);
+                (0, lodash_es_1.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
+                const alphaGap = this.mutable.alpha - this._placementDefinition.alpha;
+                const 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}.
+     */
+    createTweens() {
+        for (const property in this._placementDefinition) {
+            const propertyValue = (0, lodash_es_1.get)(this._placementDefinition, property);
+            const tweenVars = {};
+            let _mutable = this.mutable;
+            if (propertyValue instanceof math_vector_1.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 = (0, lodash_es_1.get)(this.mutable, property);
+                (0, lodash_es_1.merge)(tweenVars, { x: propertyValue.x, y: propertyValue.y, z: propertyValue.z });
+            }
+            else {
+                (0, lodash_es_1.set)(tweenVars, property, propertyValue);
+            }
+            this._timeline.to(_mutable, tweenVars, 0); // Note: position 0 does the "parallel" stuff here
+        }
+    }
+}
+exports.PlacementAnimation = PlacementAnimation;
 //# sourceMappingURL=placementAnimation.js.map