FuncEffector(T, TResult) Class

FuncEffectorT, TResult Class

Evaluates a custom (delegate) function for a single input particle parameter and stores the result in another particle parameter.

Inheritance Hierarchy

SystemObject
DigitalRune.ParticlesParticleEffector
DigitalRune.Particles.EffectorsFuncEffectorT, TResult

Namespace: DigitalRune.Particles.Effectors
Assembly: DigitalRune.Particles (in DigitalRune.Particles.dll) Version: 1.4.0.0 (1.4.1.14427)

Syntax

C++

Copy

public class FuncEffector<T, TResult> : ParticleEffector

Public Class FuncEffector(Of T, TResult)
	Inherits ParticleEffector

generic<typename T, typename TResult>
public ref class FuncEffector : public ParticleEffector

type FuncEffector<'T, 'TResult> =  
    class
        inherit ParticleEffector
    end

Type Parameters

T: The type of the function parameter.
TResult: The return type of the function.

The FuncEffectorT, TResult type exposes the following members.

Constructors

	Name	Description
	FuncEffectorT, TResult	Initializes a new instance of the FuncEffectorT, TResult class

Top

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	Determines whether the specified Object is equal to the current Object. (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.)

Top

Properties

	Name	Description
	Enabled	Gets or sets a value indicating whether this ParticleEffector is enabled. (Inherited from ParticleEffector.)
	Func	Gets or sets the delegate function.
	InputParameter	Gets or sets the name of the input parameter. (A varying or uniform parameter of type T.)
	Name	Gets the name of this particle effector. (Inherited from ParticleEffector.)
	OutputParameter	Gets or sets the name of the output parameter. (A varying or uniform parameter of type TResult.)
	ParticleSystem	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 single parameter (InputParameter) and the function result is stored in another parameter (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 Parameter	Description
InputParameter	A T parameter that provides the function parameter.
OutputParameter	A TResult parameter that stores the result of the function.

Reference

DigitalRune.Particles.Effectors Namespace