 | SingleFadeEffector Class |
Inheritance HierarchyDigitalRune.ParticlesParticleEffector
DigitalRune.Particles.EffectorsSingleFadeEffector
Namespace: DigitalRune.Particles.Effectors
Assembly: DigitalRune.Particles (in DigitalRune.Particles.dll) Version: 1.4.0.0 (1.4.1.14427)
SyntaxThe SingleFadeEffector type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SingleFadeEffector |
Initializes a new instance of the SingleFadeEffector 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.) |
| FadeInEnd |
Gets or sets the threshold that defines when the fade-in ends.
|
| FadeInStart |
Gets or sets the threshold that defines when the fade-in starts.
|
| FadeOutEnd |
Gets or sets the threshold that defines when the fade-out ends.
|
| FadeOutStart |
Gets or sets the threshold that defines when the fade-out starts.
|
| Name |
Gets the name of this particle effector.
(Inherited from ParticleEffector.) |
| ParticleSystem |
Gets or sets the particle system.
(Inherited from ParticleEffector.) |
| TargetValueParameter |
Gets or sets the name of the parameter that defines the target value.
(A varying or uniform parameter of type Single.)
|
| TimeParameter |
Gets or sets the name of the parameter that defines the progress of the fade-in/out.
(A varying or uniform parameter of type Single.)
|
| ValueParameter |
Gets or sets the name of the parameter that is faded in/out.
(A varying or uniform parameter of type Single.)
|
RemarksAll parameters must be of type Single.
This effector changes a parameter value from 0 to a target value ("fade-in"). Then the value is kept at the target value. Later the value is changed from the target value to 0 ("fade-out").
The fade-in interval is defined by FadeInStart and FadeInEnd. The fade-out interval is defined by FadeOutStart and FadeOutEnd. These intervals should be non-overlapping and the start values should be less than the corresponding end values. Usually, the fade-in interval lies before the fade-out interval, but it is allowed to swap the intervals to create a fade-out followed by a fade-in. The factor parameter (see TimeParameter) defines the progress of the fade-in/out. This parameter is usually the "NormalizedAge" of the particles.
Used particle parameters:
| Particle Parameter | Description |
|---|---|
| ValueParameter | A Single parameter that stores the result. |
| TargetValueParameter | A Single parameter that defines the target value. This parameter is optional. If it is not set, the target value is 1. |
| TimeParameter | A Single parameter that defines the fade-in/out factor. If this value is between FadeInStart and FadeInEnd, then the value parameter is faded in. If this value is between FadeOutStart and FadeOutEnd, then the value parameter is faded out. Per default, the parameter "NormalizedAge" is used. |
See Also