SingleDampingEffector Class

Applies a damping to a particle parameter of type Single.

Inheritance Hierarchy

SystemObject
DigitalRune.ParticlesParticleEffector
DigitalRune.Particles.EffectorsSingleDampingEffector

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

Public Class SingleDampingEffector
	Inherits ParticleEffector

public ref class SingleDampingEffector : public ParticleEffector

type SingleDampingEffector =  
    class
        inherit ParticleEffector
    end

The SingleDampingEffector type exposes the following members.

Constructors

	Name	Description
	SingleDampingEffector	Initializes a new instance of the SingleDampingEffector 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
	DampingParameter	Gets or sets the name of the particle parameter that defines the strength of the damping. (A varying or uniform parameter of type Single.)
	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.)
	ValueParameter	Gets or sets the name of the particle parameter that is damped. (A varying or uniform parameter of type Single.)

Top

Remarks

All parameters must be of type Single.

This effector reduces a parameter value over time by applying a damping.

Used particle parameters:

Particle Parameter	Description
ValueParameter	A Single parameter that is dampened. Per default, the parameter "LinearSpeed" is used.
DampingParameter	A Single parameter that defines the damping factor. A value of 0 means no damping. Values greater than 0 mean higher damping. Per default, the parameter "Damping" is used.

Reference

DigitalRune.Particles.Effectors Namespace