Particle System

Classes
class	ParticleBatchNode
	ParticleBatchNode is like a batch node: if it contains children, it will draw them in 1 single OpenGL call (often known as "batch draw"). More...
class	ParticleFire
	A fire particle system. More...
class	ParticleFireworks
	A fireworks particle system. More...
class	ParticleSun
	A sun particle system. More...
class	ParticleGalaxy
	A galaxy particle system. More...
class	ParticleFlower
	A flower particle system. More...
class	ParticleMeteor
	A meteor particle system. More...
class	ParticleSpiral
	An spiral particle system. More...
class	ParticleExplosion
	An explosion particle system. More...
class	ParticleSmoke
	An smoke particle system. More...
class	ParticleSnow
	An snow particle system. More...
class	ParticleRain
	A rain particle system. More...
struct	tParticle
	Structure that contains the values of each particle. More...
class	ParticleSystem
	Particle System base class. More...
class	ParticleSystemQuad
	ParticleSystemQuad is a subclass of ParticleSystem. More...

Macros
#define	kParticleDefaultCapacity   500

Enumerations
enum	Mode { GRAVITY, RADIUS }
enum	PositionType { FREE, RELATIVE, GROUPED }
	possible types of particle positions More...
enum	{ DURATION_INFINITY = -1, START_SIZE_EQUAL_TO_END_SIZE = -1, START_RADIUS_EQUAL_TO_END_RADIUS = -1 }

Detailed Description

Macro Definition Documentation

#define kParticleDefaultCapacity   500

var kParticleDefaultCapacity   500

local kParticleDefaultCapacity   500

Enumeration Type Documentation

anonymous enum

Enumerator
DURATION_INFINITY	The Particle emitter lives forever.
START_SIZE_EQUAL_TO_END_SIZE	The starting size of the particle is equal to the ending size.
START_RADIUS_EQUAL_TO_END_RADIUS	The starting radius of the particle is equal to the ending radius.

var enum

Enumerator
DURATION_INFINITY	The Particle emitter lives forever.
START_SIZE_EQUAL_TO_END_SIZE	The starting size of the particle is equal to the ending size.
START_RADIUS_EQUAL_TO_END_RADIUS	The starting radius of the particle is equal to the ending radius.

local enum

Enumerator
DURATION_INFINITY	The Particle emitter lives forever.
START_SIZE_EQUAL_TO_END_SIZE	The starting size of the particle is equal to the ending size.
START_RADIUS_EQUAL_TO_END_RADIUS	The starting radius of the particle is equal to the ending radius.

enum Mode

strong

Enumerator
GRAVITY
RADIUS

var Mode

strong

Enumerator
GRAVITY
RADIUS

local Mode

strong

Enumerator
GRAVITY
RADIUS

enum PositionType

strong

possible types of particle positions

Enumerator
FREE	Living particles are attached to the world and are unaffected by emitter repositioning.
RELATIVE	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.
GROUPED	Living particles are attached to the emitter and are translated along with it.

var PositionType

strong

possible types of particle positions

Enumerator
FREE	Living particles are attached to the world and are unaffected by emitter repositioning.
RELATIVE	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.
GROUPED	Living particles are attached to the emitter and are translated along with it.

local PositionType

strong

possible types of particle positions

Enumerator
FREE	Living particles are attached to the world and are unaffected by emitter repositioning.
RELATIVE	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.
GROUPED	Living particles are attached to the emitter and are translated along with it.