StartDirectionEffector Class

Initializes a Vector3F particle parameter as a direction vector and applies the rotation of the ParticleSystem's Pose.

Inheritance Hierarchy

SystemObject
DigitalRune.ParticlesParticleEffector
DigitalRune.Particles.EffectorsStartDirectionEffector

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

Public Class StartDirectionEffector
	Inherits ParticleEffector

public ref class StartDirectionEffector : public ParticleEffector

type StartDirectionEffector =  
    class
        inherit ParticleEffector
    end

The StartDirectionEffector type exposes the following members.

Constructors

	Name	Description
	StartDirectionEffector	Initializes a new instance of the StartDirectionEffector 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
	DefaultValue	Gets or sets the start value that is used if Distribution is .
	Distribution	Gets or sets the random value distribution that is used to choose a start value for the parameter of a new particle.
	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.)
	Parameter	Gets or sets the name of the particle parameter that is initialized. (A varying or uniform parameter of type Vector3F.)
	ParticleSystem	Gets or sets the particle system. (Inherited from ParticleEffector.)

Top

Remarks

This effector initializes the start value of a specific particle parameter (see property Parameter) for new particles. The start value is chosen from a given Distribution. If Distribution is , DefaultValue is used as the start value for all particles.

This effector acts like a standard StartValueEffectorT, except: The vector created by the Distribution or the DefaultValue is treated as a direction vector given in the local coordinate space of the particle system. That means, the direction start value rotates with the particle system. If the ReferenceFrame of the particle system is World, the start value of each particle is multiplied with the poses of the particle system (and its parent particle systems) to convert the direction vector from local space to world space. If the ReferenceFrame of the particle system is Local, the pose of the particle system is ignored.

Cloning: When an instance is of this class is cloned, the clone references the same Distribution. The Distribution is not cloned.

Reference

DigitalRune.Particles.Effectors Namespace