1 files changed, 445 insertions, 0 deletions

@@ -0,0 +1,445 @@
+/*
+ * 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 "CCProtocols.h"
+#import "CCNode.h"
+#import "ccTypes.h"
+#import "ccConfig.h"
+
+#if CC_ENABLE_PROFILERS
+@class CCProfilingTimer;
+#endif
+
+//* @enum
+enum {
+        /** The Particle emitter lives forever */
+        kCCParticleDurationInfinity = -1,
+
+        /** The starting size of the particle is equal to the ending size */
+        kCCParticleStartSizeEqualToEndSize = -1,
+        
+        /** The starting radius of the particle is equal to the ending radius */
+        kCCParticleStartRadiusEqualToEndRadius = -1,
+
+        // backward compatible
+        kParticleStartSizeEqualToEndSize = kCCParticleStartSizeEqualToEndSize,
+        kParticleDurationInfinity = kCCParticleDurationInfinity,
+};
+
+//* @enum
+enum {
+        /** Gravity mode (A mode) */
+        kCCParticleModeGravity,
+        
+        /** Radius mode (B mode) */
+        kCCParticleModeRadius,  
+};
+
+
+/** @typedef tCCPositionType
+ possible types of particle positions
+ */
+typedef enum {
+        /** Living particles are attached to the world and are unaffected by emitter repositioning. */
+        kCCPositionTypeFree,
+
+        /** Living particles are attached to the world but will follow the emitter repositioning.
+         Use case: Attach an emitter to an sprite, and you want that the emitter follows the sprite.
+         */
+        kCCPositionTypeRelative,
+        
+        /** Living particles are attached to the emitter and are translated along with it. */
+        kCCPositionTypeGrouped,
+}tCCPositionType;
+
+// backward compatible
+enum {
+        kPositionTypeFree = kCCPositionTypeFree,
+        kPositionTypeGrouped = kCCPositionTypeGrouped,
+}; 
+
+/** @struct tCCParticle
+ Structure that contains the values of each particle
+ */
+typedef struct sCCParticle {
+        CGPoint         pos;
+        CGPoint         startPos;
+
+        ccColor4F       color;
+        ccColor4F       deltaColor;
+
+        float           size;
+        float           deltaSize;
+
+        float           rotation;
+        float           deltaRotation;
+
+        ccTime          timeToLive;
+
+        union {
+                // Mode A: gravity, direction, radial accel, tangential accel
+                struct {
+                        CGPoint         dir;
+                        float           radialAccel;
+                        float           tangentialAccel;
+                } A;
+        
+                // Mode B: radius mode
+                struct {
+                        float           angle;
+                        float           degreesPerSecond;
+                        float           radius;
+                        float           deltaRadius;
+                } B;
+        } mode;
+
+}tCCParticle;
+
+typedef void (*CC_UPDATE_PARTICLE_IMP)(id, SEL, tCCParticle*, CGPoint);
+
+@class CCTexture2D;
+
+/** Particle System base class
+ Attributes of a Particle System:
+        - emmision rate of the particles
+        - Gravity Mode (Mode A):
+                - gravity
+                - direction
+                - speed +-  variance
+                - tangential acceleration +- variance
+                - radial acceleration +- variance
+        - Radius Mode (Mode B):
+                - startRadius +- variance
+                - endRadius +- variance
+                - rotate +- variance
+        - Properties common to all modes:
+                - life +- life variance
+                - start spin +- variance
+                - end spin +- variance
+                - start size +- variance
+                - end size +- variance
+                - start color +- variance
+                - end color +- variance
+                - life +- variance
+                - blending function
+        - texture
+
+ cocos2d also supports particles generated by Particle Designer (http://particledesigner.71squared.com/).
+ 'Radius Mode' in Particle Designer uses a fixed emit rate of 30 hz. Since that can't be guarateed in cocos2d,
+ cocos2d uses a another approach, but the results are almost identical. 
+ 
+ cocos2d supports all the variables used by Particle Designer plus a bit more:
+        - spinning particles (supported when using CCParticleSystemQuad)
+        - tangential acceleration (Gravity mode)
+        - radial acceleration (Gravity mode)
+        - radius direction (Radius mode) (Particle Designer supports outwards to inwards direction only)
+ 
+ It is possible to customize any of the above mentioned properties in runtime. Example:
+ 
+ @code
+        emitter.radialAccel = 15;
+        emitter.startSpin = 0;
+ @endcode
+ 
+ */
+@interface CCParticleSystem : CCNode <CCTextureProtocol>
+{       
+        // is the particle system active ?
+        BOOL active;
+        // duration in seconds of the system. -1 is infinity
+        float duration;
+        // time elapsed since the start of the system (in seconds)
+        float elapsed;
+        
+        // position is from "superclass" CocosNode
+        CGPoint sourcePosition;
+        // Position variance
+        CGPoint posVar;
+        
+        // The angle (direction) of the particles measured in degrees
+        float angle;
+        // Angle variance measured in degrees;
+        float angleVar;
+        
+        // Different modes
+        
+        NSInteger emitterMode_;
+        union {
+                // Mode A:Gravity + Tangential Accel + Radial Accel
+                struct {
+                        // gravity of the particles
+                        CGPoint gravity;
+
+                        // The speed the particles will have.
+                        float speed;
+                        // The speed variance
+                        float speedVar;
+
+                        // Tangential acceleration
+                        float tangentialAccel;
+                        // Tangential acceleration variance
+                        float tangentialAccelVar;
+
+                        // Radial acceleration
+                        float radialAccel;
+                        // Radial acceleration variance
+                        float radialAccelVar;
+                        } A;
+
+                // Mode B: circular movement (gravity, radial accel and tangential accel don't are not used in this mode)
+                struct {
+        
+                        // The starting radius of the particles
+                        float startRadius;
+                        // The starting radius variance of the particles
+                        float startRadiusVar;
+                        // The ending radius of the particles
+                        float endRadius;
+                        // The ending radius variance of the particles
+                        float endRadiusVar;                     
+                        // Number of degress to rotate a particle around the source pos per second
+                        float rotatePerSecond;
+                        // Variance in degrees for rotatePerSecond
+                        float rotatePerSecondVar;
+                } B;
+        } mode;
+        
+        // start ize of the particles
+        float startSize;
+        // start Size variance
+        float startSizeVar;
+        // End size of the particle
+        float endSize;
+        // end size of variance
+        float endSizeVar;
+        
+        // How many seconds will the particle live
+        float life;
+        // Life variance
+        float lifeVar;
+        
+        // Start color of the particles
+        ccColor4F startColor;
+        // Start color variance
+        ccColor4F startColorVar;
+        // End color of the particles
+        ccColor4F endColor;
+        // End color variance
+        ccColor4F endColorVar;
+        
+        // start angle of the particles
+        float startSpin;
+        // start angle variance
+        float startSpinVar;
+        // End angle of the particle
+        float endSpin;
+        // end angle ariance
+        float endSpinVar;
+        
+        
+        // Array of particles
+        tCCParticle *particles;
+        // Maximum particles
+        NSUInteger totalParticles;
+        // Count of active particles
+        NSUInteger particleCount;
+        
+        // color modulate
+//      BOOL colorModulate;
+        
+        // How many particles can be emitted per second
+        float emissionRate;
+        float emitCounter;
+        
+        // Texture of the particles
+        CCTexture2D *texture_;
+        // blend function
+        ccBlendFunc     blendFunc_;
+
+        // movment type: free or grouped
+        tCCPositionType positionType_;
+
+        // Whether or not the node will be auto-removed when there are not particles
+        BOOL    autoRemoveOnFinish_;
+
+        //  particle idx
+        NSUInteger particleIdx;
+        
+        // Optimization
+        CC_UPDATE_PARTICLE_IMP  updateParticleImp;
+        SEL                                             updateParticleSel;
+        
+// profiling
+#if CC_ENABLE_PROFILERS
+        CCProfilingTimer* _profilingTimer;
+#endif
+}
+
+/** Is the emitter active */
+@property (nonatomic,readonly) BOOL active;
+/** Quantity of particles that are being simulated at the moment */
+@property (nonatomic,readonly) NSUInteger       particleCount;
+/** How many seconds the emitter wil run. -1 means 'forever' */
+@property (nonatomic,readwrite,assign) float duration;
+/** sourcePosition of the emitter */
+@property (nonatomic,readwrite,assign) CGPoint sourcePosition;
+/** Position variance of the emitter */
+@property (nonatomic,readwrite,assign) CGPoint posVar;
+/** life, and life variation of each particle */
+@property (nonatomic,readwrite,assign) float life;
+/** life variance of each particle */
+@property (nonatomic,readwrite,assign) float lifeVar;
+/** angle and angle variation of each particle */
+@property (nonatomic,readwrite,assign) float angle;
+/** angle variance of each particle */
+@property (nonatomic,readwrite,assign) float angleVar;
+
+/** Gravity value. Only available in 'Gravity' mode. */
+@property (nonatomic,readwrite,assign) CGPoint gravity;
+/** speed of each particle. Only available in 'Gravity' mode.  */
+@property (nonatomic,readwrite,assign) float speed;
+/** speed variance of each particle. Only available in 'Gravity' mode. */
+@property (nonatomic,readwrite,assign) float speedVar;
+/** tangential acceleration of each particle. Only available in 'Gravity' mode. */
+@property (nonatomic,readwrite,assign) float tangentialAccel;
+/** tangential acceleration variance of each particle. Only available in 'Gravity' mode. */
+@property (nonatomic,readwrite,assign) float tangentialAccelVar;
+/** radial acceleration of each particle. Only available in 'Gravity' mode. */
+@property (nonatomic,readwrite,assign) float radialAccel;
+/** radial acceleration variance of each particle. Only available in 'Gravity' mode. */
+@property (nonatomic,readwrite,assign) float radialAccelVar;
+
+/** The starting radius of the particles. Only available in 'Radius' mode. */
+@property (nonatomic,readwrite,assign) float startRadius;
+/** The starting radius variance of the particles. Only available in 'Radius' mode. */
+@property (nonatomic,readwrite,assign) float startRadiusVar;
+/** The ending radius of the particles. Only available in 'Radius' mode. */
+@property (nonatomic,readwrite,assign) float endRadius;
+/** The ending radius variance of the particles. Only available in 'Radius' mode. */
+@property (nonatomic,readwrite,assign) float endRadiusVar;                      
+/** Number of degress to rotate a particle around the source pos per second. Only available in 'Radius' mode. */
+@property (nonatomic,readwrite,assign) float rotatePerSecond;
+/** Variance in degrees for rotatePerSecond. Only available in 'Radius' mode. */
+@property (nonatomic,readwrite,assign) float rotatePerSecondVar;
+
+/** start size in pixels of each particle */
+@property (nonatomic,readwrite,assign) float startSize;
+/** size variance in pixels of each particle */
+@property (nonatomic,readwrite,assign) float startSizeVar;
+/** end size in pixels of each particle */
+@property (nonatomic,readwrite,assign) float endSize;
+/** end size variance in pixels of each particle */
+@property (nonatomic,readwrite,assign) float endSizeVar;
+/** start color of each particle */
+@property (nonatomic,readwrite,assign) ccColor4F startColor;
+/** start color variance of each particle */
+@property (nonatomic,readwrite,assign) ccColor4F startColorVar;
+/** end color and end color variation of each particle */
+@property (nonatomic,readwrite,assign) ccColor4F endColor;
+/** end color variance of each particle */
+@property (nonatomic,readwrite,assign) ccColor4F endColorVar;
+//* initial angle of each particle
+@property (nonatomic,readwrite,assign) float startSpin;
+//* initial angle of each particle
+@property (nonatomic,readwrite,assign) float startSpinVar;
+//* initial angle of each particle
+@property (nonatomic,readwrite,assign) float endSpin;
+//* initial angle of each particle
+@property (nonatomic,readwrite,assign) float endSpinVar;
+/** emission rate of the particles */
+@property (nonatomic,readwrite,assign) float emissionRate;
+/** maximum particles of the system */
+@property (nonatomic,readwrite,assign) NSUInteger totalParticles;
+/** conforms to CocosNodeTexture protocol */
+@property (nonatomic,readwrite, retain) CCTexture2D * texture;
+/** conforms to CocosNodeTexture protocol */
+@property (nonatomic,readwrite) ccBlendFunc blendFunc;
+/** whether or not the particles are using blend additive.
+ If enabled, the following blending function will be used.
+ @code
+        source blend function = GL_SRC_ALPHA;
+        dest blend function = GL_ONE;
+ @endcode
+ */
+@property (nonatomic,readwrite) BOOL blendAdditive;
+/** particles movement type: Free or Grouped
+ @since v0.8
+ */
+@property (nonatomic,readwrite) tCCPositionType positionType;
+/** whether or not the node will be auto-removed when it has no particles left.
+ By default it is NO.
+ @since v0.8
+ */
+@property (nonatomic,readwrite) BOOL autoRemoveOnFinish;
+/** Switch between different kind of emitter modes:
+   - kCCParticleModeGravity: uses gravity, speed, radial and tangential acceleration
+   - kCCParticleModeRadius: uses radius movement + rotation
+ */
+@property (nonatomic,readwrite) NSInteger emitterMode;
+
+/** creates an initializes a CCParticleSystem from a plist file.
+ This plist files can be creted manually or with Particle Designer:
+        http://particledesigner.71squared.com/
+ @since v0.99.3
+ */
++(id) particleWithFile:(NSString*)plistFile;
+
+/** initializes a CCParticleSystem from a plist file.
+ This plist files can be creted manually or with Particle Designer:
+        http://particledesigner.71squared.com/
+ @since v0.99.3
+ */
+-(id) initWithFile:(NSString*) plistFile;
+
+/** initializes a CCQuadParticleSystem from a NSDictionary.
+ @since v0.99.3
+ */
+-(id) initWithDictionary:(NSDictionary*)dictionary;
+
+//! Initializes a system with a fixed number of particles
+-(id) initWithTotalParticles:(NSUInteger) numberOfParticles;
+//! Add a particle to the emitter
+-(BOOL) addParticle;
+//! Initializes a particle
+-(void) initParticle: (tCCParticle*) particle;
+//! stop emitting particles. Running particles will continue to run until they die
+-(void) stopSystem;
+//! Kill all living particles.
+-(void) resetSystem;
+//! whether or not the system is full
+-(BOOL) isFull;
+
+//! should be overriden by subclasses
+-(void) updateQuadWithParticle:(tCCParticle*)particle newPosition:(CGPoint)pos;
+//! should be overriden by subclasses
+-(void) postStep;
+
+//! called in every loop.
+-(void) update: (ccTime) dt;
+
+@end
+