SingleLinearSegment3Effector Class

Evaluates a piecewise linear function consisting of 3 segments and multiplies the result with a particle parameter.

Inheritance Hierarchy

SystemObject
DigitalRune.ParticlesParticleEffector
DigitalRune.Particles.EffectorsSingleLinearSegment3Effector

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 SingleLinearSegment3Effector : ParticleEffector

Public Class SingleLinearSegment3Effector
	Inherits ParticleEffector

public ref class SingleLinearSegment3Effector : public ParticleEffector

type SingleLinearSegment3Effector =  
    class
        inherit ParticleEffector
    end

The SingleLinearSegment3Effector type exposes the following members.

Constructors

	Name	Description
	SingleLinearSegment3Effector	Initializes a new instance of the SingleLinearSegment3Effector 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.)
	InputParameter	Gets or sets the name of the parameter that is multiplied with the value of the piecewise linear function. (A varying or uniform parameter of type Single.)
	Name	Gets the name of this particle effector. (Inherited from ParticleEffector.)
	OutputParameter	Gets or sets the name of the parameter that stores the result. (A varying or uniform parameter of type Single.)
	ParticleSystem	Gets or sets the particle system. (Inherited from ParticleEffector.)
	Time0	Gets or sets the time of the first data point.
	Time1	Gets or sets the time of the second data point.
	Time2	Gets or sets the time of the third data point.
	Time3	Gets or sets the time of the last data point.
	TimeParameter	Gets or sets the name of the parameter that is the input for the piecewise linear function. (A varying or uniform parameter of type Single.)
	Value0	Gets or sets the value of the first data point.
	Value1	Gets or sets the value of the second data point.
	Value2	Gets or sets the value of the third data point.
	Value3	Gets or sets the value of the last data point.

Top

Remarks

All parameters must be of type Single.

A piecewise linear function is defined using several data points: (Time0, Value0), (Time1, Value1), (Time2, Value2) and (Time3, Value3). If the time (see TimeParameter) is less than Time0, then the function value is Value0. If the time is greater than Time3, then the function value is Value3. If the time is between those limits, the function value is the interpolation of the nearest data point. The time values Time0 to Time3 must be given in ascending order.

The result of the function is multiplied with the InputParameter and stored in the OutputParameter. (If InputParameter is not set, then the function value is directly stored in the OutputParameter.)

Used particle parameters:

Particle Parameter	Description
TimeParameter	A Single parameter that is the input to the piecewise linear function. Per default, the parameter "NormalizedAge" is used.
InputParameter	The Single parameter that is multiplied with the function value.
TimeParameter	The Single parameter that stores the result of the function value multiplied with the InputParameter.

Reference

DigitalRune.Particles.Effectors Namespace