ParticleSystem.EmitterParams Class Reference

This class regroups all the parameters needed to initialize a particle. More...

List of all members.

Public Member Functions

 EmitterParams ()
 EmitterParams constructor.
string ToString (string prefix)
 Return the string representation of this EmitterParams.

Public Attributes

Matrix3 Transform = Matrix3.Identity
 The generated position, velocity, angle are transformed by this.
Matrix3 TransformForVelocityEstimate = Matrix3.Identity
 The transform matrix we use to estimate a velocity and an angular velocity.
float ForwardMomentum = 0.0f
 Control how much of the "observed velocity" we add to the created particles.
float AngularMomentun = 0.0f
 Control how much of the "observed angular velocity" we add to the created particles.
float WaitTime = 1.0f
 The time to wait until the next particle gets created, in seconds.
float WaitTimeRelVar = 0.15f
 WaitTime's variance (relative)
float LifeSpan = 5.0f
 Created particles's life span in seconds.
float LifeSpanRelVar
 LifeSpan's variance (relative)
Vector2 Position = GameEngine2D.Base.Math._00
 Created particles's initial position (see also InLocalSpace)
Vector2 PositionVar = GameEngine2D.Base.Math._11 * 1.5f
 Position's variance.
Vector2 Velocity = GameEngine2D.Base.Math._01
 Created particles's initial velocity given to created particles (see also InLocalSpace)
Vector2 VelocityVar = GameEngine2D.Base.Math._11 * 0.2f
 Velocity's variance.
float AngularVelocity
 Created particles's initial angular velocity, in radians (see also InLocalSpace)
float AngularVelocityVar
 AngularVelocity's variance.
float Angle
 Created particles's initial rotation angle in radians (see also InLocalSpace)
float AngleVar
 Angle's variance.
Vector4 ColorStart = Colors.White
 Created particles's initial color.
Vector4 ColorStartVar = GameEngine2D.Base.Math._0000
 ColorStart's variance.
Vector4 ColorEnd = Colors.White
 Color the particle will have when they reach their life span.
Vector4 ColorEndVar = GameEngine2D.Base.Math._0000
 ColorEnd's variance.
float ScaleStart = 1.0f
 Created particles's initial size.
float ScaleStartRelVar
 ScaleStart's variance (relative)
float ScaleEnd = 1.0f
 Size the particle will have when they reach their life span.
float ScaleEndRelVar
 ScaleEnd's variance (relative)

Detailed Description

This class regroups all the parameters needed to initialize a particle.

Most values have a variance associated to them (-Var suffix), to give a randomization range. When the variance is a "relative" value (-RelVar suffix), a value between 0,1 is expected. For example: 0.2f means the corresponding value will be randomized -+20% at creation time.


Member Function Documentation

string ToString ( string  prefix)

Return the string representation of this EmitterParams.

Parameters:
prefixA prefix string added to the beginning of each line.

Member Data Documentation

The transform matrix we use to estimate a velocity and an angular velocity.

You probably want to set it everyframe to something relevant (the current transform of the object node for example).