Polycode
Polycode::SceneParticleEmitter Class Reference

3D particle emitter. More...

Inherits Polycode::SceneEntity, and Polycode::ParticleEmitter.

List of all members.

Public Member Functions

 SceneParticleEmitter (const String &materialName, Scene *particleParentScene, int particleType, int emitterType, Number lifespan, unsigned int numParticles, Vector3 direction, Vector3 gravity, Vector3 deviation, Vector3 emitterRadius, Mesh *particleMesh=NULL, SceneMesh *emitter=NULL)
 Constructor.
ParticleEmittergetEmitter ()
 Returns the emitter (helper method for LUA).
void Update ()
 Main update method.

Detailed Description

3D particle emitter.


Constructor & Destructor Documentation

SceneParticleEmitter::SceneParticleEmitter ( const String materialName,
Scene particleParentScene,
int  particleType,
int  emitterType,
Number  lifespan,
unsigned int  numParticles,
Vector3  direction,
Vector3  gravity,
Vector3  deviation,
Vector3  emitterRadius,
Mesh particleMesh = NULL,
SceneMesh emitter = NULL 
)

Constructor.

Parameters:
materialNameName of the material to use for particles.
particleParentSceneScene to create particles in.
particleTypeType of particles to create. Can be Particle::BILLBOARD_PARTICLE or Particle::MESH_PARTICLE
emitterTypeType of emitter to create. Can be ParticleEmitter::CONTINUOUS_EMITTER or ParticleEmitter::TRIGGERED_EMITTER
lifespanLifetime of particles in seconds.
numParticlesTotal number of particles to create.
directionDirection of the emitter, length of this vector controls emitter strength
gravityGravity direction and strength
deviationEmitter deviation on each axis
particleMeshIf particle type is Particle::MESH_PARTICLE, this must be set to the mesh to use for each particle
emitterIf this is specified, particles will be emitted from this meshe's vertices.

Member Function Documentation

void SceneParticleEmitter::Update ( ) [virtual]

Main update method.

Override this to do your updates before the render cycle.

Reimplemented from Polycode::Entity.