mirror of https://github.com/axmolengine/axmol.git
479 lines
17 KiB
C
479 lines
17 KiB
C
|
/**
|
|||
|
|
* The MIT License (MIT)
|
|||
|
|
*
|
|||
|
|
* Copyright (c) 2012-2018 DragonBones team and other contributors
|
|||
|
|
*
|
|||
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|||
|
|
* this software and associated documentation files (the "Software"), to deal in
|
|||
|
|
* the Software without restriction, including without limitation the rights to
|
|||
|
|
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|||
|
|
* the Software, and to permit persons to whom the Software is furnished to do so,
|
|||
|
|
* subject to the following conditions:
|
|||
|
|
*
|
|||
|
|
* The above copyright notice and this permission notice shall be included in all
|
|||
|
|
* copies or substantial portions of the Software.
|
|||
|
|
*
|
|||
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|||
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|||
|
|
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|||
|
|
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|||
|
|
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|||
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|||
|
|
*/
|
|||
|
|
#ifndef DRAGONBONES_ANIMATION_H
|
|||
|
|
#define DRAGONBONES_ANIMATION_H
|
|||
|
|
|
|||
|
|
#include "../core/BaseObject.h"
|
|||
|
|
|
|||
|
|
DRAGONBONES_NAMESPACE_BEGIN
|
|||
|
|
/**
|
|||
|
|
* - 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
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ŷ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ݺ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD>
|
|||
|
|
* @see dragonBones.AnimationData
|
|||
|
|
* @see dragonBones.AnimationState
|
|||
|
|
* @version DragonBones 3.0
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
class Animation final : public BaseObject
|
|||
|
|
{
|
|||
|
|
BIND_CLASS_TYPE_B(Animation);
|
|||
|
|
|
|||
|
|
public:
|
|||
|
|
/**
|
|||
|
|
* - The play speed of all animations. [0: Stop, (0~1): Slow, 1: Normal, (1~N): Fast]
|
|||
|
|
* @default 1.0
|
|||
|
|
* @version DragonBones 3.0
|
|||
|
|
* @language en_US
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD><EFBFBD>ж<EFBFBD><EFBFBD><EFBFBD><EFBFBD>IJ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>ٶȡ<EFBFBD> [0: ֹͣ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>, (0~1): <EFBFBD><EFBFBD><EFBFBD>ٲ<EFBFBD><EFBFBD><EFBFBD>, 1: <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>, (1~N): <EFBFBD><EFBFBD><EFBFBD>ٲ<EFBFBD><EFBFBD><EFBFBD>]
|
|||
|
|
* @default 1.0
|
|||
|
|
* @version DragonBones 3.0
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
float timeScale;
|
|||
|
|
|
|||
|
|
private:
|
|||
|
|
bool _animationDirty;
|
|||
|
|
float _inheritTimeScale;
|
|||
|
|
std::vector<std::string> _animationNames;
|
|||
|
|
std::vector<AnimationState*> _animationStates;
|
|||
|
|
std::map<std::string, AnimationData*> _animations;
|
|||
|
|
Armature* _armature;
|
|||
|
|
AnimationConfig* _animationConfig;
|
|||
|
|
AnimationState* _lastAnimationState;
|
|||
|
|
|
|||
|
|
public:
|
|||
|
|
Animation() :
|
|||
|
|
_animationConfig(nullptr)
|
|||
|
|
{
|
|||
|
|
_onClear();
|
|||
|
|
}
|
|||
|
|
~Animation()
|
|||
|
|
{
|
|||
|
|
_onClear();
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
private:
|
|||
|
|
void _fadeOut(AnimationConfig* animationConfig);
|
|||
|
|
|
|||
|
|
protected:
|
|||
|
|
virtual void _onClear() override;
|
|||
|
|
|
|||
|
|
public:
|
|||
|
|
/**
|
|||
|
|
* @internal
|
|||
|
|
*/
|
|||
|
|
void init(Armature* armature);
|
|||
|
|
/**
|
|||
|
|
* @internal
|
|||
|
|
*/
|
|||
|
|
void advanceTime(float passedTime);
|
|||
|
|
/**
|
|||
|
|
* - Clear all animations states.
|
|||
|
|
* @see dragonBones.AnimationState
|
|||
|
|
* @version DragonBones 4.5
|
|||
|
|
* @language en_US
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>еĶ<EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD>
|
|||
|
|
* @see dragonBones.AnimationState
|
|||
|
|
* @version DragonBones 4.5
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
void reset();
|
|||
|
|
/**
|
|||
|
|
* - 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
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD>ָͣ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD>IJ<EFBFBD><EFBFBD>š<EFBFBD>
|
|||
|
|
* @param animationName - <EFBFBD><EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD><EFBFBD>ơ<EFBFBD> <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>δ<EFBFBD><EFBFBD><EFBFBD>ã<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ͣ<EFBFBD><EFBFBD><EFBFBD>ж<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* @see dragonBones.AnimationState
|
|||
|
|
* @version DragonBones 3.0
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
void stop(const std::string& animationName);
|
|||
|
|
/**
|
|||
|
|
* - 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
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - ͨ<EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD><EFBFBD>Ķ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ŷ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* <EFBFBD><EFBFBD> API <EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʵ<EFBFBD><EFBFBD><EFBFBD>Σ<EFBFBD>ʹ<EFBFBD><EFBFBD>ʱ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> bug <EFBFBD><EFBFBD><EFBFBD>ȶ<EFBFBD><EFBFBD>Ի<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>⡣
|
|||
|
|
* @param animationConfig - <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>á<EFBFBD>
|
|||
|
|
* @returns <EFBFBD><EFBFBD><EFBFBD>ŵĶ<EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD>
|
|||
|
|
* @see dragonBones.AnimationConfig
|
|||
|
|
* @beta
|
|||
|
|
* @version DragonBones 5.0
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
AnimationState* playConfig(AnimationConfig* animationConfig);
|
|||
|
|
/**
|
|||
|
|
* - 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
|
|||
|
|
* TypeScript style, for reference only.
|
|||
|
|
* <pre>
|
|||
|
|
* armature.animation.play("walk");
|
|||
|
|
* </pre>
|
|||
|
|
* @version DragonBones 3.0
|
|||
|
|
* @language en_US
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD><EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* @param animationName - <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ơ<EFBFBD> <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>δ<EFBFBD><EFBFBD><EFBFBD>ã<EFBFBD><EFBFBD><EFBFBD>Ĭ<EFBFBD>϶<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ͣ״̬<EFBFBD>л<EFBFBD>Ϊ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>²<EFBFBD><EFBFBD><EFBFBD>֮ǰ<EFBFBD><EFBFBD><EFBFBD>ŵĶ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* @param playTimes - ѭ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ŵ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> [-1: ʹ<EFBFBD>ö<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ĭ<EFBFBD><EFBFBD>ֵ, 0: <EFBFBD><EFBFBD><EFBFBD><EFBFBD>ѭ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>, [1~N]: ѭ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> N <EFBFBD><EFBFBD>] <EFBFBD><EFBFBD>Ĭ<EFBFBD><EFBFBD>: -1<EFBFBD><EFBFBD>
|
|||
|
|
* @returns <EFBFBD><EFBFBD><EFBFBD>ŵĶ<EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD>
|
|||
|
|
* @example
|
|||
|
|
* TypeScript <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ο<EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* <pre>
|
|||
|
|
* armature.animation.play("walk");
|
|||
|
|
* </pre>
|
|||
|
|
* @version DragonBones 3.0
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
AnimationState* play(const std::string& animationName = "", int playTimes = -1);
|
|||
|
|
/**
|
|||
|
|
* - 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
|
|||
|
|
* TypeScript style, for reference only.
|
|||
|
|
* <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
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD><EFBFBD>벥<EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD><EFBFBD>Ķ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* @param animationName - <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ơ<EFBFBD>
|
|||
|
|
* @param fadeInTime - <EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʱ<EFBFBD>䡣 [-1: ʹ<EFBFBD>ö<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ĭ<EFBFBD><EFBFBD>ֵ, [0~N]: <EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʱ<EFBFBD><EFBFBD> (<EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϊ<EFBFBD><EFBFBD>λ)] <EFBFBD><EFBFBD>Ĭ<EFBFBD><EFBFBD>: -1<EFBFBD><EFBFBD>
|
|||
|
|
* @param playTimes - <EFBFBD><EFBFBD><EFBFBD>Ŵ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> [-1: ʹ<EFBFBD>ö<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ĭ<EFBFBD><EFBFBD>ֵ, 0: <EFBFBD><EFBFBD><EFBFBD><EFBFBD>ѭ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>, [1~N]: ѭ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> N <EFBFBD><EFBFBD>] <EFBFBD><EFBFBD>Ĭ<EFBFBD><EFBFBD>: -1<EFBFBD><EFBFBD>
|
|||
|
|
* @param layer - <EFBFBD><EFBFBD><EFBFBD><EFBFBD>ͼ<EFBFBD>㣬ͼ<EFBFBD><EFBFBD><EFBFBD>ߵĶ<EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ȼ<EFBFBD>ȡ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ȩ<EFBFBD>أ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ȩ<EFBFBD>ط<EFBFBD><EFBFBD><EFBFBD><EFBFBD>ܺͳ<EFBFBD><EFBFBD><EFBFBD> 1.0 ʱ<EFBFBD><EFBFBD>ʣ<EFBFBD><EFBFBD><EFBFBD>Ķ<EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ٻ<EFBFBD><EFBFBD><EFBFBD>Ȩ<EFBFBD>ط<EFBFBD><EFBFBD>䡣 <EFBFBD><EFBFBD>Ĭ<EFBFBD><EFBFBD>: 0<EFBFBD><EFBFBD>
|
|||
|
|
* @param group - <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ƣ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ͨ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʱ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>滻<EFBFBD><EFBFBD>ϵ<EFBFBD><EFBFBD> <EFBFBD><EFBFBD>Ĭ<EFBFBD><EFBFBD>: null<EFBFBD><EFBFBD>
|
|||
|
|
* @param fadeOutMode - <EFBFBD><EFBFBD><EFBFBD><EFBFBD>ģʽ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ͨ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʱ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>滻ģʽ<EFBFBD><EFBFBD> <EFBFBD><EFBFBD>Ĭ<EFBFBD><EFBFBD>: AnimationFadeOutMode.SameLayerAndGroup<EFBFBD><EFBFBD>
|
|||
|
|
* @returns <EFBFBD><EFBFBD><EFBFBD>ŵĶ<EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD>
|
|||
|
|
* @example
|
|||
|
|
* TypeScript <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ο<EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* <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 zh_CN
|
|||
|
|
*/
|
|||
|
|
AnimationState* fadeIn(
|
|||
|
|
const std::string& animationName, float fadeInTime = -1.f, int playTimes = -1,
|
|||
|
|
int layer = 0, const std::string& group = "", AnimationFadeOutMode fadeOutMode = AnimationFadeOutMode::SameLayerAndGroup
|
|||
|
|
);
|
|||
|
|
/**
|
|||
|
|
* - 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
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD>ʱ<EFBFBD>俪ʼ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD><EFBFBD>Ķ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* @param animationName - <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ơ<EFBFBD>
|
|||
|
|
* @param time - <EFBFBD><EFBFBD><EFBFBD>ſ<EFBFBD>ʼ<EFBFBD><EFBFBD>ʱ<EFBFBD>䡣 (<EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϊ<EFBFBD><EFBFBD>λ)
|
|||
|
|
* @param playTimes - ѭ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ŵ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> [-1: ʹ<EFBFBD>ö<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ĭ<EFBFBD><EFBFBD>ֵ, 0: <EFBFBD><EFBFBD><EFBFBD><EFBFBD>ѭ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>, [1~N]: ѭ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> N <EFBFBD><EFBFBD>] <EFBFBD><EFBFBD>Ĭ<EFBFBD><EFBFBD>: -1<EFBFBD><EFBFBD>
|
|||
|
|
* @returns <EFBFBD><EFBFBD><EFBFBD>ŵĶ<EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD>
|
|||
|
|
* @version DragonBones 4.5
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
AnimationState* gotoAndPlayByTime(const std::string& animationName, float time = 0.f, int playTimes = -1);
|
|||
|
|
/**
|
|||
|
|
* - 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
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD>֡<EFBFBD><EFBFBD>ʼ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD><EFBFBD>Ķ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* @param animationName - <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ơ<EFBFBD>
|
|||
|
|
* @param frame - <EFBFBD><EFBFBD><EFBFBD>ſ<EFBFBD>ʼ<EFBFBD><EFBFBD>֡<EFBFBD><EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* @param playTimes - <EFBFBD><EFBFBD><EFBFBD>Ŵ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> [-1: ʹ<EFBFBD>ö<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ĭ<EFBFBD><EFBFBD>ֵ, 0: <EFBFBD><EFBFBD><EFBFBD><EFBFBD>ѭ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>, [1~N]: ѭ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> N <EFBFBD><EFBFBD>] <EFBFBD><EFBFBD>Ĭ<EFBFBD><EFBFBD>: -1<EFBFBD><EFBFBD>
|
|||
|
|
* @returns <EFBFBD><EFBFBD><EFBFBD>ŵĶ<EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD>
|
|||
|
|
* @version DragonBones 4.5
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
AnimationState* gotoAndPlayByFrame(const std::string& animationName, unsigned frame = 0, int playTimes = -1);
|
|||
|
|
/**
|
|||
|
|
* - 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
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ȿ<EFBFBD>ʼ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD><EFBFBD>Ķ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* @param animationName - <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ơ<EFBFBD>
|
|||
|
|
* @param progress - <EFBFBD><EFBFBD>ʼ<EFBFBD><EFBFBD><EFBFBD>ŵĽ<EFBFBD><EFBFBD>ȡ<EFBFBD>
|
|||
|
|
* @param playTimes - <EFBFBD><EFBFBD><EFBFBD>Ŵ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> [-1: ʹ<EFBFBD>ö<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ĭ<EFBFBD><EFBFBD>ֵ, 0: <EFBFBD><EFBFBD><EFBFBD><EFBFBD>ѭ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>, [1~N]: ѭ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> N <EFBFBD><EFBFBD>] <EFBFBD><EFBFBD>Ĭ<EFBFBD><EFBFBD>: -1<EFBFBD><EFBFBD>
|
|||
|
|
* @returns <EFBFBD><EFBFBD><EFBFBD>ŵĶ<EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD>
|
|||
|
|
* @version DragonBones 4.5
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
AnimationState* gotoAndPlayByProgress(const std::string& animationName, float progress = 0.f, int playTimes = -1);
|
|||
|
|
/**
|
|||
|
|
* - 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
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD>ʱ<EFBFBD><EFBFBD>ָֹͣ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* @param animationName - <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ơ<EFBFBD>
|
|||
|
|
* @param time - ֹͣ<EFBFBD><EFBFBD>ʱ<EFBFBD>䡣 (<EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ϊ<EFBFBD><EFBFBD>λ)
|
|||
|
|
* @returns <EFBFBD><EFBFBD><EFBFBD>ŵĶ<EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD>
|
|||
|
|
* @version DragonBones 4.5
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
AnimationState* gotoAndStopByTime(const std::string& animationName, float time = 0.f);
|
|||
|
|
/**
|
|||
|
|
* - 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
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD>ָֹ֡ͣ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>IJ<EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* @param animationName - <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ơ<EFBFBD>
|
|||
|
|
* @param frame - ֹͣ<EFBFBD><EFBFBD>֡<EFBFBD><EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* @returns <EFBFBD><EFBFBD><EFBFBD>ŵĶ<EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD>
|
|||
|
|
* @version DragonBones 4.5
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
AnimationState* gotoAndStopByFrame(const std::string& animationName, unsigned frame = 0);
|
|||
|
|
/**
|
|||
|
|
* - 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
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD><EFBFBD>Ľ<EFBFBD><EFBFBD><EFBFBD>ָֹͣ<EFBFBD><EFBFBD><EFBFBD>Ķ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>š<EFBFBD>
|
|||
|
|
* @param animationName - <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ơ<EFBFBD>
|
|||
|
|
* @param progress - ֹͣ<EFBFBD><EFBFBD><EFBFBD>ȡ<EFBFBD>
|
|||
|
|
* @returns <EFBFBD><EFBFBD><EFBFBD>ŵĶ<EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD>
|
|||
|
|
* @version DragonBones 4.5
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
AnimationState* gotoAndStopByProgress(const std::string& animationName, float progress = 0.f);
|
|||
|
|
/**
|
|||
|
|
* - Get a specific animation state.
|
|||
|
|
* @param animationName - The name of animation state.
|
|||
|
|
* @example
|
|||
|
|
* TypeScript style, for reference only.
|
|||
|
|
* <pre>
|
|||
|
|
* armature.animation.play("walk");
|
|||
|
|
* let walkState = armature.animation.getState("walk");
|
|||
|
|
* walkState.timeScale = 0.5;
|
|||
|
|
* </pre>
|
|||
|
|
* @version DragonBones 3.0
|
|||
|
|
* @language en_US
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD>ȡָ<EFBFBD><EFBFBD><EFBFBD>Ķ<EFBFBD><EFBFBD><EFBFBD>״̬
|
|||
|
|
* @param animationName - <EFBFBD><EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD><EFBFBD>ơ<EFBFBD>
|
|||
|
|
* @example
|
|||
|
|
* TypeScript <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ο<EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* <pre>
|
|||
|
|
* armature.animation.play("walk");
|
|||
|
|
* let walkState = armature.animation.getState("walk");
|
|||
|
|
* walkState.timeScale = 0.5;
|
|||
|
|
* </pre>
|
|||
|
|
* @version DragonBones 3.0
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
AnimationState* getState(const std::string& animationName) const;
|
|||
|
|
/**
|
|||
|
|
* - 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
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ƿ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ָ<EFBFBD><EFBFBD><EFBFBD>Ķ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* @param animationName - <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ơ<EFBFBD>
|
|||
|
|
* @see dragonBones.AnimationData
|
|||
|
|
* @version DragonBones 3.0
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
bool hasAnimation(const std::string& animationName) const;
|
|||
|
|
/**
|
|||
|
|
* - Get all the animation states.
|
|||
|
|
* @version DragonBones 5.1
|
|||
|
|
* @language en_US
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD>ȡ<EFBFBD><EFBFBD><EFBFBD>еĶ<EFBFBD><EFBFBD><EFBFBD>״̬
|
|||
|
|
* @version DragonBones 5.1
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
inline const std::vector<AnimationState*>& getStates() const
|
|||
|
|
{
|
|||
|
|
return _animationStates;
|
|||
|
|
}
|
|||
|
|
/**
|
|||
|
|
* - Check whether there is an animation state is playing
|
|||
|
|
* @see dragonBones.AnimationState
|
|||
|
|
* @version DragonBones 3.0
|
|||
|
|
* @language en_US
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ƿ<EFBFBD><EFBFBD>ж<EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD><EFBFBD>ڲ<EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* @see dragonBones.AnimationState
|
|||
|
|
* @version DragonBones 3.0
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
bool isPlaying() const;
|
|||
|
|
/**
|
|||
|
|
* - Check whether all the animation states' playing were finished.
|
|||
|
|
* @see dragonBones.AnimationState
|
|||
|
|
* @version DragonBones 3.0
|
|||
|
|
* @language en_US
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Ƿ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>еĶ<EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD><EFBFBD>Ѳ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ϡ<EFBFBD>
|
|||
|
|
* @see dragonBones.AnimationState
|
|||
|
|
* @version DragonBones 3.0
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
bool isCompleted() const;
|
|||
|
|
/**
|
|||
|
|
* - The name of the last playing animation state.
|
|||
|
|
* @see #lastAnimationState
|
|||
|
|
* @version DragonBones 3.0
|
|||
|
|
* @language en_US
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD>һ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ŵĶ<EFBFBD><EFBFBD><EFBFBD>״̬<EFBFBD><EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* @see #lastAnimationState
|
|||
|
|
* @version DragonBones 3.0
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
const std::string& getLastAnimationName() const;
|
|||
|
|
/**
|
|||
|
|
* - The name of all animation data
|
|||
|
|
* @version DragonBones 4.5
|
|||
|
|
* @language en_US
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD><EFBFBD>ж<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ݵ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* @version DragonBones 4.5
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
inline const std::vector<std::string>& getAnimationNames() const
|
|||
|
|
{
|
|||
|
|
return _animationNames;
|
|||
|
|
}
|
|||
|
|
/**
|
|||
|
|
* - All animation data.
|
|||
|
|
* @version DragonBones 4.5
|
|||
|
|
* @language en_US
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD><EFBFBD>еĶ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ݡ<EFBFBD>
|
|||
|
|
* @version DragonBones 4.5
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
inline const std::map<std::string, AnimationData*>& getAnimations() const
|
|||
|
|
{
|
|||
|
|
return _animations;
|
|||
|
|
}
|
|||
|
|
void setAnimations(const std::map<std::string, AnimationData*>& value);
|
|||
|
|
/**
|
|||
|
|
* - An AnimationConfig instance that can be used quickly.
|
|||
|
|
* @see dragonBones.AnimationConfig
|
|||
|
|
* @version DragonBones 5.0
|
|||
|
|
* @language en_US
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - һ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>Կ<EFBFBD><EFBFBD><EFBFBD>ʹ<EFBFBD>õĶ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ʵ<EFBFBD><EFBFBD><EFBFBD><EFBFBD>
|
|||
|
|
* @see dragonBones.AnimationConfig
|
|||
|
|
* @version DragonBones 5.0
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
AnimationConfig* getAnimationConfig() const;
|
|||
|
|
/**
|
|||
|
|
* - The last playing animation state
|
|||
|
|
* @see dragonBones.AnimationState
|
|||
|
|
* @version DragonBones 3.0
|
|||
|
|
* @language en_US
|
|||
|
|
*/
|
|||
|
|
/**
|
|||
|
|
* - <EFBFBD><EFBFBD>һ<EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD>ŵĶ<EFBFBD><EFBFBD><EFBFBD>״̬
|
|||
|
|
* @see dragonBones.AnimationState
|
|||
|
|
* @version DragonBones 3.0
|
|||
|
|
* @language zh_CN
|
|||
|
|
*/
|
|||
|
|
inline AnimationState* getLastAnimationState() const
|
|||
|
|
{
|
|||
|
|
return _lastAnimationState;
|
|||
|
|
}
|
|||
|
|
};
|
|||
|
|
|
|||
|
|
DRAGONBONES_NAMESPACE_END
|
|||
|
|
#endif // DRAGONBONES_ANIMATION_H
|