C# Class Axiom.ParticleSystems.ParticleAffectorFactory

Abstract class defining the interface to be implemented by creators of ParticleAffector subclasses.

Plugins or 3rd party applications can add new types of particle affectors by creating subclasses of the ParticleAffector class. Because multiple instances of these affectors may be required, a factory class to manage the instances is also required.

ParticleAffectorFactory subclasses must allow the creation and destruction of ParticleAffector subclasses. They must also be registered with the ParticleSystemManager. All factories have a name which identifies them, examples might be 'ForceVector', 'Attractor', or 'Fader', and these can be also be used from particle system scripts.

Mostra file Open project: WolfgangSt/axiom Class Usage Examples

Protected Properties

Property	Type	Description
affectorList	AffectorList

Public Methods

Method	Description
Create ( ) : ParticleAffector	Creates a new affector instance. Subclasses MUST add a reference to the affectorList.
Destroy ( ParticleAffector e ) : void	Destroys the affector referenced by the parameter.
ParticleAffectorFactory ( ) : System	Default constructor.

Method Details

Create() public abstract method

Creates a new affector instance.

Subclasses MUST add a reference to the affectorList.

public abstract Create ( ) : ParticleAffector
return	ParticleAffector

Destroy() public method

Destroys the affector referenced by the parameter.

public Destroy ( ParticleAffector e ) : void
e	ParticleAffector	The Affector to destroy.
return	void

ParticleAffectorFactory() public method

Default constructor.

public ParticleAffectorFactory ( ) : System
return	System

Property Details

affectorList protected_oe property

protected AffectorList affectorList
return	AffectorList