@babylonjs/viewer 7.31.0-alpha → 7.31.1

package/model/modelAnimation.d.ts

@@ -0,0 +1,215 @@
+import type { Vector3 } from "@babylonjs/core/Maths/math.vector.js";
+import type { AnimationGroup } from "@babylonjs/core/Animations/index.js";
+/**
+ * Animation play mode enum - is the animation looping or playing once
+ */
+export declare enum AnimationPlayMode {
+    ONCE = 0,
+    LOOP = 1
+}
+/**
+ * An enum representing the current state of an animation object
+ */
+export declare enum AnimationState {
+    INIT = 0,
+    PLAYING = 1,
+    PAUSED = 2,
+    STOPPED = 3,
+    ENDED = 4
+}
+/**
+ * The different type of easing functions available
+ */
+export declare enum EasingFunction {
+    Linear = 0,
+    CircleEase = 1,
+    BackEase = 2,
+    BounceEase = 3,
+    CubicEase = 4,
+    ElasticEase = 5,
+    ExponentialEase = 6,
+    PowerEase = 7,
+    QuadraticEase = 8,
+    QuarticEase = 9,
+    QuinticEase = 10,
+    SineEase = 11
+}
+/**
+ * Defines a simple animation to be applied to a model (scale).
+ */
+export interface ModelAnimationConfiguration {
+    /**
+     * Time of animation, in seconds
+     */
+    time: number;
+    /**
+     * Scale to apply
+     */
+    scaling?: Vector3;
+    /**
+     * Easing function to apply
+     * See SPECTRE.EasingFunction
+     */
+    easingFunction?: number;
+    /**
+     * An Easing mode to apply to the easing function
+     * See BABYLON.EasingFunction
+     */
+    easingMode?: number;
+}
+/**
+ * This interface can be implemented to define new types of ModelAnimation objects.
+ */
+export interface IModelAnimation {
+    /**
+     * Current animation state (playing, stopped etc')
+     */
+    readonly state: AnimationState;
+    /**
+     * the name of the animation
+     */
+    readonly name: string;
+    /**
+     * Get the max numbers of frame available in the animation group
+     *
+     * In correlation to an array, this would be ".length"
+     */
+    readonly frames: number;
+    /**
+     * Get the current frame playing right now.
+     * This can be used to poll the frame currently playing (and, for example, display a progress bar with the data)
+     *
+     * In correlation to an array, this would be the current index
+     */
+    readonly currentFrame: number;
+    /**
+     * Animation's FPS value
+     */
+    readonly fps: number;
+    /**
+     * Get or set the animation's speed ration (Frame-to-fps)
+     */
+    speedRatio: number;
+    /**
+     * Gets or sets the aimation's play mode.
+     */
+    playMode: AnimationPlayMode;
+    /**
+     * Start the animation
+     */
+    start(): void;
+    /**
+     * Stop the animation.
+     * This will fail silently if the animation group is already stopped.
+     */
+    stop(): void;
+    /**
+     * Pause the animation
+     * This will fail silently if the animation is not currently playing
+     */
+    pause(): void;
+    /**
+     * Reset this animation
+     */
+    reset(): void;
+    /**
+     * Restart the animation
+     */
+    restart(): void;
+    /**
+     * Go to a specific
+     * @param frameNumber the frame number to go to
+     */
+    goToFrame(frameNumber: number): void;
+    /**
+     * Dispose this animation
+     */
+    dispose(): void;
+}
+/**
+ * The GroupModelAnimation is an implementation of the IModelAnimation interface using BABYLON's
+ * native GroupAnimation class.
+ */
+export declare class GroupModelAnimation implements IModelAnimation {
+    private _animationGroup;
+    private _playMode;
+    private _state;
+    /**
+     * Create a new GroupModelAnimation object using an AnimationGroup object
+     * @param _animationGroup The animation group to base the class on
+     */
+    constructor(_animationGroup: AnimationGroup);
+    /**
+     * Get the animation's name
+     */
+    get name(): string;
+    /**
+     * Get the current animation's state
+     */
+    get state(): AnimationState;
+    /**
+     * Gets the speed ratio to use for all animations
+     */
+    get speedRatio(): number;
+    /**
+     * Sets the speed ratio to use for all animations
+     */
+    set speedRatio(value: number);
+    /**
+     * Get the max numbers of frame available in the animation group
+     *
+     * In correlation to an array, this would be ".length"
+     */
+    get frames(): number;
+    /**
+     * Get the current frame playing right now.
+     * This can be used to poll the frame currently playing (and, for example, display a progress bar with the data)
+     *
+     * In correlation to an array, this would be the current index
+     */
+    get currentFrame(): number;
+    /**
+     * Get the FPS value of this animation
+     */
+    get fps(): number;
+    /**
+     * What is the animation'S play mode (looping or played once)
+     */
+    get playMode(): AnimationPlayMode;
+    /**
+     * Set the play mode.
+     * If the animation is played, it will continue playing at least once more, depending on the new play mode set.
+     * If the animation is not set, the will be initialized and will wait for the user to start playing it.
+     */
+    set playMode(value: AnimationPlayMode);
+    /**
+     * Reset the animation group
+     */
+    reset(): void;
+    /**
+     * Restart the animation group
+     */
+    restart(): void;
+    /**
+     *
+     * @param frameNumber Go to a specific frame in the animation
+     */
+    goToFrame(frameNumber: number): void;
+    /**
+     * Start playing the animation.
+     */
+    start(): void;
+    /**
+     * Pause the animation
+     */
+    pause(): void;
+    /**
+     * Stop the animation.
+     * This will fail silently if the animation group is already stopped.
+     */
+    stop(): void;
+    /**
+     * Dispose this animation object.
+     */
+    dispose(): void;
+}

package/model/modelAnimation.js

@@ -0,0 +1,237 @@
+/**
+ * Animation play mode enum - is the animation looping or playing once
+ */
+export var AnimationPlayMode;
+(function (AnimationPlayMode) {
+    AnimationPlayMode[AnimationPlayMode["ONCE"] = 0] = "ONCE";
+    AnimationPlayMode[AnimationPlayMode["LOOP"] = 1] = "LOOP";
+})(AnimationPlayMode || (AnimationPlayMode = {}));
+/**
+ * An enum representing the current state of an animation object
+ */
+export var AnimationState;
+(function (AnimationState) {
+    AnimationState[AnimationState["INIT"] = 0] = "INIT";
+    AnimationState[AnimationState["PLAYING"] = 1] = "PLAYING";
+    AnimationState[AnimationState["PAUSED"] = 2] = "PAUSED";
+    AnimationState[AnimationState["STOPPED"] = 3] = "STOPPED";
+    AnimationState[AnimationState["ENDED"] = 4] = "ENDED";
+})(AnimationState || (AnimationState = {}));
+/**
+ * The different type of easing functions available
+ */
+export var EasingFunction;
+(function (EasingFunction) {
+    EasingFunction[EasingFunction["Linear"] = 0] = "Linear";
+    EasingFunction[EasingFunction["CircleEase"] = 1] = "CircleEase";
+    EasingFunction[EasingFunction["BackEase"] = 2] = "BackEase";
+    EasingFunction[EasingFunction["BounceEase"] = 3] = "BounceEase";
+    EasingFunction[EasingFunction["CubicEase"] = 4] = "CubicEase";
+    EasingFunction[EasingFunction["ElasticEase"] = 5] = "ElasticEase";
+    EasingFunction[EasingFunction["ExponentialEase"] = 6] = "ExponentialEase";
+    EasingFunction[EasingFunction["PowerEase"] = 7] = "PowerEase";
+    EasingFunction[EasingFunction["QuadraticEase"] = 8] = "QuadraticEase";
+    EasingFunction[EasingFunction["QuarticEase"] = 9] = "QuarticEase";
+    EasingFunction[EasingFunction["QuinticEase"] = 10] = "QuinticEase";
+    EasingFunction[EasingFunction["SineEase"] = 11] = "SineEase";
+})(EasingFunction || (EasingFunction = {}));
+/**
+ * The GroupModelAnimation is an implementation of the IModelAnimation interface using BABYLON's
+ * native GroupAnimation class.
+ */
+var GroupModelAnimation = /** @class */ (function () {
+    /**
+     * Create a new GroupModelAnimation object using an AnimationGroup object
+     * @param _animationGroup The animation group to base the class on
+     */
+    function GroupModelAnimation(_animationGroup) {
+        var _this = this;
+        this._animationGroup = _animationGroup;
+        this._state = AnimationState.INIT;
+        this._playMode = AnimationPlayMode.LOOP;
+        this._animationGroup.onAnimationEndObservable.add(function () {
+            _this._state = AnimationState.ENDED;
+            _this.stop();
+        });
+    }
+    Object.defineProperty(GroupModelAnimation.prototype, "name", {
+        /**
+         * Get the animation's name
+         */
+        get: function () {
+            return this._animationGroup.name;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(GroupModelAnimation.prototype, "state", {
+        /**
+         * Get the current animation's state
+         */
+        get: function () {
+            return this._state;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(GroupModelAnimation.prototype, "speedRatio", {
+        /**
+         * Gets the speed ratio to use for all animations
+         */
+        get: function () {
+            return this._animationGroup.speedRatio;
+        },
+        /**
+         * Sets the speed ratio to use for all animations
+         */
+        set: function (value) {
+            this._animationGroup.speedRatio = value;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(GroupModelAnimation.prototype, "frames", {
+        /**
+         * Get the max numbers of frame available in the animation group
+         *
+         * In correlation to an array, this would be ".length"
+         */
+        get: function () {
+            return this._animationGroup.to - this._animationGroup.from;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(GroupModelAnimation.prototype, "currentFrame", {
+        /**
+         * Get the current frame playing right now.
+         * This can be used to poll the frame currently playing (and, for example, display a progress bar with the data)
+         *
+         * In correlation to an array, this would be the current index
+         */
+        get: function () {
+            if (this._animationGroup.targetedAnimations[0] && this._animationGroup.targetedAnimations[0].animation.runtimeAnimations[0]) {
+                return this._animationGroup.targetedAnimations[0].animation.runtimeAnimations[0].currentFrame - this._animationGroup.from;
+            }
+            else {
+                return 0;
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(GroupModelAnimation.prototype, "fps", {
+        /**
+         * Get the FPS value of this animation
+         */
+        get: function () {
+            // get the first currentFrame found
+            for (var i = 0; i < this._animationGroup.animatables.length; ++i) {
+                var animatable = this._animationGroup.animatables[i];
+                var animations = animatable.getAnimations();
+                if (!animations || !animations.length) {
+                    continue;
+                }
+                for (var idx = 0; idx < animations.length; ++idx) {
+                    if (animations[idx].animation && animations[idx].animation.framePerSecond) {
+                        return animations[idx].animation.framePerSecond;
+                    }
+                }
+            }
+            return 0;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(GroupModelAnimation.prototype, "playMode", {
+        /**
+         * What is the animation'S play mode (looping or played once)
+         */
+        get: function () {
+            return this._playMode;
+        },
+        /**
+         * Set the play mode.
+         * If the animation is played, it will continue playing at least once more, depending on the new play mode set.
+         * If the animation is not set, the will be initialized and will wait for the user to start playing it.
+         */
+        set: function (value) {
+            if (value === this._playMode) {
+                return;
+            }
+            this._playMode = value;
+            if (this.state === AnimationState.PLAYING) {
+                this._animationGroup.play(this._playMode === AnimationPlayMode.LOOP);
+            }
+            else {
+                this._animationGroup.reset();
+                this._state = AnimationState.INIT;
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Reset the animation group
+     */
+    GroupModelAnimation.prototype.reset = function () {
+        this._animationGroup.reset();
+    };
+    /**
+     * Restart the animation group
+     */
+    GroupModelAnimation.prototype.restart = function () {
+        if (this.state === AnimationState.PAUSED) {
+            this._animationGroup.restart();
+        }
+        else {
+            this.start();
+        }
+    };
+    /**
+     *
+     * @param frameNumber Go to a specific frame in the animation
+     */
+    GroupModelAnimation.prototype.goToFrame = function (frameNumber) {
+        this._animationGroup.goToFrame(frameNumber + this._animationGroup.from);
+    };
+    /**
+     * Start playing the animation.
+     */
+    GroupModelAnimation.prototype.start = function () {
+        this._animationGroup.start(this.playMode === AnimationPlayMode.LOOP, this.speedRatio);
+        if (this._animationGroup.isStarted) {
+            this._state = AnimationState.PLAYING;
+        }
+    };
+    /**
+     * Pause the animation
+     */
+    GroupModelAnimation.prototype.pause = function () {
+        this._animationGroup.pause();
+        this._state = AnimationState.PAUSED;
+    };
+    /**
+     * Stop the animation.
+     * This will fail silently if the animation group is already stopped.
+     */
+    GroupModelAnimation.prototype.stop = function () {
+        // do not trigger stop if animation state is ended.
+        if (this._state === AnimationState.ENDED) {
+            return;
+        }
+        this._animationGroup.stop();
+        if (!this._animationGroup.isStarted) {
+            this._state = AnimationState.STOPPED;
+        }
+    };
+    /**
+     * Dispose this animation object.
+     */
+    GroupModelAnimation.prototype.dispose = function () {
+        this._animationGroup.dispose();
+    };
+    return GroupModelAnimation;
+}());
+export { GroupModelAnimation };
+//# sourceMappingURL=modelAnimation.js.map

package/model/modelAnimation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modelAnimation.js","sourceRoot":"","sources":["../../../../tools/viewer/src/model/modelAnimation.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,CAAN,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IACzB,yDAAI,CAAA;IACJ,yDAAI,CAAA;AACR,CAAC,EAHW,iBAAiB,KAAjB,iBAAiB,QAG5B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cAMX;AAND,WAAY,cAAc;IACtB,mDAAI,CAAA;IACJ,yDAAO,CAAA;IACP,uDAAM,CAAA;IACN,yDAAO,CAAA;IACP,qDAAK,CAAA;AACT,CAAC,EANW,cAAc,KAAd,cAAc,QAMzB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cAaX;AAbD,WAAY,cAAc;IACtB,uDAAU,CAAA;IACV,+DAAc,CAAA;IACd,2DAAY,CAAA;IACZ,+DAAc,CAAA;IACd,6DAAa,CAAA;IACb,iEAAe,CAAA;IACf,yEAAmB,CAAA;IACnB,6DAAa,CAAA;IACb,qEAAiB,CAAA;IACjB,iEAAe,CAAA;IACf,kEAAgB,CAAA;IAChB,4DAAa,CAAA;AACjB,CAAC,EAbW,cAAc,KAAd,cAAc,QAazB;AAmGD;;;GAGG;AACH;IAII;;;OAGG;IACH,6BAAoB,eAA+B;QAAnD,iBAQC;QARmB,oBAAe,GAAf,eAAe,CAAgB;QAC/C,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC;QAClC,IAAI,CAAC,SAAS,GAAG,iBAAiB,CAAC,IAAI,CAAC;QAExC,IAAI,CAAC,eAAe,CAAC,wBAAwB,CAAC,GAAG,CAAC;YAC9C,KAAI,CAAC,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC;YACnC,KAAI,CAAC,IAAI,EAAE,CAAC;QAChB,CAAC,CAAC,CAAC;IACP,CAAC;IAKD,sBAAW,qCAAI;QAHf;;WAEG;aACH;YACI,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;QACrC,CAAC;;;OAAA;IAKD,sBAAW,sCAAK;QAHhB;;WAEG;aACH;YACI,OAAO,IAAI,CAAC,MAAM,CAAC;QACvB,CAAC;;;OAAA;IAKD,sBAAW,2CAAU;QAHrB;;WAEG;aACH;YACI,OAAO,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC;QAC3C,CAAC;QAED;;WAEG;aACH,UAAsB,KAAa;YAC/B,IAAI,CAAC,eAAe,CAAC,UAAU,GAAG,KAAK,CAAC;QAC5C,CAAC;;;OAPA;IAcD,sBAAW,uCAAM;QALjB;;;;WAIG;aACH;YACI,OAAO,IAAI,CAAC,eAAe,CAAC,EAAE,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;QAC/D,CAAC;;;OAAA;IAQD,sBAAW,6CAAY;QANvB;;;;;WAKG;aACH;YACI,IAAI,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE;gBACzH,OAAO,IAAI,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,YAAY,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;aAC7H;iBAAM;gBACH,OAAO,CAAC,CAAC;aACZ;QACL,CAAC;;;OAAA;IAKD,sBAAW,oCAAG;QAHd;;WAEG;aACH;YACI,mCAAmC;YACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;gBAC9D,IAAM,UAAU,GAAe,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;gBACnE,IAAM,UAAU,GAAG,UAAU,CAAC,aAAa,EAAE,CAAC;gBAC9C,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE;oBACnC,SAAS;iBACZ;gBACD,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,UAAU,CAAC,MAAM,EAAE,EAAE,GAAG,EAAE;oBAC9C,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,IAAI,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,cAAc,EAAE;wBACvE,OAAO,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC;qBACnD;iBACJ;aACJ;YACD,OAAO,CAAC,CAAC;QACb,CAAC;;;OAAA;IAKD,sBAAW,yCAAQ;QAHnB;;WAEG;aACH;YACI,OAAO,IAAI,CAAC,SAAS,CAAC;QAC1B,CAAC;QAED;;;;WAIG;aACH,UAAoB,KAAwB;YACxC,IAAI,KAAK,KAAK,IAAI,CAAC,SAAS,EAAE;gBAC1B,OAAO;aACV;YAED,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;YAEvB,IAAI,IAAI,CAAC,KAAK,KAAK,cAAc,CAAC,OAAO,EAAE;gBACvC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,KAAK,iBAAiB,CAAC,IAAI,CAAC,CAAC;aACxE;iBAAM;gBACH,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;gBAC7B,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC;aACrC;QACL,CAAC;;;OApBA;IAsBD;;OAEG;IACH,mCAAK,GAAL;QACI,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,qCAAO,GAAP;QACI,IAAI,IAAI,CAAC,KAAK,KAAK,cAAc,CAAC,MAAM,EAAE;YACtC,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;SAClC;aAAM;YACH,IAAI,CAAC,KAAK,EAAE,CAAC;SAChB;IACL,CAAC;IAED;;;OAGG;IACH,uCAAS,GAAT,UAAU,WAAmB;QACzB,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACI,mCAAK,GAAZ;QACI,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,KAAK,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACtF,IAAI,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE;YAChC,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC,OAAO,CAAC;SACxC;IACL,CAAC;IAED;;OAEG;IACH,mCAAK,GAAL;QACI,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAC7B,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC;IACxC,CAAC;IAED;;;OAGG;IACI,kCAAI,GAAX;QACI,mDAAmD;QACnD,IAAI,IAAI,CAAC,MAAM,KAAK,cAAc,CAAC,KAAK,EAAE;YACtC,OAAO;SACV;QACD,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;QAC5B,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE;YACjC,IAAI,CAAC,MAAM,GAAG,cAAc,CAAC,OAAO,CAAC;SACxC;IACL,CAAC;IAED;;OAEG;IACI,qCAAO,GAAd;QACI,IAAI,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC;IACnC,CAAC;IACL,0BAAC;AAAD,CAAC,AArLD,IAqLC","sourcesContent":["import type { Vector3 } from \"core/Maths/math.vector\";\r\n// eslint-disable-next-line import/no-internal-modules\r\nimport type { AnimationGroup, Animatable } from \"core/Animations/index\";\r\n\r\n/**\r\n * Animation play mode enum - is the animation looping or playing once\r\n */\r\nexport enum AnimationPlayMode {\r\n    ONCE,\r\n    LOOP,\r\n}\r\n\r\n/**\r\n * An enum representing the current state of an animation object\r\n */\r\nexport enum AnimationState {\r\n    INIT,\r\n    PLAYING,\r\n    PAUSED,\r\n    STOPPED,\r\n    ENDED,\r\n}\r\n\r\n/**\r\n * The different type of easing functions available\r\n */\r\nexport enum EasingFunction {\r\n    Linear = 0,\r\n    CircleEase = 1,\r\n    BackEase = 2,\r\n    BounceEase = 3,\r\n    CubicEase = 4,\r\n    ElasticEase = 5,\r\n    ExponentialEase = 6,\r\n    PowerEase = 7,\r\n    QuadraticEase = 8,\r\n    QuarticEase = 9,\r\n    QuinticEase = 10,\r\n    SineEase = 11,\r\n}\r\n\r\n/**\r\n * Defines a simple animation to be applied to a model (scale).\r\n */\r\nexport interface ModelAnimationConfiguration {\r\n    /**\r\n     * Time of animation, in seconds\r\n     */\r\n    time: number;\r\n\r\n    /**\r\n     * Scale to apply\r\n     */\r\n    scaling?: Vector3;\r\n\r\n    /**\r\n     * Easing function to apply\r\n     * See SPECTRE.EasingFunction\r\n     */\r\n    easingFunction?: number;\r\n\r\n    /**\r\n     * An Easing mode to apply to the easing function\r\n     * See BABYLON.EasingFunction\r\n     */\r\n    easingMode?: number;\r\n}\r\n\r\n/**\r\n * This interface can be implemented to define new types of ModelAnimation objects.\r\n */\r\nexport interface IModelAnimation {\r\n    /**\r\n     * Current animation state (playing, stopped etc')\r\n     */\r\n    readonly state: AnimationState;\r\n    /**\r\n     * the name of the animation\r\n     */\r\n    readonly name: string;\r\n    /**\r\n     * Get the max numbers of frame available in the animation group\r\n     *\r\n     * In correlation to an array, this would be \".length\"\r\n     */\r\n    readonly frames: number;\r\n    /**\r\n     * Get the current frame playing right now.\r\n     * This can be used to poll the frame currently playing (and, for example, display a progress bar with the data)\r\n     *\r\n     * In correlation to an array, this would be the current index\r\n     */\r\n    readonly currentFrame: number;\r\n    /**\r\n     * Animation's FPS value\r\n     */\r\n    readonly fps: number;\r\n    /**\r\n     * Get or set the animation's speed ration (Frame-to-fps)\r\n     */\r\n    speedRatio: number;\r\n    /**\r\n     * Gets or sets the aimation's play mode.\r\n     */\r\n    playMode: AnimationPlayMode;\r\n    /**\r\n     * Start the animation\r\n     */\r\n    start(): void;\r\n    /**\r\n     * Stop the animation.\r\n     * This will fail silently if the animation group is already stopped.\r\n     */\r\n    stop(): void;\r\n    /**\r\n     * Pause the animation\r\n     * This will fail silently if the animation is not currently playing\r\n     */\r\n    pause(): void;\r\n    /**\r\n     * Reset this animation\r\n     */\r\n    reset(): void;\r\n    /**\r\n     * Restart the animation\r\n     */\r\n    restart(): void;\r\n    /**\r\n     * Go to a specific\r\n     * @param frameNumber the frame number to go to\r\n     */\r\n    goToFrame(frameNumber: number): void;\r\n    /**\r\n     * Dispose this animation\r\n     */\r\n    dispose(): void;\r\n}\r\n\r\n/**\r\n * The GroupModelAnimation is an implementation of the IModelAnimation interface using BABYLON's\r\n * native GroupAnimation class.\r\n */\r\nexport class GroupModelAnimation implements IModelAnimation {\r\n    private _playMode: AnimationPlayMode;\r\n    private _state: AnimationState;\r\n\r\n    /**\r\n     * Create a new GroupModelAnimation object using an AnimationGroup object\r\n     * @param _animationGroup The animation group to base the class on\r\n     */\r\n    constructor(private _animationGroup: AnimationGroup) {\r\n        this._state = AnimationState.INIT;\r\n        this._playMode = AnimationPlayMode.LOOP;\r\n\r\n        this._animationGroup.onAnimationEndObservable.add(() => {\r\n            this._state = AnimationState.ENDED;\r\n            this.stop();\r\n        });\r\n    }\r\n\r\n    /**\r\n     * Get the animation's name\r\n     */\r\n    public get name() {\r\n        return this._animationGroup.name;\r\n    }\r\n\r\n    /**\r\n     * Get the current animation's state\r\n     */\r\n    public get state() {\r\n        return this._state;\r\n    }\r\n\r\n    /**\r\n     * Gets the speed ratio to use for all animations\r\n     */\r\n    public get speedRatio(): number {\r\n        return this._animationGroup.speedRatio;\r\n    }\r\n\r\n    /**\r\n     * Sets the speed ratio to use for all animations\r\n     */\r\n    public set speedRatio(value: number) {\r\n        this._animationGroup.speedRatio = value;\r\n    }\r\n\r\n    /**\r\n     * Get the max numbers of frame available in the animation group\r\n     *\r\n     * In correlation to an array, this would be \".length\"\r\n     */\r\n    public get frames(): number {\r\n        return this._animationGroup.to - this._animationGroup.from;\r\n    }\r\n\r\n    /**\r\n     * Get the current frame playing right now.\r\n     * This can be used to poll the frame currently playing (and, for example, display a progress bar with the data)\r\n     *\r\n     * In correlation to an array, this would be the current index\r\n     */\r\n    public get currentFrame(): number {\r\n        if (this._animationGroup.targetedAnimations[0] && this._animationGroup.targetedAnimations[0].animation.runtimeAnimations[0]) {\r\n            return this._animationGroup.targetedAnimations[0].animation.runtimeAnimations[0].currentFrame - this._animationGroup.from;\r\n        } else {\r\n            return 0;\r\n        }\r\n    }\r\n\r\n    /**\r\n     * Get the FPS value of this animation\r\n     */\r\n    public get fps(): number {\r\n        // get the first currentFrame found\r\n        for (let i = 0; i < this._animationGroup.animatables.length; ++i) {\r\n            const animatable: Animatable = this._animationGroup.animatables[i];\r\n            const animations = animatable.getAnimations();\r\n            if (!animations || !animations.length) {\r\n                continue;\r\n            }\r\n            for (let idx = 0; idx < animations.length; ++idx) {\r\n                if (animations[idx].animation && animations[idx].animation.framePerSecond) {\r\n                    return animations[idx].animation.framePerSecond;\r\n                }\r\n            }\r\n        }\r\n        return 0;\r\n    }\r\n\r\n    /**\r\n     * What is the animation'S play mode (looping or played once)\r\n     */\r\n    public get playMode(): AnimationPlayMode {\r\n        return this._playMode;\r\n    }\r\n\r\n    /**\r\n     * Set the play mode.\r\n     * If the animation is played, it will continue playing at least once more, depending on the new play mode set.\r\n     * If the animation is not set, the will be initialized and will wait for the user to start playing it.\r\n     */\r\n    public set playMode(value: AnimationPlayMode) {\r\n        if (value === this._playMode) {\r\n            return;\r\n        }\r\n\r\n        this._playMode = value;\r\n\r\n        if (this.state === AnimationState.PLAYING) {\r\n            this._animationGroup.play(this._playMode === AnimationPlayMode.LOOP);\r\n        } else {\r\n            this._animationGroup.reset();\r\n            this._state = AnimationState.INIT;\r\n        }\r\n    }\r\n\r\n    /**\r\n     * Reset the animation group\r\n     */\r\n    reset() {\r\n        this._animationGroup.reset();\r\n    }\r\n\r\n    /**\r\n     * Restart the animation group\r\n     */\r\n    restart() {\r\n        if (this.state === AnimationState.PAUSED) {\r\n            this._animationGroup.restart();\r\n        } else {\r\n            this.start();\r\n        }\r\n    }\r\n\r\n    /**\r\n     *\r\n     * @param frameNumber Go to a specific frame in the animation\r\n     */\r\n    goToFrame(frameNumber: number) {\r\n        this._animationGroup.goToFrame(frameNumber + this._animationGroup.from);\r\n    }\r\n\r\n    /**\r\n     * Start playing the animation.\r\n     */\r\n    public start() {\r\n        this._animationGroup.start(this.playMode === AnimationPlayMode.LOOP, this.speedRatio);\r\n        if (this._animationGroup.isStarted) {\r\n            this._state = AnimationState.PLAYING;\r\n        }\r\n    }\r\n\r\n    /**\r\n     * Pause the animation\r\n     */\r\n    pause() {\r\n        this._animationGroup.pause();\r\n        this._state = AnimationState.PAUSED;\r\n    }\r\n\r\n    /**\r\n     * Stop the animation.\r\n     * This will fail silently if the animation group is already stopped.\r\n     */\r\n    public stop() {\r\n        // do not trigger stop if animation state is ended.\r\n        if (this._state === AnimationState.ENDED) {\r\n            return;\r\n        }\r\n        this._animationGroup.stop();\r\n        if (!this._animationGroup.isStarted) {\r\n            this._state = AnimationState.STOPPED;\r\n        }\r\n    }\r\n\r\n    /**\r\n     * Dispose this animation object.\r\n     */\r\n    public dispose() {\r\n        this._animationGroup.dispose();\r\n    }\r\n}\r\n"]}