mirror of https://github.com/axmolengine/axmol.git
174 lines
6.5 KiB
C++
174 lines
6.5 KiB
C++
/****************************************************************************
|
|
Copyright (c) 2010-2011 cocos2d-x.org
|
|
Copyright (c) 2008-2010 Ricardo Quesada
|
|
Copyright (c) 2011 Zynga Inc.
|
|
|
|
http://www.cocos2d-x.org
|
|
|
|
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 __CC_ANIMATION_H__
|
|
#define __CC_ANIMATION_H__
|
|
|
|
#include "CCPlatformConfig.h"
|
|
#include "CCObject.h"
|
|
#include "CCArray.h"
|
|
#include "CCDictionary.h"
|
|
#include "CCGeometry.h"
|
|
#include "CCSpriteFrame.h"
|
|
#include <string>
|
|
|
|
NS_CC_BEGIN
|
|
|
|
class CCTexture2D;
|
|
class CCSpriteFrame;
|
|
|
|
/** CCAnimationFrame
|
|
A frame of the animation. It contains information like:
|
|
- sprite frame name
|
|
- # of delay units.
|
|
- offset
|
|
|
|
@since v2.0
|
|
*/
|
|
class CC_DLL CCAnimationFrame : public CCObject
|
|
{
|
|
public:
|
|
CCAnimationFrame();
|
|
virtual ~CCAnimationFrame();
|
|
virtual CCObject* copyWithZone(CCZone* pZone);
|
|
/** initializes the animation frame with a spriteframe, number of delay units and a notification user info */
|
|
bool initWithSpriteFrame(CCSpriteFrame* spriteFrame, float delayUnits, CCDictionary* userInfo);
|
|
|
|
/** CCSpriteFrameName to be used */
|
|
CC_SYNTHESIZE_RETAIN(CCSpriteFrame*, m_pSpriteFrame, SpriteFrame)
|
|
|
|
/** how many units of time the frame takes */
|
|
CC_SYNTHESIZE(float, m_fDelayUnits, DelayUnits)
|
|
|
|
/** A CCAnimationFrameDisplayedNotification notification will be broadcasted when the frame is displayed with this dictionary as UserInfo. If UserInfo is nil, then no notification will be broadcasted. */
|
|
CC_SYNTHESIZE_RETAIN(CCDictionary*, m_pUserInfo, UserInfo)
|
|
};
|
|
|
|
|
|
|
|
|
|
/** A CCAnimation object is used to perform animations on the CCSprite objects.
|
|
|
|
The CCAnimation object contains CCAnimationFrame objects, and a possible delay between the frames.
|
|
You can animate a CCAnimation object by using the CCAnimate action. Example:
|
|
|
|
[sprite runAction:[CCAnimate actionWithAnimation:animation]];
|
|
|
|
*/
|
|
class CC_DLL CCAnimation : public CCObject
|
|
{
|
|
public:
|
|
CCAnimation();
|
|
~CCAnimation(void);
|
|
public:
|
|
/** Creates an animation
|
|
@warning: This interface will be deprecated in future.
|
|
@since v0.99.5
|
|
*/
|
|
static CCAnimation* animation(void);
|
|
|
|
/* Creates an animation with an array of CCSpriteFrame and a delay between frames in seconds.
|
|
The frames will be added with one "delay unit".
|
|
@warning: This interface will be deprecated in future.
|
|
@since v0.99.5
|
|
*/
|
|
static CCAnimation* animationWithSpriteFrames(CCArray* arrayOfSpriteFrameNames, float delay = 0.0f);
|
|
|
|
/* Creates an animation with an array of CCAnimationFrame, the delay per units in seconds and and how many times it should be executed.
|
|
@warning: This interface will be deprecated in future.
|
|
@since v2.0
|
|
*/
|
|
static CCAnimation* animationWithAnimationFrames(CCArray *arrayOfAnimationFrameNames, float delayPerUnit, unsigned int loops);
|
|
|
|
/** Creates an animation
|
|
@since v0.99.5
|
|
*/
|
|
static CCAnimation* create(void);
|
|
|
|
/* Creates an animation with an array of CCSpriteFrame and a delay between frames in seconds.
|
|
The frames will be added with one "delay unit".
|
|
@since v0.99.5
|
|
*/
|
|
static CCAnimation* createWithSpriteFrames(CCArray* arrayOfSpriteFrameNames, float delay = 0.0f);
|
|
|
|
/* Creates an animation with an array of CCAnimationFrame, the delay per units in seconds and and how many times it should be executed.
|
|
@since v2.0
|
|
*/
|
|
static CCAnimation* createWithAnimationFrames(CCArray *arrayOfAnimationFrameNames, float delayPerUnit, unsigned int loops);
|
|
|
|
/** Adds a CCSpriteFrame to a CCAnimation.
|
|
The frame will be added with one "delay unit".
|
|
*/
|
|
void addSpriteFrame(CCSpriteFrame *pFrame);
|
|
|
|
/** Adds a frame with an image filename. Internally it will create a CCSpriteFrame 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.
|
|
*/
|
|
void addSpriteFrameWithFileName(const char *pszFileName);
|
|
|
|
/** Adds a frame with a texture and a rect. Internally it will create a CCSpriteFrame 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.
|
|
*/
|
|
void addSpriteFrameWithTexture(CCTexture2D* pobTexture, const CCRect& rect);
|
|
|
|
bool init();
|
|
|
|
/** Initializes a CCAnimation with frames and a delay between frames
|
|
@since v0.99.5
|
|
*/
|
|
bool initWithSpriteFrames(CCArray *pFrames, float delay = 0.0f);
|
|
|
|
/** Initializes a CCAnimation with CCAnimationFrame
|
|
@since v2.0
|
|
*/
|
|
bool initWithAnimationFrames(CCArray* arrayOfAnimationFrames, float delayPerUnit, unsigned int loops);
|
|
|
|
virtual CCObject* copyWithZone(CCZone* pZone);
|
|
|
|
/** total Delay units of the CCAnimation. */
|
|
CC_SYNTHESIZE_READONLY(float, m_fTotalDelayUnits, TotalDelayUnits)
|
|
|
|
/** Delay in seconds of the "delay unit" */
|
|
CC_SYNTHESIZE(float, m_fDelayPerUnit, DelayPerUnit)
|
|
|
|
/** duration in seconds of the whole animation. It is the result of totalDelayUnits * delayPerUnit */
|
|
CC_PROPERTY_READONLY(float, m_fDuration, Duration)
|
|
|
|
/** array of CCAnimationFrames */
|
|
CC_SYNTHESIZE_RETAIN(CCArray*, m_pFrames, Frames)
|
|
|
|
/** whether or not it shall restore the original frame when the animation finishes */
|
|
CC_SYNTHESIZE(bool, m_bRestoreOriginalFrame, RestoreOriginalFrame)
|
|
|
|
/** how many times the animation is going to loop. 0 means animation is not animated. 1, animation is executed one time, ... */
|
|
CC_SYNTHESIZE(unsigned int, m_uLoops, Loops)
|
|
};
|
|
|
|
NS_CC_END
|
|
|
|
#endif // __CC_ANIMATION_H__
|