/depot/cocosdocs/cocos2d-iphone-0.99.5/cocos2d/CCParticleSystem.h

/*
 * cocos2d for iPhone: http://www.cocos2d-iphone.org
 *
 * Copyright (c) 2008-2010 Ricardo Quesada
 * 
 * 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 {
         kCCParticleDurationInfinity = -1,

         kCCParticleStartSizeEqualToEndSize = -1,
         
         kCCParticleStartRadiusEqualToEndRadius = -1,

         // backward compatible
         kParticleStartSizeEqualToEndSize = kCCParticleStartSizeEqualToEndSize,
         kParticleDurationInfinity = kCCParticleDurationInfinity,
};

//* @enum
enum {
         kCCParticleModeGravity,
         
         kCCParticleModeRadius,     
};


typedef enum {
         kCCPositionTypeFree,

         kCCPositionTypeRelative,
         
         kCCPositionTypeGrouped,
}tCCPositionType;

// backward compatible
enum {
         kPositionTypeFree = kCCPositionTypeFree,
         kPositionTypeGrouped = kCCPositionTypeGrouped,
}; 

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;

@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
}

@property (nonatomic,readonly) BOOL active;
@property (nonatomic,readonly) NSUInteger    particleCount;
@property (nonatomic,readwrite,assign) float duration;
@property (nonatomic,readwrite,assign) CGPoint sourcePosition;
@property (nonatomic,readwrite,assign) CGPoint posVar;
@property (nonatomic,readwrite,assign) float life;
@property (nonatomic,readwrite,assign) float lifeVar;
@property (nonatomic,readwrite,assign) float angle;
@property (nonatomic,readwrite,assign) float angleVar;

@property (nonatomic,readwrite,assign) CGPoint gravity;
@property (nonatomic,readwrite,assign) float speed;
@property (nonatomic,readwrite,assign) float speedVar;
@property (nonatomic,readwrite,assign) float tangentialAccel;
@property (nonatomic,readwrite,assign) float tangentialAccelVar;
@property (nonatomic,readwrite,assign) float radialAccel;
@property (nonatomic,readwrite,assign) float radialAccelVar;

@property (nonatomic,readwrite,assign) float startRadius;
@property (nonatomic,readwrite,assign) float startRadiusVar;
@property (nonatomic,readwrite,assign) float endRadius;
@property (nonatomic,readwrite,assign) float endRadiusVar;                       
@property (nonatomic,readwrite,assign) float rotatePerSecond;
@property (nonatomic,readwrite,assign) float rotatePerSecondVar;

@property (nonatomic,readwrite,assign) float startSize;
@property (nonatomic,readwrite,assign) float startSizeVar;
@property (nonatomic,readwrite,assign) float endSize;
@property (nonatomic,readwrite,assign) float endSizeVar;
@property (nonatomic,readwrite,assign) ccColor4F startColor;
@property (nonatomic,readwrite,assign) ccColor4F startColorVar;
@property (nonatomic,readwrite,assign) ccColor4F endColor;
@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;
@property (nonatomic,readwrite,assign) float emissionRate;
@property (nonatomic,readwrite,assign) NSUInteger totalParticles;
@property (nonatomic,readwrite, retain) CCTexture2D * texture;
@property (nonatomic,readwrite) ccBlendFunc blendFunc;
@property (nonatomic,readwrite) BOOL blendAdditive;
@property (nonatomic,readwrite) tCCPositionType positionType;
@property (nonatomic,readwrite) BOOL autoRemoveOnFinish;
@property (nonatomic,readwrite) NSInteger emitterMode;

+(id) particleWithFile:(NSString*)plistFile;

-(id) initWithFile:(NSString*) plistFile;

-(id) initWithDictionary:(NSDictionary*)dictionary;

-(id) initWithTotalParticles:(int) numberOfParticles;
-(BOOL) addParticle;
-(void) initParticle: (tCCParticle*) particle;
-(void) stopSystem;
-(void) resetSystem;
-(BOOL) isFull;

-(void) updateQuadWithParticle:(tCCParticle*)particle newPosition:(CGPoint)pos;
-(void) postStep;

-(void) update: (ccTime) dt;

@end