C# Class Axiom.ParticleSystems.ParticleAffector

Abstract class defining the interface to be implemented by particle affectors.
Show file Open project: WolfgangSt/axiom Class Usage Examples

Protected Properties

Property Type Description
commandTable AxiomCollection
type string

Public Methods

Method Description
AffectParticles ( ParticleSystem system, float timeElapsed ) : void

Method called to allow the affector to 'do it's stuff' on all active particles in the system.

This is where the affector gets the chance to apply it's effects to the particles of a system. The affector is expected to apply it's effect to some or all of the particles in the system passed to it, depending on the affector's approach.

CopyTo ( ParticleAffector affector ) : void

InitParticle ( Particle &particle ) : void

Method called to allow the affector to 'do it's stuff' on all active particles in the system.

This is where the affector gets the chance to apply it's effects to the particles of a system. The affector is expected to apply it's effect to some or all of the particles in the system passed to it, depending on the affector's approach.

ParticleAffector ( ) : System

Default constructor
SetParam ( string name, string val ) : bool

Protected Methods

Method Description
RegisterCommands ( ) : void

Registers all attribute names with their respective parser.

Methods meant to serve as attribute parsers should use a method attribute to

Method Details

AffectParticles() public abstract method

Method called to allow the affector to 'do it's stuff' on all active particles in the system.
This is where the affector gets the chance to apply it's effects to the particles of a system. The affector is expected to apply it's effect to some or all of the particles in the system passed to it, depending on the affector's approach.
public abstract AffectParticles ( ParticleSystem system, float timeElapsed ) : void
system ParticleSystem Reference to a ParticleSystem to affect.
timeElapsed float The number of seconds which have elapsed since the last call.
return void

CopyTo() public method

public CopyTo ( ParticleAffector affector ) : void
affector ParticleAffector
return void

InitParticle() public method

Method called to allow the affector to 'do it's stuff' on all active particles in the system.
This is where the affector gets the chance to apply it's effects to the particles of a system. The affector is expected to apply it's effect to some or all of the particles in the system passed to it, depending on the affector's approach.
public InitParticle ( Particle &particle ) : void
particle Particle Reference to a ParticleSystem to affect.
return void

ParticleAffector() public method

Default constructor
public ParticleAffector ( ) : System
return System

RegisterCommands() protected method

Registers all attribute names with their respective parser.
Methods meant to serve as attribute parsers should use a method attribute to
protected RegisterCommands ( ) : void
return void

SetParam() public method

public SetParam ( string name, string val ) : bool
name string
val string
return bool

Property Details

commandTable protected property

protected AxiomCollection commandTable
return AxiomCollection

type protected property

Name of the affector type. Must be initialized by subclasses.
protected string type
return string