@safe-engine/pixi 8.8.1 → 8.8.3

package/dist/dragonbones/dragonBones/animation/Animation.js

@@ -0,0 +1,692 @@
+import { BaseObject } from "../core/BaseObject";
+import { AnimationConfig } from "../model/AnimationConfig";
+import { AnimationState, BlendState } from "./AnimationState";
+/**
+ * - The animation player is used to play the animation data and manage the animation states.
+ * @see dragonBones.AnimationData
+ * @see dragonBones.AnimationState
+ * @version DragonBones 3.0
+ * @language en_US
+ */
+export class Animation extends BaseObject {
+    constructor() {
+        super(...arguments);
+        this._animationNames = [];
+        this._animationStates = [];
+        this._animations = {};
+        this._blendStates = {};
+        this._animationConfig = null; // Initial value.
+    }
+    static toString() {
+        return "[class dragonBones.Animation]";
+    }
+    _onClear() {
+        for (const animationState of this._animationStates) {
+            animationState.returnToPool();
+        }
+        for (let k in this._animations) {
+            delete this._animations[k];
+        }
+        for (let k in this._blendStates) {
+            const blendStates = this._blendStates[k];
+            for (let kB in blendStates) {
+                blendStates[kB].returnToPool();
+            }
+            delete this._blendStates[k];
+        }
+        if (this._animationConfig !== null) {
+            this._animationConfig.returnToPool();
+        }
+        this.timeScale = 1.0;
+        this._animationDirty = false;
+        this._inheritTimeScale = 1.0;
+        this._animationNames.length = 0;
+        this._animationStates.length = 0;
+        //this._animations.clear();
+        this._armature = null; //
+        this._animationConfig = null; //
+        this._lastAnimationState = null;
+    }
+    _fadeOut(animationConfig) {
+        switch (animationConfig.fadeOutMode) {
+            case 1 /* AnimationFadeOutMode.SameLayer */:
+                for (const animationState of this._animationStates) {
+                    if (animationState._parent !== null) {
+                        continue;
+                    }
+                    if (animationState.layer === animationConfig.layer) {
+                        animationState.fadeOut(animationConfig.fadeOutTime, animationConfig.pauseFadeOut);
+                    }
+                }
+                break;
+            case 2 /* AnimationFadeOutMode.SameGroup */:
+                for (const animationState of this._animationStates) {
+                    if (animationState._parent !== null) {
+                        continue;
+                    }
+                    if (animationState.group === animationConfig.group) {
+                        animationState.fadeOut(animationConfig.fadeOutTime, animationConfig.pauseFadeOut);
+                    }
+                }
+                break;
+            case 3 /* AnimationFadeOutMode.SameLayerAndGroup */:
+                for (const animationState of this._animationStates) {
+                    if (animationState._parent !== null) {
+                        continue;
+                    }
+                    if (animationState.layer === animationConfig.layer &&
+                        animationState.group === animationConfig.group) {
+                        animationState.fadeOut(animationConfig.fadeOutTime, animationConfig.pauseFadeOut);
+                    }
+                }
+                break;
+            case 4 /* AnimationFadeOutMode.All */:
+                for (const animationState of this._animationStates) {
+                    if (animationState._parent !== null) {
+                        continue;
+                    }
+                    animationState.fadeOut(animationConfig.fadeOutTime, animationConfig.pauseFadeOut);
+                }
+                break;
+            case 5 /* AnimationFadeOutMode.Single */: // TODO
+            default:
+                break;
+        }
+    }
+    /**
+     * @internal
+     */
+    init(armature) {
+        if (this._armature !== null) {
+            return;
+        }
+        this._armature = armature;
+        this._animationConfig = BaseObject.borrowObject(AnimationConfig);
+    }
+    /**
+     * @internal
+     */
+    advanceTime(passedTime) {
+        if (passedTime < 0.0) {
+            // Only animationState can reverse play.
+            passedTime = -passedTime;
+        }
+        if (this._armature.inheritAnimation && this._armature._parent !== null) {
+            // Inherit parent animation timeScale.
+            this._inheritTimeScale =
+                this._armature._parent._armature.animation._inheritTimeScale *
+                    this.timeScale;
+        }
+        else {
+            this._inheritTimeScale = this.timeScale;
+        }
+        if (this._inheritTimeScale !== 1.0) {
+            passedTime *= this._inheritTimeScale;
+        }
+        for (let k in this._blendStates) {
+            const blendStates = this._blendStates[k];
+            for (let kB in blendStates) {
+                blendStates[kB].reset();
+            }
+        }
+        const animationStateCount = this._animationStates.length;
+        if (animationStateCount === 1) {
+            const animationState = this._animationStates[0];
+            if (animationState._fadeState > 0 && animationState._subFadeState > 0) {
+                this._armature._dragonBones.bufferObject(animationState);
+                this._animationStates.length = 0;
+                this._lastAnimationState = null;
+            }
+            else {
+                const animationData = animationState.animationData;
+                const cacheFrameRate = animationData.cacheFrameRate;
+                if (this._animationDirty && cacheFrameRate > 0.0) {
+                    // Update cachedFrameIndices.
+                    this._animationDirty = false;
+                    for (const bone of this._armature.getBones()) {
+                        bone._cachedFrameIndices = animationData.getBoneCachedFrameIndices(bone.name);
+                    }
+                    for (const slot of this._armature.getSlots()) {
+                        if (slot.displayFrameCount > 0) {
+                            const rawDisplayData = slot.getDisplayFrameAt(0).rawDisplayData;
+                            if (rawDisplayData !== null &&
+                                rawDisplayData.parent ===
+                                    this._armature.armatureData.defaultSkin) {
+                                slot._cachedFrameIndices =
+                                    animationData.getSlotCachedFrameIndices(slot.name);
+                                continue;
+                            }
+                        }
+                        slot._cachedFrameIndices = null;
+                    }
+                }
+                animationState.advanceTime(passedTime, cacheFrameRate);
+            }
+        }
+        else if (animationStateCount > 1) {
+            for (let i = 0, r = 0; i < animationStateCount; ++i) {
+                const animationState = this._animationStates[i];
+                if (animationState._fadeState > 0 && animationState._subFadeState > 0) {
+                    r++;
+                    this._armature._dragonBones.bufferObject(animationState);
+                    this._animationDirty = true;
+                    if (this._lastAnimationState === animationState) {
+                        // Update last animation state.
+                        this._lastAnimationState = null;
+                    }
+                }
+                else {
+                    if (r > 0) {
+                        this._animationStates[i - r] = animationState;
+                    }
+                    animationState.advanceTime(passedTime, 0.0);
+                }
+                if (i === animationStateCount - 1 && r > 0) {
+                    // Modify animation states size.
+                    this._animationStates.length -= r;
+                    if (this._lastAnimationState === null &&
+                        this._animationStates.length > 0) {
+                        this._lastAnimationState =
+                            this._animationStates[this._animationStates.length - 1];
+                    }
+                }
+            }
+            this._armature._cacheFrameIndex = -1;
+        }
+        else {
+            this._armature._cacheFrameIndex = -1;
+        }
+    }
+    /**
+     * - Clear all animations states.
+     * @see dragonBones.AnimationState
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    reset() {
+        for (const animationState of this._animationStates) {
+            animationState.returnToPool();
+        }
+        this._animationDirty = false;
+        this._animationConfig.clear();
+        this._animationStates.length = 0;
+        this._lastAnimationState = null;
+    }
+    /**
+     * - Pause a specific animation state.
+     * @param animationName - The name of animation state. (If not set, it will pause all animations)
+     * @see dragonBones.AnimationState
+     * @version DragonBones 3.0
+     * @language en_US
+     */
+    stop(animationName = null) {
+        if (animationName !== null) {
+            const animationState = this.getState(animationName);
+            if (animationState !== null) {
+                animationState.stop();
+            }
+        }
+        else {
+            for (const animationState of this._animationStates) {
+                animationState.stop();
+            }
+        }
+    }
+    /**
+     * - Play animation with a specific animation config.
+     * The API is still in the experimental phase and may encounter bugs or stability or compatibility issues when used.
+     * @param animationConfig - The animation config.
+     * @returns The playing animation state.
+     * @see dragonBones.AnimationConfig
+     * @beta
+     * @version DragonBones 5.0
+     * @language en_US
+     */
+    playConfig(animationConfig) {
+        const animationName = animationConfig.animation;
+        if (!(animationName in this._animations)) {
+            console.warn("Non-existent animation.\n", "DragonBones name: " + this._armature.armatureData.parent.name, "Armature name: " + this._armature.name, "Animation name: " + animationName);
+            return null;
+        }
+        const animationData = this._animations[animationName];
+        if (animationConfig.fadeOutMode === 5 /* AnimationFadeOutMode.Single */) {
+            for (const animationState of this._animationStates) {
+                if (animationState._fadeState < 1 &&
+                    animationState.layer === animationConfig.layer &&
+                    animationState.animationData === animationData) {
+                    return animationState;
+                }
+            }
+        }
+        if (this._animationStates.length === 0) {
+            animationConfig.fadeInTime = 0.0;
+        }
+        else if (animationConfig.fadeInTime < 0.0) {
+            animationConfig.fadeInTime = animationData.fadeInTime;
+        }
+        if (animationConfig.fadeOutTime < 0.0) {
+            animationConfig.fadeOutTime = animationConfig.fadeInTime;
+        }
+        if (animationConfig.timeScale <= -100.0) {
+            animationConfig.timeScale = 1.0 / animationData.scale;
+        }
+        if (animationData.frameCount > 0) {
+            if (animationConfig.position < 0.0) {
+                animationConfig.position %= animationData.duration;
+                animationConfig.position =
+                    animationData.duration - animationConfig.position;
+            }
+            else if (animationConfig.position === animationData.duration) {
+                animationConfig.position -= 0.000001; // Play a little time before end.
+            }
+            else if (animationConfig.position > animationData.duration) {
+                animationConfig.position %= animationData.duration;
+            }
+            if (animationConfig.duration > 0.0 &&
+                animationConfig.position + animationConfig.duration >
+                    animationData.duration) {
+                animationConfig.duration =
+                    animationData.duration - animationConfig.position;
+            }
+            if (animationConfig.playTimes < 0) {
+                animationConfig.playTimes = animationData.playTimes;
+            }
+        }
+        else {
+            animationConfig.playTimes = 1;
+            animationConfig.position = 0.0;
+            if (animationConfig.duration > 0.0) {
+                animationConfig.duration = 0.0;
+            }
+        }
+        if (animationConfig.duration === 0.0) {
+            animationConfig.duration = -1.0;
+        }
+        this._fadeOut(animationConfig);
+        //
+        const animationState = BaseObject.borrowObject(AnimationState);
+        animationState.init(this._armature, animationData, animationConfig);
+        this._animationDirty = true;
+        this._armature._cacheFrameIndex = -1;
+        if (this._animationStates.length > 0) {
+            // Sort animation state.
+            let added = false;
+            for (let i = 0, l = this._animationStates.length; i < l; ++i) {
+                if (animationState.layer > this._animationStates[i].layer) {
+                    added = true;
+                    this._animationStates.splice(i, 0, animationState);
+                    break;
+                }
+                else if (i !== l - 1 &&
+                    animationState.layer > this._animationStates[i + 1].layer) {
+                    added = true;
+                    this._animationStates.splice(i + 1, 0, animationState);
+                    break;
+                }
+            }
+            if (!added) {
+                this._animationStates.push(animationState);
+            }
+        }
+        else {
+            this._animationStates.push(animationState);
+        }
+        for (const slot of this._armature.getSlots()) {
+            // Child armature play same name animation.
+            const childArmature = slot.childArmature;
+            if (childArmature !== null &&
+                childArmature.inheritAnimation &&
+                childArmature.animation.hasAnimation(animationName) &&
+                childArmature.animation.getState(animationName) === null) {
+                childArmature.animation.fadeIn(animationName); //
+            }
+        }
+        for (let k in animationData.animationTimelines) {
+            // Blend animation node.
+            const childAnimationState = this.fadeIn(k, 0.0, 1, animationState.layer, "", 5 /* AnimationFadeOutMode.Single */);
+            if (childAnimationState === null) {
+                continue;
+            }
+            const timelines = animationData.animationTimelines[k];
+            childAnimationState.actionEnabled = false;
+            childAnimationState.resetToPose = false;
+            childAnimationState.stop();
+            animationState.addState(childAnimationState, timelines);
+            //
+            const index = this._animationStates.indexOf(animationState);
+            const childIndex = this._animationStates.indexOf(childAnimationState);
+            if (childIndex < index) {
+                this._animationStates.splice(index, 1);
+                this._animationStates.splice(childIndex, 0, animationState);
+            }
+        }
+        // if (!this._armature._lockUpdate && animationConfig.fadeInTime <= 0.0) { // Blend animation state, update armature.
+        //     this._armature.advanceTime(0.0);
+        // }
+        this._lastAnimationState = animationState;
+        return animationState;
+    }
+    /**
+     * - Play a specific animation.
+     * @param animationName - The name of animation data. (If not set, The default animation will be played, or resume the animation playing from pause status, or replay the last playing animation)
+     * @param playTimes - Playing repeat times. [-1: Use default value of the animation data, 0: No end loop playing, [1~N]: Repeat N times] (default: -1)
+     * @returns The playing animation state.
+     * @example
+     * <pre>
+     *     armature.animation.play("walk");
+     * </pre>
+     * @version DragonBones 3.0
+     * @language en_US
+     */
+    play(animationName = null, playTimes = -1) {
+        this._animationConfig.clear();
+        this._animationConfig.resetToPose = true;
+        this._animationConfig.playTimes = playTimes;
+        this._animationConfig.fadeInTime = 0.0;
+        this._animationConfig.animation =
+            animationName !== null ? animationName : "";
+        if (animationName !== null && animationName.length > 0) {
+            this.playConfig(this._animationConfig);
+        }
+        else if (this._lastAnimationState === null) {
+            const defaultAnimation = this._armature.armatureData.defaultAnimation;
+            if (defaultAnimation !== null) {
+                this._animationConfig.animation = defaultAnimation.name;
+                this.playConfig(this._animationConfig);
+            }
+        }
+        else if (!this._lastAnimationState.isPlaying &&
+            !this._lastAnimationState.isCompleted) {
+            this._lastAnimationState.play();
+        }
+        else {
+            this._animationConfig.animation = this._lastAnimationState.name;
+            this.playConfig(this._animationConfig);
+        }
+        return this._lastAnimationState;
+    }
+    /**
+     * - Fade in a specific animation.
+     * @param animationName - The name of animation data.
+     * @param fadeInTime - The fade in time. [-1: Use the default value of animation data, [0~N]: The fade in time (In seconds)] (Default: -1)
+     * @param playTimes - playing repeat times. [-1: Use the default value of animation data, 0: No end loop playing, [1~N]: Repeat N times] (Default: -1)
+     * @param layer - The blending layer, the animation states in high level layer will get the blending weights with high priority, when the total blending weights are more than 1.0, there will be no more weights can be allocated to the other animation states. (Default: 0)
+     * @param group - The blending group name, it is typically used to specify the substitution of multiple animation states blending. (Default: null)
+     * @param fadeOutMode - The fade out mode, which is typically used to specify alternate mode of multiple animation states blending. (Default: AnimationFadeOutMode.SameLayerAndGroup)
+     * @returns The playing animation state.
+     * @example
+     * <pre>
+     *     armature.animation.fadeIn("walk", 0.3, 0, 0, "normalGroup").resetToPose = false;
+     *     armature.animation.fadeIn("attack", 0.3, 1, 0, "attackGroup").resetToPose = false;
+     * </pre>
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    fadeIn(animationName, fadeInTime = -1.0, playTimes = -1, layer = 0, group = null, fadeOutMode = 3 /* AnimationFadeOutMode.SameLayerAndGroup */) {
+        this._animationConfig.clear();
+        this._animationConfig.fadeOutMode = fadeOutMode;
+        this._animationConfig.playTimes = playTimes;
+        this._animationConfig.layer = layer;
+        this._animationConfig.fadeInTime = fadeInTime;
+        this._animationConfig.animation = animationName;
+        this._animationConfig.group = group !== null ? group : "";
+        return this.playConfig(this._animationConfig);
+    }
+    /**
+     * - Play a specific animation from the specific time.
+     * @param animationName - The name of animation data.
+     * @param time - The start time point of playing. (In seconds)
+     * @param playTimes - Playing repeat times. [-1: Use the default value of animation data, 0: No end loop playing, [1~N]: Repeat N times] (Default: -1)
+     * @returns The played animation state.
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    gotoAndPlayByTime(animationName, time = 0.0, playTimes = -1) {
+        this._animationConfig.clear();
+        this._animationConfig.resetToPose = true;
+        this._animationConfig.playTimes = playTimes;
+        this._animationConfig.position = time;
+        this._animationConfig.fadeInTime = 0.0;
+        this._animationConfig.animation = animationName;
+        return this.playConfig(this._animationConfig);
+    }
+    /**
+     * - Play a specific animation from the specific frame.
+     * @param animationName - The name of animation data.
+     * @param frame - The start frame of playing.
+     * @param playTimes - Playing repeat times. [-1: Use the default value of animation data, 0: No end loop playing, [1~N]: Repeat N times] (Default: -1)
+     * @returns The played animation state.
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    gotoAndPlayByFrame(animationName, frame = 0, playTimes = -1) {
+        this._animationConfig.clear();
+        this._animationConfig.resetToPose = true;
+        this._animationConfig.playTimes = playTimes;
+        this._animationConfig.fadeInTime = 0.0;
+        this._animationConfig.animation = animationName;
+        const animationData = animationName in this._animations
+            ? this._animations[animationName]
+            : null;
+        if (animationData !== null) {
+            this._animationConfig.position =
+                animationData.frameCount > 0
+                    ? (animationData.duration * frame) / animationData.frameCount
+                    : 0.0;
+        }
+        return this.playConfig(this._animationConfig);
+    }
+    /**
+     * - Play a specific animation from the specific progress.
+     * @param animationName - The name of animation data.
+     * @param progress - The start progress value of playing.
+     * @param playTimes - Playing repeat times. [-1: Use the default value of animation data, 0: No end loop playing, [1~N]: Repeat N times] (Default: -1)
+     * @returns The played animation state.
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    gotoAndPlayByProgress(animationName, progress = 0.0, playTimes = -1) {
+        this._animationConfig.clear();
+        this._animationConfig.resetToPose = true;
+        this._animationConfig.playTimes = playTimes;
+        this._animationConfig.fadeInTime = 0.0;
+        this._animationConfig.animation = animationName;
+        const animationData = animationName in this._animations
+            ? this._animations[animationName]
+            : null;
+        if (animationData !== null) {
+            this._animationConfig.position =
+                animationData.duration * (progress > 0.0 ? progress : 0.0);
+        }
+        return this.playConfig(this._animationConfig);
+    }
+    /**
+     * - Stop a specific animation at the specific time.
+     * @param animationName - The name of animation data.
+     * @param time - The stop time. (In seconds)
+     * @returns The played animation state.
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    gotoAndStopByTime(animationName, time = 0.0) {
+        const animationState = this.gotoAndPlayByTime(animationName, time, 1);
+        if (animationState !== null) {
+            animationState.stop();
+        }
+        return animationState;
+    }
+    /**
+     * - Stop a specific animation at the specific frame.
+     * @param animationName - The name of animation data.
+     * @param frame - The stop frame.
+     * @returns The played animation state.
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    gotoAndStopByFrame(animationName, frame = 0) {
+        const animationState = this.gotoAndPlayByFrame(animationName, frame, 1);
+        if (animationState !== null) {
+            animationState.stop();
+        }
+        return animationState;
+    }
+    /**
+     * - Stop a specific animation at the specific progress.
+     * @param animationName - The name of animation data.
+     * @param progress - The stop progress value.
+     * @returns The played animation state.
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    gotoAndStopByProgress(animationName, progress = 0.0) {
+        const animationState = this.gotoAndPlayByProgress(animationName, progress, 1);
+        if (animationState !== null) {
+            animationState.stop();
+        }
+        return animationState;
+    }
+    /**
+     * @internal
+     */
+    getBlendState(type, name, target) {
+        if (!(type in this._blendStates)) {
+            this._blendStates[type] = {};
+        }
+        const blendStates = this._blendStates[type];
+        if (!(name in blendStates)) {
+            const blendState = (blendStates[name] =
+                BaseObject.borrowObject(BlendState));
+            blendState.target = target;
+        }
+        return blendStates[name];
+    }
+    /**
+     * - Get a specific animation state.
+     * @param animationName - The name of animation state.
+     * @param layer - The layer of find animation states. [-1: Find all layers, [0~N]: Specified layer] (default: -1)
+     * @example
+     * <pre>
+     *     armature.animation.play("walk");
+     *     let walkState = armature.animation.getState("walk");
+     *     walkState.timeScale = 0.5;
+     * </pre>
+     * @version DragonBones 3.0
+     * @language en_US
+     */
+    getState(animationName, layer = -1) {
+        let i = this._animationStates.length;
+        while (i--) {
+            const animationState = this._animationStates[i];
+            if (animationState.name === animationName &&
+                (layer < 0 || animationState.layer === layer)) {
+                return animationState;
+            }
+        }
+        return null;
+    }
+    /**
+     * - Check whether a specific animation data is included.
+     * @param animationName - The name of animation data.
+     * @see dragonBones.AnimationData
+     * @version DragonBones 3.0
+     * @language en_US
+     */
+    hasAnimation(animationName) {
+        return animationName in this._animations;
+    }
+    /**
+     * - Get all the animation states.
+     * @version DragonBones 5.1
+     * @language en_US
+     */
+    getStates() {
+        return this._animationStates;
+    }
+    /**
+     * - Check whether there is an animation state is playing
+     * @see dragonBones.AnimationState
+     * @version DragonBones 3.0
+     * @language en_US
+     */
+    get isPlaying() {
+        for (const animationState of this._animationStates) {
+            if (animationState.isPlaying) {
+                return true;
+            }
+        }
+        return false;
+    }
+    /**
+     * - Check whether all the animation states' playing were finished.
+     * @see dragonBones.AnimationState
+     * @version DragonBones 3.0
+     * @language en_US
+     */
+    get isCompleted() {
+        for (const animationState of this._animationStates) {
+            if (!animationState.isCompleted) {
+                return false;
+            }
+        }
+        return this._animationStates.length > 0;
+    }
+    /**
+     * - The name of the last playing animation state.
+     * @see #lastAnimationState
+     * @version DragonBones 3.0
+     * @language en_US
+     */
+    get lastAnimationName() {
+        return this._lastAnimationState !== null
+            ? this._lastAnimationState.name
+            : "";
+    }
+    /**
+     * - The name of all animation data
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    get animationNames() {
+        return this._animationNames;
+    }
+    /**
+     * - All animation data.
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    get animations() {
+        return this._animations;
+    }
+    set animations(value) {
+        if (this._animations === value) {
+            return;
+        }
+        this._animationNames.length = 0;
+        for (let k in this._animations) {
+            delete this._animations[k];
+        }
+        for (let k in value) {
+            this._animationNames.push(k);
+            this._animations[k] = value[k];
+        }
+    }
+    /**
+     * - An AnimationConfig instance that can be used quickly.
+     * @see dragonBones.AnimationConfig
+     * @version DragonBones 5.0
+     * @language en_US
+     */
+    get animationConfig() {
+        this._animationConfig.clear();
+        return this._animationConfig;
+    }
+    /**
+     * - The last playing animation state
+     * @see dragonBones.AnimationState
+     * @version DragonBones 3.0
+     * @language en_US
+     */
+    get lastAnimationState() {
+        return this._lastAnimationState;
+    }
+}