 | ReserveParticleEffector Class |
Kills old particles if the particle system reaches the
MaxNumberOfParticles limit.
Inheritance HierarchySystemObject
DigitalRune.ParticlesParticleEffector
DigitalRune.Particles.EffectorsReserveParticleEffector
DigitalRune.ParticlesParticleEffector
DigitalRune.Particles.EffectorsReserveParticleEffector
Namespace: DigitalRune.Particles.Effectors
Assembly: DigitalRune.Particles (in DigitalRune.Particles.dll) Version: 1.4.0.0 (1.4.1.14427)
SyntaxThe ReserveParticleEffector type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ReserveParticleEffector |
Initializes a new instance of the ReserveParticleEffector 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.
(Inherited from ParticleEffector.) |
| 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.
(Overrides ParticleEffectorOnUpdateParticles(TimeSpan, Int32, Int32).) |
| 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 | |
|---|---|---|
 | 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.) |
| Reserve |
Gets or sets the number of particles to reserve.
|
Remarks
The number of particles in each ParticleSystem is limited (see
MaxNumberOfParticles). If the limit is reached, no more new
particles can be emitted until existing particles die. The ReserveParticleEffector
monitors NumberOfActiveParticles and if less than
Reserve particles are left, it kills the oldest particles (by setting their
"NormalizedAge" to 1) in its OnUpdateParticles(TimeSpan, Int32, Int32) method. This effector ensures
that there are always free particles ready to be emitted. Usually, this effector should be
added as the last effector to the Effectors collection of the
particle system because it should be updated after all other effectors.
See Also