 | StreamEmitter Class |
Inheritance HierarchyNamespace: DigitalRune.Particles.Effectors
Assembly: DigitalRune.Particles (in DigitalRune.Particles.dll) Version: 1.4.0.0 (1.4.1.14427)
SyntaxThe StreamEmitter type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | StreamEmitter |
Initializes a new instance of the StreamEmitter class.
|
Methods| Name | Description | |
|---|---|---|
| BeginUpdate |
Called when the particle system begins its update.
(Inherited from ParticleEffector.) |
| Clone |
Creates a new ParticleEffector that is a clone of the current instance.
(Inherited from ParticleEffector.) |
 | CloneCore |
Makes the instance a clone of the specified ParticleEffector.
(Overrides ParticleEffectorCloneCore(ParticleEffector).) |
| CreateInstanceCore |
When implemented in a derived class, creates a new instance of the
ParticleEffector derived class.
(Overrides ParticleEffectorCreateInstanceCore.) |
| EndUpdate |
Called when the particle system finishes its update.
(Inherited from ParticleEffector.) |
| Equals | (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| Initialize |
Initializes this particle effector.
(Inherited from ParticleEffector.) |
| InitializeParticles |
Initializes new particles.
(Inherited from ParticleEffector.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnBeginUpdate |
Called when BeginUpdate(TimeSpan) was called.
(Overrides ParticleEffectorOnBeginUpdate(TimeSpan).) |
| OnEndUpdate |
Called when BeginUpdate(TimeSpan) was called.
(Inherited from ParticleEffector.) |
| OnInitialize |
Called when Initialize was called.
(Overrides ParticleEffectorOnInitialize.) |
| OnInitializeParticles |
Called when InitializeParticles(Int32, Int32, Object) was called.
(Inherited from ParticleEffector.) |
| OnRequeryParameters |
Called when RequeryParameters was called.
(Overrides ParticleEffectorOnRequeryParameters.) |
| OnUninitialize |
Called when Uninitialize was called.
(Overrides ParticleEffectorOnUninitialize.) |
| OnUpdateParticles |
Called when UpdateParticles(TimeSpan, Int32, Int32) was called.
(Inherited from ParticleEffector.) |
| RequeryParameters |
Requeries the particle parameters.
(Inherited from ParticleEffector.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Uninitialize |
Uninitializes this particle effector.
(Inherited from ParticleEffector.) |
| UpdateParticles |
Updates particles.
(Inherited from ParticleEffector.) |
Properties| Name | Description | |
|---|---|---|
 | DefaultEmissionRate |
Gets or sets the default emission rate that is used if the
EmissionRateParameter is not found.
|
| EmissionLimit |
Gets or sets the maximum number of emitted particles.
|
| EmissionRateParameter |
Gets or sets the name of the particle parameter that defines the emission rate (particles
per second). (A uniform parameter of type Single.)
|
| Enabled |
Gets or sets a value indicating whether this ParticleEffector is enabled.
(Inherited from ParticleEffector.) |
| Name |
Gets the name of this particle effector.
(Inherited from ParticleEffector.) |
| ParticleSystem |
Gets or sets the particle system.
(Inherited from ParticleEffector.) |
RemarksThis effectors reads a uniform particle parameter (see EmissionRateParameter) to define the emission rate. If no emission rate parameter is found, the DefaultEmissionRate is used.
The emitter emits a stream of particles until EmissionLimit number of particles have been created. Then it will stop to emit particles. The internal particle counter is reset when Initialize is called (which is automatically called when a particle system is Reset).
This emitter can be configured to create particles in bursts: Simply set a high enough emission rate and limit the number of particles with EmissionLimit. To trigger another burst, simply increase EmissionLimit by the burst size.
See Also