C# Class UHSampleGame.ProjectileManagment.ParticleSystem

The main component in charge of displaying particles.
Inheritance: Microsoft.Xna.Framework.DrawableGameComponent
Show file Open project: holtkampw/UH-Sample-XNA-Project Class Usage Examples

Public Properties

Property Type Description
settings ParticleSettings

Public Methods

Method Description
AddNewParticlesToVertexBuffer ( ) : void

Helper for uploading new particles from our managed array to the GPU vertex buffer.
AddParticle ( Vector3 position, Vector3 velocity ) : void

Adds a new particle to the system.
Draw ( GameTime gameTime ) : void

Draws the particle system.
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.
Initialize ( ) : void

Initializes the component.
LoadParticleEffect ( ) : 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.
SetCamera ( Matrix &view, Matrix &projection ) : void

Sets the camera view and projection matrices that will be used to draw this particle system.
Update ( GameTime gameTime ) : void

Updates the particle system.

Protected Methods

Method Description
Dispose ( bool disposing ) : void
InitializeSettings ( ParticleSettings settings ) : void

Derived particle system classes should override this method and use it to initalize their tweakable settings.
LoadContent ( ) : void

Loads graphics for the particle system.
ParticleSystem ( Microsoft.Xna.Framework.Game game, Microsoft.Xna.Framework.Content.ContentManager content ) : System

Constructor.

Method Details

AddNewParticlesToVertexBuffer() public method

Helper for uploading new particles from our managed array to the GPU vertex buffer.
public AddNewParticlesToVertexBuffer ( ) : void
return void

AddParticle() public method

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

Dispose() protected method

protected Dispose ( bool disposing ) : void
disposing bool
return void

Draw() public method

Draws the particle system.
public Draw ( GameTime gameTime ) : void
gameTime Microsoft.Xna.Framework.GameTime
return void

FreeRetiredParticles() public method

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.
public FreeRetiredParticles ( ) : void
return void

Initialize() public method

Initializes the component.
public Initialize ( ) : void
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

LoadContent() protected method

Loads graphics for the particle system.
protected LoadContent ( ) : void
return void

LoadParticleEffect() public method

Helper for loading and initializing the particle effect.
public LoadParticleEffect ( ) : void
return void

ParticleSystem() protected method

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

RetireActiveParticles() public method

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.
public RetireActiveParticles ( ) : void
return void

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

Update() public method

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

Property Details

settings public property

public ParticleSettings,UHSampleGame.ProjectileManagment settings
return ParticleSettings