DefaultAnimatedTexturedQuadParticle Members

collapse_all

expand_all
collapse_allexpand_alldropdowndropdownHovercopycodecopycodeHighlight

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

[TCheckBoxFormControlObj]C#

[TCheckBoxFormControlObj]Visual Basic

[TCheckBoxFormControlObj]

Visual C++

[TCheckBoxFormControlObj]Include Protected Members

[TCheckBoxFormControlObj]
Include Inherited Members
DPSF API Documentation
DefaultAnimatedTexturedQuadParticle Members
gradient

The DefaultAnimatedTexturedQuadParticle type exposes the following members.

collapse_allConstructors

 

Name

Description

pubmethod

DefaultAnimatedTexturedQuadParticle

Initializes a new instance of the DefaultAnimatedTexturedQuadParticle class

collapse_allMethods

 

Name

Description

pubmethod

CopyFrom

Deep copy all of the Particle properties

(Overrides DefaultTextureQuadTextureCoordinatesParticle..::..CopyFrom(DPSFParticle).)

pubmethod

Equals

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

(Inherited from Object.)

protmethod

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.)

pubmethod

GetHashCode

Serves as a hash function for a particular type.

(Inherited from Object.)

pubmethod

GetType

Gets the Type of the current instance.

(Inherited from Object.)

pubmethod

IsActive

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

(Inherited from DPSFParticle.)

protmethod

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

pubmethod

Reset

Resets the Particle variables to their default values

(Overrides DefaultTextureQuadTextureCoordinatesParticle..::..Reset()()()().)

pubmethod

Scale

Scales the Width and Height by the given amount.

(Inherited from DefaultQuadParticle.)

pubmethod

ScaleToHeight

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

(Inherited from DefaultQuadParticle.)

pubmethod

ScaleToWidth

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

(Inherited from DefaultQuadParticle.)

pubmethod

SetTextureCoordinates(Rectangle, Int32, Int32)

Sets the Normalized Texture Coordinates using the absolute (i.e. non-normalized) top-left coordinate and the dimensions of the Picture in the Texture

(Inherited from DefaultTextureQuadTextureCoordinatesParticle.)

pubmethod

SetTextureCoordinates(Int32, Int32, Int32, Int32, Int32, Int32)

Sets the Normalized Texture Coordinates using the absolute (i.e. non-normalized) coordinates of the Picture in the Texture

(Inherited from DefaultTextureQuadTextureCoordinatesParticle.)

pubmethod

ToString

Returns a String that represents the current Object.

(Inherited from Object.)

pubmethod

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.)

collapse_allFields

 

Name

Description

pubfield

Acceleration

The Particle's Acceleration

(Inherited from DPSFDefaultBaseParticle.)

pubfield

Animation

Class to hold this Particle's Animation information

pubfield

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.)

pubfield

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.

(Inherited from DefaultQuadParticle.)

pubfield

EndColor

The Particle's Color when it dies

NOTE: This should be a Non-Premultipilied color.

(Inherited from DPSFDefaultBaseParticle.)

pubfield

EndHeight

The Height of the Particle when it dies

(Inherited from DefaultQuadParticle.)

pubfield

EndWidth

The Width of the Particle when it dies

(Inherited from DefaultQuadParticle.)

pubfield

ExternalForce

An External Force that may be applied to the Particle

(Inherited from DPSFDefaultBaseParticle.)

pubfield

Friction

The Friction to apply to the Particle

(Inherited from DPSFDefaultBaseParticle.)

pubfield

Height

The Height of the Particle

(Inherited from DefaultQuadParticle.)

pubfield

NormalizedTextureCoordinateLeftTop

The Normalized (0.0 - 1.0) Top-Left Texture Coordinate to use for the Particle's image

(Inherited from DefaultTextureQuadTextureCoordinatesParticle.)

pubfield

NormalizedTextureCoordinateRightBottom

The Normalized (0.0 - 1.0) Bottom-Right Texture Coordinate to use for the Particle's image

(Inherited from DefaultTextureQuadTextureCoordinatesParticle.)

pubfield

Orientation

The Orientation of the Particle

(Inherited from DefaultQuadParticle.)

pubfield

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.)

pubfield

RotationalAcceleration

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

(Inherited from DefaultQuadParticle.)

pubfield

RotationalVelocity

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

(Inherited from DefaultQuadParticle.)

pubfield

StartColor

The Particle's Color when it is born.

NOTE: This should be a Non-Premultipilied color.

(Inherited from DPSFDefaultBaseParticle.)

pubfield

StartHeight

The Height of the Particle when it is born

(Inherited from DefaultQuadParticle.)

pubfield

StartWidth

The Width of the Particle when it is born

(Inherited from DefaultQuadParticle.)

pubfield

Velocity

The Particle's Velocity

(Inherited from DPSFDefaultBaseParticle.)

pubfield

Width

The Width of the Particle

(Inherited from DefaultQuadParticle.)

collapse_allProperties

 

Name

Description

pubproperty

ColorAsPremultiplied

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

(Inherited from DPSFDefaultBaseParticle.)

pubproperty

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.)

pubproperty

EndColorAsPremultiplied

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

(Inherited from DPSFDefaultBaseParticle.)

pubproperty

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.

(Inherited from DefaultQuadParticle.)

pubproperty

LastElapsedTime

Get the Elapsed Time of the Particle at the previous frame

(Inherited from DPSFParticle.)

pubproperty

LastNormalizedElapsedTime

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

(Inherited from DPSFParticle.)

pubproperty

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.)

pubproperty

Normal

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

(Inherited from DefaultQuadParticle.)

pubproperty

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.)

pubproperty

Right

Get / Set the Right direction of the Particle

(Inherited from DefaultQuadParticle.)

pubproperty

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.

(Inherited from DefaultQuadParticle.)

pubproperty

StartColorAsPremultiplied

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

(Inherited from DPSFDefaultBaseParticle.)

pubproperty

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.

(Inherited from DefaultQuadParticle.)

pubproperty

Up

Get / Set the Up direction of the Particle

(Inherited from DefaultQuadParticle.)

pubproperty

Visible

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

(Inherited from DPSFParticle.)

collapse_allSee Also

DefaultAnimatedTexturedQuadParticle Class

DPSF Namespace

footer

Send comments on this topic to
Dan@DansKingdom.com