Click or drag to resize
DigitalRuneFuncEffectorT1, T2, TResult Class
Evaluates a custom (delegate) function for two input particle parameters and stores the result in another particle parameter.
Inheritance Hierarchy
SystemObject
  DigitalRune.ParticlesParticleEffector
    DigitalRune.Particles.EffectorsFuncEffectorT1, T2, TResult

Namespace: DigitalRune.Particles.Effectors
Assembly: DigitalRune.Particles (in DigitalRune.Particles.dll) Version: 1.4.0.0 (1.4.1.14427)
Syntax
public class FuncEffector<T1, T2, TResult> : ParticleEffector

Type Parameters

T1
The type of the first function parameter.
T2
The type of the second function parameter.
TResult
The return type of the function.

The FuncEffectorT1, T2, TResult type exposes the following members.

Constructors
  NameDescription
Public methodFuncEffectorT1, T2, TResult
Initializes a new instance of the FuncEffectorT1, T2, TResult class
Top
Methods
  NameDescription
Public methodBeginUpdate
Called when the particle system begins its update.
(Inherited from ParticleEffector.)
Public methodClone
Creates a new ParticleEffector that is a clone of the current instance.
(Inherited from ParticleEffector.)
Protected methodCloneCore
Makes the instance a clone of the specified ParticleEffector.
(Overrides ParticleEffectorCloneCore(ParticleEffector).)
Protected methodCreateInstanceCore
When implemented in a derived class, creates a new instance of the ParticleEffector derived class.
(Overrides ParticleEffectorCreateInstanceCore.)
Public methodEndUpdate
Called when the particle system finishes its update.
(Inherited from ParticleEffector.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitialize
Initializes this particle effector.
(Inherited from ParticleEffector.)
Public methodInitializeParticles
Initializes new particles.
(Inherited from ParticleEffector.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnBeginUpdate
Called when BeginUpdate(TimeSpan) was called.
(Overrides ParticleEffectorOnBeginUpdate(TimeSpan).)
Protected methodOnEndUpdate
Called when BeginUpdate(TimeSpan) was called.
(Inherited from ParticleEffector.)
Protected methodOnInitialize (Inherited from ParticleEffector.)
Protected methodOnInitializeParticles (Inherited from ParticleEffector.)
Protected methodOnRequeryParameters (Overrides ParticleEffectorOnRequeryParameters.)
Protected methodOnUninitialize (Overrides ParticleEffectorOnUninitialize.)
Protected methodOnUpdateParticles
Called when UpdateParticles(TimeSpan, Int32, Int32) was called.
(Overrides ParticleEffectorOnUpdateParticles(TimeSpan, Int32, Int32).)
Public methodRequeryParameters
Requeries the particle parameters.
(Inherited from ParticleEffector.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUninitialize
Uninitializes this particle effector.
(Inherited from ParticleEffector.)
Public methodUpdateParticles
Updates particles.
(Inherited from ParticleEffector.)
Top
Properties
  NameDescription
Public propertyEnabled
Gets or sets a value indicating whether this ParticleEffector is enabled.
(Inherited from ParticleEffector.)
Public propertyFunc
Gets or sets the delegate function.
Public propertyInputParameter1
Gets or sets the name of the first input parameter. (A varying or uniform parameter of type T1.)
Public propertyInputParameter2
Gets or sets the name of the second input parameter. (A varying or uniform parameter of type T2.)
Public propertyName
Gets the name of this particle effector.
(Inherited from ParticleEffector.)
Public propertyOutputParameter
Gets or sets the name of the output parameter. (A varying or uniform parameter of type TResult.)
Public propertyParticleSystem
Gets or sets the particle system.
(Inherited from ParticleEffector.)
Top
Remarks

This effector executes a given delegate Func to compute the particle parameter value. The delegate function takes a two parameters (see InputParameter1 and InputParameter2) and the function result is stored in another parameter (see OutputParameter).

Please note: Since this effector executes a delegate call for each particle, it is less efficient than other particle effectors.

Used particle parameters:

Particle ParameterDescription
InputParameter1 A T1 parameter that provides the first function parameter.
InputParameter2 A T2 parameter that provides the second function parameter.
OutputParameter A TResult parameter that stores the result of the function.

See Also