Click or drag to resize
DigitalRuneStartPositionEffector Class
Initializes a Vector3F particle parameter as a position vector and applies the transformation of the ParticleSystem's Pose.
Inheritance Hierarchy
SystemObject
  DigitalRune.ParticlesParticleEffector
    DigitalRune.Particles.EffectorsStartPositionEffector

Namespace: DigitalRune.Particles.Effectors
Assembly: DigitalRune.Particles (in DigitalRune.Particles.dll) Version: 1.4.0.0 (1.4.1.14427)
Syntax
public class StartPositionEffector : ParticleEffector

The StartPositionEffector type exposes the following members.

Constructors
  NameDescription
Public methodStartPositionEffector
Initializes a new instance of the StartPositionEffector class.
Top
Methods
  NameDescription
Public methodBeginUpdate
Called when the particle system begins its update.
(Inherited from ParticleEffector.)
Public methodClone
Creates a new ParticleEffector that is a clone of the current instance.
(Inherited from ParticleEffector.)
Protected methodCloneCore
Makes the instance a clone of the specified ParticleEffector.
(Overrides ParticleEffectorCloneCore(ParticleEffector).)
Protected methodCreateInstanceCore
When implemented in a derived class, creates a new instance of the ParticleEffector derived class.
(Overrides ParticleEffectorCreateInstanceCore.)
Public methodEndUpdate
Called when the particle system finishes its update.
(Inherited from ParticleEffector.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitialize
Initializes this particle effector.
(Inherited from ParticleEffector.)
Public methodInitializeParticles
Initializes new particles.
(Inherited from ParticleEffector.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnBeginUpdate
Called when BeginUpdate(TimeSpan) was called.
(Inherited from ParticleEffector.)
Protected methodOnEndUpdate
Called when BeginUpdate(TimeSpan) was called.
(Inherited from ParticleEffector.)
Protected methodOnInitialize (Overrides ParticleEffectorOnInitialize.)
Protected methodOnInitializeParticles (Overrides ParticleEffectorOnInitializeParticles(Int32, Int32, Object).)
Protected methodOnRequeryParameters (Overrides ParticleEffectorOnRequeryParameters.)
Protected methodOnUninitialize (Overrides ParticleEffectorOnUninitialize.)
Protected methodOnUpdateParticles
Called when UpdateParticles(TimeSpan, Int32, Int32) was called.
(Inherited from ParticleEffector.)
Public methodRequeryParameters
Requeries the particle parameters.
(Inherited from ParticleEffector.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUninitialize
Uninitializes this particle effector.
(Inherited from ParticleEffector.)
Public methodUpdateParticles
Updates particles.
(Inherited from ParticleEffector.)
Top
Properties
  NameDescription
Public propertyDefaultValue
Gets or sets the start value that is used if Distribution is .
Public propertyDistribution
Gets or sets the random value distribution that is used to choose a start value for the parameter of a new particle.
Public propertyEnabled
Gets or sets a value indicating whether this ParticleEffector is enabled.
(Inherited from ParticleEffector.)
Public propertyName
Gets the name of this particle effector.
(Inherited from ParticleEffector.)
Public propertyParameter
Gets or sets the name of the particle parameter that is initialized. (A varying or uniform parameter of type Vector3F.)
Public propertyParticleSystem
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 position given in the local coordinate space of the particle system. That means, the position start value moves 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 position 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.

See Also