Polycode
Polycode::ParticleEmitter Class Reference

Particle emitter base. More...

Inherited by Polycode::SceneParticleEmitter, and Polycode::ScreenParticleEmitter.

List of all members.

Public Member Functions

void setRotationSpeed (Number speed)
 Sets the speed at which particles rotate.
void setParticleBlendingMode (int mode)
 Sets the blending mode used for the particles.
void setDepthWrite (bool val)
 Turns depth write on and off for particles.
void setDepthTest (bool val)
 Turns depth test on and off for particles.
void setAlphaTest (bool val)
 Turns alpha testing on and off for particles.
void enablePerlin (bool val)
 Enables perlin noise movement for particles.
void setParticleVisibility (bool val)
 Sets visibility of all particles in the system.
void setPerlinModSize (Number size)
 Enables perlin noise movement size.
void setBillboardMode (bool mode)
 Enables or disables billboard mode for particles.
void enableEmitter (bool val)
 Enables or disables the emitter.
bool emitterEnabled ()
 Returns true if the emitter is enabled, false otherwise.
void setEmitterRadius (Vector3 rad)
 Sets the emitter radius on all 3 axises.
void setAllAtOnce (bool val)
 If set to true, will release all particles at once.
void Trigger ()
 If emitter mode is TRIGGERED_EMITTER, calling this method will trigger particle emission.
void setParticleCount (int count)
 Changes the particle count in the emitter.

Public Attributes

Number particleSpeedMod
 Particle movement speed multiplier.
Number brightnessDeviation
 Particle brightness deviation.
Vector3 deviation
 Particle direction deviation.
Vector3 dirVector
 Particle direction and emission strength vector.
Vector3 gravVector
 Particle gravity strength vector.
Number lifespan
 Lifespan of particles.
bool rotationFollowsPath
 If set to true, particles' rotation will follow their movement.
BezierCurve scaleCurve
 Bezier curve that controls the scale of the particles.
BezierCurve colorCurveR
 Bezier curve that controls the red component of particles' color.
BezierCurve colorCurveG
 Bezier curve that controls the green component of particles' color.
BezierCurve colorCurveB
 Bezier curve that controls the blue component of particles' color.
BezierCurve colorCurveA
 Bezier curve that controls the alpha component of particles' color.
bool useColorCurves
 If set to true, will use the color curves to control particle color.
bool useScaleCurves
 If set to true, will use the scale curve to control particle scale.

Static Public Attributes

static const int CONTINUOUS_EMITTER = 0
 Continuous emitter setting.
static const int TRIGGERED_EMITTER = 1
 Triggered emitter setting.

Detailed Description

Particle emitter base.


Member Function Documentation

void ParticleEmitter::setParticleBlendingMode ( int  mode)

Sets the blending mode used for the particles.

See documentation for the Entity for information on blending modes.

Parameters:
modeNew blending mode.
void ParticleEmitter::setRotationSpeed ( Number  speed)

Sets the speed at which particles rotate.

Parameters:
speedNew rotation speed.

Member Data Documentation

If set to true, will use the color curves to control particle color.

False by default.

If set to true, will use the scale curve to control particle scale.

False by default.