C# Class Drought.Graphics.Particles.ParticleSystem

The main component in charge of displaying particles.
Show file Open project: kiniry-teaching/UCD Class Usage Examples

Public Methods

Method Description
AddParticle ( Vector3 position, Vector3 velocity ) : void

Adds a new particle to the system.

SetCamera ( Matrix view, Matrix projection ) : void

Sets the camera view and projection matrices that will be used to draw this particle system.

render ( GameTime gameTime, GraphicsDevice device ) : void

Draws the particle system.

update ( GameTime gameTime ) : void

Updates the particle system.

Protected Methods

Method Description
InitializeSettings ( ParticleSettings settings ) : void

Derived particle system classes should override this method and use it to initalize their tweakable settings.

ParticleSystem ( Microsoft.Xna.Framework.Content.ContentManager content, GraphicsDevice graphics ) : System

Constructor.

Private Methods

Method Description
AddNewParticlesToVertexBuffer ( ) : void

Helper for uploading new particles from our managed array to the GPU vertex buffer.

FreeRetiredParticles ( ) : void

Helper for checking when retired particles have been kept around long enough that we can be sure the GPU is no longer using them. It moves old particles from the retired area of the queue to the free section.

LoadParticleEffect ( GraphicsDevice graphics ) : void

Helper for loading and initializing the particle effect.

RetireActiveParticles ( ) : void

Helper for checking when active particles have reached the end of their life. It moves old particles from the active area of the queue to the retired section.

SetParticleRenderStates ( RenderState renderState ) : void

Helper for setting the renderstates used to draw particles.

Method Details

AddParticle() public method

Adds a new particle to the system.
public AddParticle ( Vector3 position, Vector3 velocity ) : void
position Vector3
velocity Vector3
return void

InitializeSettings() protected abstract method

Derived particle system classes should override this method and use it to initalize their tweakable settings.
protected abstract InitializeSettings ( ParticleSettings settings ) : void
settings ParticleSettings
return void

ParticleSystem() protected method

Constructor.
protected ParticleSystem ( Microsoft.Xna.Framework.Content.ContentManager content, GraphicsDevice graphics ) : System
content Microsoft.Xna.Framework.Content.ContentManager
graphics GraphicsDevice
return System

SetCamera() public method

Sets the camera view and projection matrices that will be used to draw this particle system.
public SetCamera ( Matrix view, Matrix projection ) : void
view Matrix
projection Matrix
return void

render() public method

Draws the particle system.
public render ( GameTime gameTime, GraphicsDevice device ) : void
gameTime Microsoft.Xna.Framework.GameTime
device GraphicsDevice
return void

update() public method

Updates the particle system.
public update ( GameTime gameTime ) : void
gameTime Microsoft.Xna.Framework.GameTime
return void