StartVelocityBiasEffector Class

Adds a bias velocity to the start velocities of particles.

Inheritance Hierarchy

SystemObject
DigitalRune.ParticlesParticleEffector
DigitalRune.Particles.EffectorsStartVelocityBiasEffector

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

Public Class StartVelocityBiasEffector
	Inherits ParticleEffector

public ref class StartVelocityBiasEffector : public ParticleEffector

type StartVelocityBiasEffector =  
    class
        inherit ParticleEffector
    end

The StartVelocityBiasEffector type exposes the following members.

Constructors

	Name	Description
	StartVelocityBiasEffector	Initializes a new instance of the StartVelocityBiasEffector 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. (Inherited from ParticleEffector.)
	OnEndUpdate	Called when BeginUpdate(TimeSpan) was called. (Inherited from ParticleEffector.)
	OnInitialize	Called when Initialize was called. (Overrides ParticleEffectorOnInitialize.)
	OnInitializeParticles	Called when InitializeParticles(Int32, Int32, Object) was called. (Overrides ParticleEffectorOnInitializeParticles(Int32, Int32, Object).)
	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. (Inherited from ParticleEffector.)
	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
	BiasVelocityParameter	Gets or sets the name of the parameter that defines the bias velocity vector. (A varying or uniform parameter of type Vector3F.)
	DirectionParameter	Gets or sets the name of the parameter that defines the movement direction. (A varying or uniform parameter of type Vector3F.)
	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.)
	SpeedParameter	Gets or sets the name of the parameter that defines the movement speed. (A varying or uniform parameter of type Single.)
	Strength	Gets or sets a factor that is used to scale the bias velocity before adding it to the particle velocity.

Top

Remarks

This effector changes the initial particle speed and direction by adding a bias velocity.

For example: When a particle emitter is moving, the emitter's velocity can be set as the bias velocity to influence the particles when they are spawned. The Strength property is a factor, usually in the range [0, 1], that defines how strong the influence of the emitter velocity is.

Used particle parameters:

Particle Parameter	Description
DirectionParameter	A normalized Vector3F parameter that defines the movement direction (direction of the linear velocity vector). This parameter is modified by applying the bias velocity. Per default, the parameter "Direction" is used.
SpeedParameter	A Single parameter that defines the movement speed (magnitude of the linear velocity vector). This parameter is modified by applying the acceleration. Per default, the parameter "LinearSpeed" is used.
BiasVelocityParameter	A Vector3F parameter that defines the bias velocity. Per default, the parameter "EmitterVelocity" is used.

Reference

DigitalRune.Particles.Effectors Namespace