mirror of https://github.com/axmolengine/axmol.git
326 lines
11 KiB
C++
326 lines
11 KiB
C++
/****************************************************************************
|
|
Copyright (c) 2008-2010 Ricardo Quesada
|
|
Copyright (c) 2010-2012 cocos2d-x.org
|
|
Copyright (c) 2011 Zynga Inc.
|
|
Copyright (c) 2013-2016 Chukong Technologies Inc.
|
|
Copyright (c) 2017-2018 Xiamen Yaji Software Co., Ltd.
|
|
|
|
https://axmolengine.github.io/
|
|
|
|
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 __AX_ANIMATION_H__
|
|
#define __AX_ANIMATION_H__
|
|
|
|
#include "platform/PlatformConfig.h"
|
|
#include "base/Object.h"
|
|
#include "base/Value.h"
|
|
#include "base/Vector.h"
|
|
#include "2d/SpriteFrame.h"
|
|
|
|
#include <string>
|
|
|
|
NS_AX_BEGIN
|
|
|
|
class Texture2D;
|
|
class SpriteFrame;
|
|
|
|
/**
|
|
* @addtogroup _2d
|
|
* @{
|
|
*/
|
|
|
|
/** @class AnimationFrame
|
|
*
|
|
* A frame of the animation. It contains information like:
|
|
* - sprite frame name.
|
|
* - # of delay units.
|
|
* - offset
|
|
|
|
@since v2.0
|
|
*/
|
|
class AX_DLL AnimationFrame : public Object, public Clonable
|
|
{
|
|
public:
|
|
/** @struct DisplayedEventInfo
|
|
* When the animation display,Dispatches the event of UserData.
|
|
*/
|
|
struct DisplayedEventInfo
|
|
{
|
|
Node* target;
|
|
const ValueMap* userInfo;
|
|
};
|
|
|
|
/**
|
|
* Creates the animation frame with a spriteframe, number of delay units and a notification user info.
|
|
*
|
|
* @param spriteFrame The animation frame with a spriteframe.
|
|
* @param delayUnits Number of delay units.
|
|
* @param userInfo A notification user info.
|
|
* @since 3.0
|
|
*/
|
|
static AnimationFrame* create(SpriteFrame* spriteFrame, float delayUnits, const ValueMap& userInfo);
|
|
/** Return a SpriteFrameName to be used.
|
|
*
|
|
* @return a SpriteFrameName to be used.
|
|
*/
|
|
SpriteFrame* getSpriteFrame() const { return _spriteFrame; };
|
|
/** Set the SpriteFrame.
|
|
*
|
|
* @param frame A SpriteFrame will be used.
|
|
*/
|
|
void setSpriteFrame(SpriteFrame* frame)
|
|
{
|
|
AX_SAFE_RETAIN(frame);
|
|
AX_SAFE_RELEASE(_spriteFrame);
|
|
_spriteFrame = frame;
|
|
}
|
|
|
|
/** Gets the units of time the frame takes.
|
|
*
|
|
* @return The units of time the frame takes.
|
|
*/
|
|
float getDelayUnits() const { return _delayUnits; };
|
|
|
|
/** Sets the units of time the frame takes.
|
|
*
|
|
* @param delayUnits The units of time the frame takes.
|
|
*/
|
|
void setDelayUnits(float delayUnits) { _delayUnits = delayUnits; };
|
|
|
|
/** @brief Gets user information
|
|
* A AnimationFrameDisplayedNotification notification will be broadcast when the frame is displayed with this
|
|
* dictionary as UserInfo. If UserInfo is nil, then no notification will be broadcast.
|
|
*
|
|
* @return A dictionary as UserInfo
|
|
*/
|
|
const ValueMap& getUserInfo() const { return _userInfo; };
|
|
ValueMap& getUserInfo() { return _userInfo; };
|
|
|
|
/** Sets user information.
|
|
* @param userInfo A dictionary as UserInfo.
|
|
*/
|
|
void setUserInfo(const ValueMap& userInfo) { _userInfo = userInfo; }
|
|
|
|
// Overrides
|
|
virtual AnimationFrame* clone() const override;
|
|
|
|
/**
|
|
* @js ctor
|
|
*/
|
|
AnimationFrame();
|
|
/**
|
|
* @js NA
|
|
* @lua NA
|
|
*/
|
|
virtual ~AnimationFrame();
|
|
|
|
/** initializes the animation frame with a spriteframe, number of delay units and a notification user info */
|
|
bool initWithSpriteFrame(SpriteFrame* spriteFrame, float delayUnits, const ValueMap& userInfo);
|
|
|
|
protected:
|
|
/** SpriteFrameName to be used */
|
|
SpriteFrame* _spriteFrame;
|
|
|
|
/** how many units of time the frame takes */
|
|
float _delayUnits;
|
|
|
|
/** A AnimationFrameDisplayedNotification notification will be broadcast when the frame is displayed with this
|
|
* dictionary as UserInfo. If UserInfo is nil, then no notification will be broadcast. */
|
|
ValueMap _userInfo;
|
|
|
|
private:
|
|
AX_DISALLOW_COPY_AND_ASSIGN(AnimationFrame);
|
|
};
|
|
|
|
/** @class Animation
|
|
* A Animation object is used to perform animations on the Sprite objects.
|
|
* The Animation object contains AnimationFrame objects, and a possible delay between the frames.
|
|
* You can animate a Animation object by using the Animate action. Example:
|
|
* @code
|
|
* sprite->runAction(Animate::create(animation));
|
|
* @endcode
|
|
*/
|
|
class AX_DLL Animation : public Object, public Clonable
|
|
{
|
|
public:
|
|
/** Creates an animation.
|
|
* @since v0.99.5
|
|
*/
|
|
static Animation* create();
|
|
|
|
/* Creates an animation with an array of SpriteFrame and a delay between frames in seconds.
|
|
* The frames will be added with one "delay unit".
|
|
* @since v0.99.5
|
|
* @param arrayOfSpriteFrameNames An array of SpriteFrame.
|
|
* @param delay A delay between frames in seconds.
|
|
* @param loops The times the animation is going to loop.
|
|
*/
|
|
static Animation* createWithSpriteFrames(const Vector<SpriteFrame*>& arrayOfSpriteFrameNames,
|
|
float delay = 0.0f,
|
|
unsigned int loops = 1);
|
|
|
|
/* Creates an animation with an array of AnimationFrame, the delay per units in seconds and how many times it should
|
|
* be executed.
|
|
* @since v2.0
|
|
* @param arrayOfAnimationFrameNames An animation with an array of AnimationFrame.
|
|
* @param delayPerUnit The delay per units in seconds and how many times it should be executed.
|
|
* @param loops The times the animation is going to loop.
|
|
*/
|
|
static Animation* create(const Vector<AnimationFrame*>& arrayOfAnimationFrameNames,
|
|
float delayPerUnit,
|
|
unsigned int loops = 1);
|
|
|
|
/** Adds a SpriteFrame to a Animation.
|
|
*
|
|
* @param frame The frame will be added with one "delay unit".
|
|
*/
|
|
void addSpriteFrame(SpriteFrame* frame);
|
|
|
|
/** Adds a frame with an image filename. Internally it will create a SpriteFrame and it will add it.
|
|
* The frame will be added with one "delay unit".
|
|
* Added to facilitate the migration from v0.8 to v0.9.
|
|
* @param filename The path of SpriteFrame.
|
|
*/
|
|
void addSpriteFrameWithFile(std::string_view filename);
|
|
|
|
/** Adds a frame with a texture and a rect. Internally it will create a SpriteFrame and it will add it.
|
|
* The frame will be added with one "delay unit".
|
|
* Added to facilitate the migration from v0.8 to v0.9.
|
|
* @param pobTexture A frame with a texture.
|
|
* @param rect The Texture of rect.
|
|
*/
|
|
void addSpriteFrameWithTexture(Texture2D* pobTexture, const Rect& rect);
|
|
|
|
/** Gets the total Delay units of the Animation.
|
|
*
|
|
* @return The total Delay units of the Animation.
|
|
*/
|
|
float getTotalDelayUnits() const { return _totalDelayUnits; };
|
|
|
|
/** Sets the delay in seconds of the "delay unit".
|
|
*
|
|
* @param delayPerUnit The delay in seconds of the "delay unit".
|
|
*/
|
|
void setDelayPerUnit(float delayPerUnit) { _delayPerUnit = delayPerUnit; };
|
|
|
|
/** Gets the delay in seconds of the "delay unit".
|
|
*
|
|
* @return The delay in seconds of the "delay unit".
|
|
*/
|
|
float getDelayPerUnit() const { return _delayPerUnit; };
|
|
|
|
/** Gets the duration in seconds of the whole animation. It is the result of totalDelayUnits * delayPerUnit.
|
|
*
|
|
* @return Result of totalDelayUnits * delayPerUnit.
|
|
*/
|
|
float getDuration() const;
|
|
|
|
/** Gets the array of AnimationFrames.
|
|
*
|
|
* @return The array of AnimationFrames.
|
|
*/
|
|
const Vector<AnimationFrame*>& getFrames() const { return _frames; };
|
|
|
|
/** Sets the array of AnimationFrames.
|
|
*
|
|
* @param frames The array of AnimationFrames.
|
|
*/
|
|
void setFrames(const Vector<AnimationFrame*>& frames) { _frames = frames; }
|
|
|
|
/** Checks whether to restore the original frame when animation finishes.
|
|
*
|
|
* @return Restore the original frame when animation finishes.
|
|
*/
|
|
bool getRestoreOriginalFrame() const { return _restoreOriginalFrame; };
|
|
|
|
/** Sets whether to restore the original frame when animation finishes.
|
|
*
|
|
* @param restoreOriginalFrame Whether to restore the original frame when animation finishes.
|
|
*/
|
|
void setRestoreOriginalFrame(bool restoreOriginalFrame) { _restoreOriginalFrame = restoreOriginalFrame; };
|
|
|
|
/** Gets the times the animation is going to loop. 0 means animation is not animated. 1, animation is executed one
|
|
* time, ...
|
|
*
|
|
* @return The times the animation is going to loop.
|
|
*/
|
|
unsigned int getLoops() const { return _loops; };
|
|
|
|
/** Sets the times the animation is going to loop. 0 means animation is not animated. 1, animation is executed one
|
|
* time, ...
|
|
*
|
|
* @param loops The times the animation is going to loop.
|
|
*/
|
|
void setLoops(unsigned int loops) { _loops = loops; };
|
|
|
|
// overrides
|
|
virtual Animation* clone() const override;
|
|
|
|
Animation();
|
|
virtual ~Animation();
|
|
|
|
/** Initializes a Animation. */
|
|
bool init();
|
|
|
|
/** Initializes a Animation with frames and a delay between frames.
|
|
* @since v0.99.5
|
|
*/
|
|
bool initWithSpriteFrames(const Vector<SpriteFrame*>& arrayOfSpriteFrameNames,
|
|
float delay = 0.0f,
|
|
unsigned int loops = 1);
|
|
|
|
/** Initializes a Animation with AnimationFrame.
|
|
* @since v2.0
|
|
*/
|
|
bool initWithAnimationFrames(const Vector<AnimationFrame*>& arrayOfAnimationFrameNames,
|
|
float delayPerUnit,
|
|
unsigned int loops);
|
|
|
|
protected:
|
|
/** total Delay units of the Animation. */
|
|
float _totalDelayUnits;
|
|
|
|
/** Delay in seconds of the "delay unit". */
|
|
float _delayPerUnit;
|
|
|
|
/** duration in seconds of the whole animation. It is the result of totalDelayUnits * delayPerUnit. */
|
|
float _duration;
|
|
|
|
/** array of AnimationFrames. */
|
|
Vector<AnimationFrame*> _frames;
|
|
|
|
/** whether or not it shall restore the original frame when the animation finishes. */
|
|
bool _restoreOriginalFrame;
|
|
|
|
/** how many times the animation is going to loop. 0 means animation is not animated. 1, animation is executed one
|
|
* time, ... */
|
|
unsigned int _loops;
|
|
|
|
private:
|
|
AX_DISALLOW_COPY_AND_ASSIGN(Animation);
|
|
};
|
|
|
|
// end of sprite_nodes group
|
|
/// @}
|
|
|
|
NS_AX_END
|
|
|
|
#endif // __AX_ANIMATION_H__
|