ParticleSystem Class Reference

Particle System base class. More...

#import <Particle.h>

Inherits CocosNode.

Inherited by ParticleExplosion, ParticleFire, ParticleFireworks, ParticleFlower, ParticleGalaxy, ParticleMeteor, ParticleRain, ParticleSmoke, ParticleSnow, ParticleSpiral, and ParticleSun.

Collaboration diagram for ParticleSystem:

[legend]

List of all members.

Public Member Functions
(id)	- initWithTotalParticles:
	Initializes a system with a fixed number of particles.
(BOOL)	- addParticle
	Add a particle to the emitter.
(void)	- initParticle:
	Initializes a particle.
(void)	- stopSystem
	stop emitting particles. Running particles will continue to run until they die
(void)	- resetSystem
	Kill all living particles.
(BOOL)	- isFull
	whether or not the system is full
Properties
BOOL	active
int	particleCount
CGPoint	gravity
	Gravity of the particles.
float	duration
CGPoint	source
CGPoint	posVar
float	life
float	lifeVar
float	angle
float	angleVar
float	speed
float	speedVar
float	tangentialAccel
float	tangentialAccelVar
float	radialAccel
float	radialAccelVar
float	size
float	sizeVar
ccColorF	startColor
ccColorF	startColorVar
ccColorF	endColor
ccColorF	endColorVar
float	emissionRate
int	totalParticles
Texture2D *	texture

---

Detailed Description

Particle System base class.

---

Member Function Documentation

- (BOOL) addParticle

Add a particle to the emitter.

- (void) initParticle:

(Particle *)

particle

Initializes a particle.

- (id) initWithTotalParticles:

(int)

numberOfParticles

Initializes a system with a fixed number of particles.

- (BOOL) isFull

whether or not the system is full

- (void) resetSystem

Kill all living particles.

- (void) stopSystem

stop emitting particles. Running particles will continue to run until they die

---

Property Documentation

- (BOOL) active [read, assign]

Is the emitter active

- (float) angle [read, write, assign]

angle and angle variation of each particle

- (float) angleVar [read, write, assign]

angle variance of each particle

- (float) duration [read, write, assign]

How many seconds the emitter wil run. -1 means 'forever'

- (float) emissionRate [read, write, assign]

emission rate of the particles

- (ccColorF) endColor [read, write, assign]

end color and end color variation of each particle

- (ccColorF) endColorVar [read, write, assign]

end color variance of each particle

- (CGPoint) gravity [read, write, assign]

Gravity of the particles.

Gravity value

- (float) life [read, write, assign]

life, and life variation of each particle

- (float) lifeVar [read, write, assign]

life variance of each particle

- (int) particleCount [read, assign]

Quantity of particles that are being simulated at the moment

- (CGPoint) posVar [read, write, assign]

Position variance of the emitter

- (float) radialAccel [read, write, assign]

radial acceleration of each particle

- (float) radialAccelVar [read, write, assign]

radial acceleration variance of each particle

- (float) size [read, write, assign]

size in pixels of each particle

- (float) sizeVar [read, write, assign]

size variance in pixels of each particle

- (CGPoint) source [read, write, assign]

Source location of particles respective to emitter location

- (float) speed [read, write, assign]

speed of each particle

- (float) speedVar [read, write, assign]

speed variance of each particle

- (ccColorF) startColor [read, write, assign]

start color of each particle

- (ccColorF) startColorVar [read, write, assign]

start color variance of each particle

- (float) tangentialAccel [read, write, assign]

tangential acceleration of each particle

- (float) tangentialAccelVar [read, write, assign]

tangential acceleration variance of each particle

- (Texture2D *) texture [read, write, retain]

texture used to render the particles

- (int) totalParticles [read, write, assign]

maximum particles of the system

---

The documentation for this class was generated from the following file:

• /Users/riq/progs/cocos2d-iphone/branches/branch-0.7/cocos2d/Particle.h