summary refs log tree commit diff stats
path: root/libs/cocos2d/CCAnimation.h
blob: 24b3d961921dd66fd3204f49025dc1ee99a4818a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*
 * cocos2d for iPhone: http://www.cocos2d-iphone.org
 *
 * Copyright (c) 2008-2010 Ricardo Quesada
 * Copyright (c) 2011 Zynga Inc.
 * 
 * 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.
 *
 */

#import <Foundation/Foundation.h>
#ifdef __IPHONE_OS_VERSION_MAX_ALLOWED
#import <CoreGraphics/CoreGraphics.h>
#endif // IPHONE

@class CCSpriteFrame;
@class CCTexture2D;

/** A CCAnimation object is used to perform animations on the CCSprite objects.
 
 The CCAnimation object contains CCSpriteFrame 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]];
 
 */
@interface CCAnimation : NSObject
{
	NSString			*name_;
	float				delay_;
	NSMutableArray		*frames_;
}

/** name of the animation */
@property (nonatomic,readwrite,retain) NSString *name;
/** delay between frames in seconds. */
@property (nonatomic,readwrite,assign) float delay;
/** array of frames */
@property (nonatomic,readwrite,retain) NSMutableArray *frames;

/** Creates an animation
 @since v0.99.5
 */
+(id) animation;

/** Creates an animation with frames.
 @since v0.99.5
 */
+(id) animationWithFrames:(NSArray*)frames;

/* Creates an animation with frames and a delay between frames.
 @since v0.99.5
 */
+(id) animationWithFrames:(NSArray*)frames delay:(float)delay;

/** Creates a CCAnimation with a name
 @since v0.99.3
 @deprecated Will be removed in 1.0.1. Use "animation" instead.
 */
+(id) animationWithName:(NSString*)name DEPRECATED_ATTRIBUTE;

/** Creates a CCAnimation with a name and frames
 @since v0.99.3
 @deprecated Will be removed in 1.0.1. Use "animationWithFrames" instead.
 */
+(id) animationWithName:(NSString*)name frames:(NSArray*)frames DEPRECATED_ATTRIBUTE;

/** Creates a CCAnimation with a name and delay between frames. */
+(id) animationWithName:(NSString*)name delay:(float)delay DEPRECATED_ATTRIBUTE;

/** Creates a CCAnimation with a name, delay and an array of CCSpriteFrames. */
+(id) animationWithName:(NSString*)name delay:(float)delay frames:(NSArray*)frames DEPRECATED_ATTRIBUTE;


/** Initializes a CCAnimation with frames.
 @since v0.99.5
*/
-(id) initWithFrames:(NSArray*)frames;

/** Initializes a CCAnimation with frames and a delay between frames
 @since v0.99.5
 */
-(id) initWithFrames:(NSArray *)frames delay:(float)delay;

/** Initializes a CCAnimation with a name
 @since v0.99.3
 @deprecated Will be removed in 1.0.1. Use "init" instead.
 */
-(id) initWithName:(NSString*)name DEPRECATED_ATTRIBUTE;

/** Initializes a CCAnimation with a name and frames
 @since v0.99.3
 @deprecated Will be removed in 1.0.1. Use "initWithFrames" instead.
 */
-(id) initWithName:(NSString*)name frames:(NSArray*)frames DEPRECATED_ATTRIBUTE;

/** Initializes a CCAnimation with a name and delay between frames.
 @deprecated Will be removed in 1.0.1. Use "initWithFrames:nil delay:delay" instead.
*/
-(id) initWithName:(NSString*)name delay:(float)delay DEPRECATED_ATTRIBUTE;

/** Initializes a CCAnimation with a name, delay and an array of CCSpriteFrames.
 @deprecated Will be removed in 1.0.1. Use "initWithFrames:frames delay:delay" instead.
*/
-(id) initWithName:(NSString*)name delay:(float)delay frames:(NSArray*)frames DEPRECATED_ATTRIBUTE;

/** Adds a frame to a CCAnimation. */
-(void) addFrame:(CCSpriteFrame*)frame;

/** Adds a frame with an image filename. Internally it will create a CCSpriteFrame and it will add it.
 Added to facilitate the migration from v0.8 to v0.9.
 */
-(void) addFrameWithFilename:(NSString*)filename;

/** Adds a frame with a texture and a rect. Internally it will create a CCSpriteFrame and it will add it.
 Added to facilitate the migration from v0.8 to v0.9.
 */
-(void) addFrameWithTexture:(CCTexture2D*)texture rect:(CGRect)rect;

@end