Collapse AllExpand All     Code: All Code: Multiple Code: C# Code: Visual Basic Code: Visual C++     Members: Show All Members: Filtered Members: Filtered Members: Filtered

DefaultQuadParticle Members

Name

Description

DefaultQuadParticle

Initializes a new instance of the DefaultQuadParticle class

Name

Description

CopyFrom

Deep copy all of the Particle properties

(Overrides DPSFDefaultBaseParticle..::..CopyFrom(DPSFParticle).)

Equals

Determines whether the specified Object is equal to the current Object.

(Inherited from Object.)

Finalize

Allows an Object to attempt to free resources and perform other cleanup operations before the Object 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.)

IsActive

Function to tell if a Particle is still Active (alive) or not

(Inherited from DPSFParticle.)

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

Reset

Resets the Particle variables to their default values

(Overrides DPSFDefaultBaseParticle..::..Reset()()()().)

Scale

Scales the Width and Height by the given amount.

ScaleToHeight

Updates the Height to the given value and uniformly scales the Width to maintain the width-to-height ratio.

ScaleToWidth

Updates the Width to the given value and uniformly scales the Height to maintain the width-to-height ratio.

ToString

Returns a String that represents the current Object.

(Inherited from Object.)

UpdateElapsedTimeVariables

Function to update the Elapsed Time associated variables of the Particle. This is done automatically by DPSF when the particle system's Update() function is called, so this function does not need to be manually called by the user.

(Inherited from DPSFParticle.)

Name

Description

Acceleration

The Particle's Acceleration

(Inherited from DPSFDefaultBaseParticle.)

Color

The Color of the Particle, or if using a Texture, the Color to incorporate into the Particle's Texture.

NOTE: This Color's alpha value controls the transparency of the Particle's Texture.

NOTE: This should be a Non-Premultipilied color.

(Inherited from DPSFDefaultBaseParticle.)

DistanceFromCameraSquared

The squared distance between this particle and the camera.

NOTE: This property is only used if you are sorting the particles based on their distance from the camera, otherwise you can use this property for whatever you like.

EndColor

The Particle's Color when it dies

NOTE: This should be a Non-Premultipilied color.

(Inherited from DPSFDefaultBaseParticle.)

EndHeight

The Height of the Particle when it dies

EndWidth

The Width of the Particle when it dies

ExternalForce

An External Force that may be applied to the Particle

(Inherited from DPSFDefaultBaseParticle.)

Friction

The Friction to apply to the Particle

(Inherited from DPSFDefaultBaseParticle.)

Height

The Height of the Particle

Orientation

The Orientation of the Particle

Position

The Position of the Particle in 3D space.

NOTE: For 2D Pixel and Sprite Particles, the Z value can still be used to determine which Particles are drawn in front of others (0.0 = front, 1.0 = back) when SpriteBatchOptions.eSortMode = SpriteSortMode.BackToFront or SpriteSortMode.FrontToBack

(Inherited from DPSFDefaultBaseParticle.)

RotationalAcceleration

The Rotational Acceleration of the Particle. X = Pitch Acceleration, Y = Yaw Acceleration, Z = Roll Acceleration in radians

RotationalVelocity

The Rotational Velocity of the Particle. X = Pitch Velocity, Y = Yaw Velocity, Z = Roll Velocity in radians

StartColor

The Particle's Color when it is born.

NOTE: This should be a Non-Premultipilied color.

(Inherited from DPSFDefaultBaseParticle.)

StartHeight

The Height of the Particle when it is born

StartWidth

The Width of the Particle when it is born

Velocity

The Particle's Velocity

(Inherited from DPSFDefaultBaseParticle.)

Width

The Width of the Particle

Name

Description

ColorAsPremultiplied

Get the Color as a Premultiplied color (i.e. premultiplied alpha).

(Inherited from DPSFDefaultBaseParticle.)

ElapsedTime

Get / Set how much Time has Elapsed since this Particle was born.

NOTE: Setting this to be greater than or equal to Lifetime will cause the Particle to become InActive and be removed from the Particle System (if Lifetime is greater than zero).

NOTE: Setting this also sets the Last Elapsed Time to the given value.

(Inherited from DPSFParticle.)

EndColorAsPremultiplied

Get the End Color as a Premultiplied color (i.e. premultiplied alpha).

(Inherited from DPSFDefaultBaseParticle.)

EndSize

Sets the EndWidth and EndHeight properties to the given value. Gets the EndWidth value, ignoring whether the EndHeight value is the same or not.

LastElapsedTime

Get the Elapsed Time of the Particle at the previous frame

(Inherited from DPSFParticle.)

LastNormalizedElapsedTime

Get the Normalized Elapsed Time of the Particle at the previous frame

(Inherited from DPSFParticle.)

Lifetime

Get / Set the Lifetime of the Particle (How long it should live for).

NOTE: Setting this to zero will make the Particle live forever.

NOTE: Negative Lifetimes are reset to zero.

(Inherited from DPSFParticle.)

Normal

Get / Set the Normal (forward) direction of the Particle (i.e. which direction it is facing)

NormalizedElapsedTime

Get / Set the Normalized Elapsed Time (0.0 - 1.0) of this Particle (How far through its life it is).

NOTE: Setting this to be greater than or equal to 1.0 will cause the Particle to become InActive and be removed from the Particle System (if Lifetime is greater than zero).

NOTE: If the Particle has a Lifetime of zero (is set to live forever), Setting this has no effect, and Getting this will always return zero.

(Inherited from DPSFParticle.)

Right

Get / Set the Right direction of the Particle

Size

Sets the Width and Height properties to the given value. Gets the Width value, ignoring whether the Height value is the same or not.

StartColorAsPremultiplied

Get the Start Color as a Premultiplied color (i.e. premultiplied alpha).

(Inherited from DPSFDefaultBaseParticle.)

StartSize

Sets the StartWidth and StartHeight properties to the given value. Gets the StartWidth value, ignoring whether the StartHeight value is the same or not.

Up

Get / Set the Up direction of the Particle

Visible

Get / Set if the Particle should be Visible (i.e. be drawn) or not

(Inherited from DPSFParticle.)