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
ParticleSystemManager Members
gradient

The ParticleSystemManager type exposes the following members.

collapse_allConstructors

 

Name

Description

pubmethod

ParticleSystemManager()()()()

Initializes a new instance of the ParticleSystemManager class.

pubmethod

ParticleSystemManager(ParticleSystemManager)

Initializes a new instance of the ParticleSystemManager class, copying the settings of the given Particle System Manager.

collapse_allMethods

 

Name

Description

pubmethod

AddParticleSystem

Add an initialized Particle System to the Particle System Manager.

NOTE: This sets the Particle System's ParticleSystemManagerToCopyPropertiesFrom property to this Particle System Manager.

pubmethod

AutoInitializeAllParticleSystems

Calls the AutoInitialize() function for every Particle System in this Manager

pubmethod

ContainsParticleSystem(Int32)

Returns true if the Particle System with the given ID is in the Manager, false if not.

pubmethod

ContainsParticleSystem(IDPSFParticleSystem)

Returns true if the given Particle System is in the Manager, false if not.

pubmethod

CopyFrom

Copies the given DPSF Particle System Manager's information into this Manager.

pubmethod

DestroyAllParticleSystems

Calls the Destroy() function for every Particle System in this Manager

pubmethod

DestroyAndRemoveAllParticleSystems

Destroys each Particle System in the Manager, then removes them from the Manager

pubmethod

DrawAllParticleSystems

Draws all of the Particle Systems.

NOTE: This will only Draw the Particle Systems if they do not inherit from DrawableGameComponent, since if they do they will be drawn automatically by the Game object.

pubmethod

DrawAllParticleSystemsAnimationToFiles

Draws the Particle Systems' Animation over the given timespan to a sequence of Image files.

NOTE: This function is not available on the Xbox 360.

pubmethod

DrawAllParticleSystemsForced

Draws all of the Particle Systems, even if they inherit from DrawableGameComponent.

NOTE: If the Particle Systems inherit from DrawableGameComponent and this is called, the Particle Systems will be drawn twice each frame; once here and once when called automatically by the game object. If not inheriting from DrawableGameComponent, this function acts the same as calling DrawAllParticleSystems().

pubmethod

DrawAllParticleSystemsToTexture

Draws all of the Particle Systems to a Texture and returns the Texture, which has a Transparent Black background

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

protmethod

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

pubmethod

RemoveAllParticleSystems

Removes all Particle Systems from the Particle System Manager

pubmethod

RemoveParticleSystem(Int32)

Removes the specified Particle System from the Particle System Manager. Returns true if the Particle System was found and removed, false if it was not found.

pubmethod

RemoveParticleSystem(IDPSFParticleSystem)

Removes the specified Particle System from the Particle System Manager. Returns true if the Particle System was found and removed, false if it was not found.

pubmethod

SetCameraPositionForAllParticleSystems

Sets the CameraPosition property of all particle systems in this manager to the given Camera Position. This is done by calling the particle system's virtual SetCameraPosition() function.

pubmethod

SetEnabledAndVisibleStatesForAllParticleSystems

Sets the Enabled and Visible properties of all particle systems in this manager to the given states.

pubmethod

SetEnabledStateForAllParticleSystems

Sets the Enabled property of all particle systems in this manager to the given state.

pubmethod

SetPerformanceProfilingIsEnabledForAllParticleSystems

Sets the PerformanceProfilingIsEnabled property of all particle systems in this manager to the given value.

pubmethod

SetSimulationSpeedForAllParticleSystems

Sets each individual Particle Systems' Simulation Speed to the specified Simulation Speed.

pubmethod

SetTransformationMatrixForAllSpriteParticleSystems

Sets the SpriteBatchSettings.TransformationMatrix for all Sprite Particle Systems in this Manager.

pubmethod

SetUpdatesPerSecondForAllParticleSystems

Sets each individual Particle Systems' Updates Per Second to the specified Updates Per Second.

pubmethod

SetVisibleStateForAllParticleSystems

Sets the Visible property of all particle systems in this manager to the given state.

pubmethod

SetWorldViewProjectionMatricesForAllParticleSystems

Sets the World, View, and Projection Matrices for all of the Particle Systems in this Manager.

NOTE: Sprite particle systems are not affected by the World, View, and Projection matrices.

pubmethod

ToString

Returns a String that represents the current Object.

(Inherited from Object.)

pubmethod

UpdateAllParticleSystems

Updates all of the Particle Systems.

NOTE: This will only Update the Particle Systems if they do not inherit from DrawableGameComponent, since if they do they will be updated automatically by the Game object.

pubmethod

UpdateAllParticleSystemsForced

Updates all of the Particle Systems.

NOTE: If the Particle Systems inherit from DrawableGameComponent and this is called, the Particle Systems will be updated twice each frame; once here and once when called automatically by the game object. If not inheriting from DrawableGameComponent, this function acts the same as calling UpdateAllParticleSystems().

collapse_allProperties

 

Name

Description

pubproperty

Enabled

Get / Set if the Particle Systems should be Updated or not.

pubproperty

ParticleSystems

Returns a Linked List of handles to the Particle Systems in this Manager

pubproperty

ParticleSystemsInheritDrawableGameComponent

Get if the Particle Systems are inheriting from DrawableGameComponent or not

pubproperty

SimulationSpeed

Get / Set how fast the Particle System Simulations should run.

Example: 1.0 = normal speed, 0.5 = half speed, 2.0 = double speed.

NOTE: This sets the SimulationSpeed property of each individual Particle System in this Manager to the given value. It will also set a particle system's Simulation Speed when the particle system is re-initialized, and when a new Particle System is added to the Manager in the future.

NOTE: Setting this property only has an effect if the SimulationSpeedIsEnabled property is true.

NOTE: This will be set to zero if a negative value is specified.

pubproperty

SimulationSpeedIsEnabled

Get / Set if the Particle System Manager's SimulationSpeed property should be used for each of the particle systems it contains or not.

Default value is true.

pubproperty

TotalNumberOfActiveParticles

Get the cumulative Number Of Active Particles of all Particle Systems in this Manager

pubproperty

TotalNumberOfParticlesAllocatedInMemory

Get the cumulative Max Number Of Particles allocated in memory by all Particle Systems in the Manager.

pubproperty

TotalNumberOfParticlesBeingDrawn

Get the cumulative Number Of Particles Being Drawn by all Particle Systems in this Manager. This is the total number of Active AND Visible Particles.

NOTE: This ignores whether the Manager is Visible or not.

pubproperty

TotalPerformanceTimeToDoDrawsInMilliseconds

Gets the cumulative time (in milliseconds) it took to perform the Draw() function on each particle system in this manager.

Note: Only particle systems that have their PerformanceProfilingIsEnabled property set to true will be included in this total.

pubproperty

TotalPerformanceTimeToDoUpdatesInMilliseconds

Gets the cumulative time (in milliseconds) it took to perform the Update() function on each particle system in this manager.

Note: Only particle systems that have their PerformanceProfilingIsEnabled property set to true will be included in this total.

pubproperty

UpdatesPerSecond

Get / Set how often the Particle Systems should be Updated.

NOTE: This sets the UpdatesPerSecond property of each individual Particle System in this Manager to the given value. It will also set a particle system's Updates Per Second when the particle system is re-initialized, and when a new Particle System is added to the Manager in the future.

NOTE: Setting this property only has an effect if the UpdatesPerSecondIsEnabled property is true.

NOTE: A value of zero means update the particle systems every time Update() is called.

NOTE: This will be set to zero if a negative value is specified.

pubproperty

UpdatesPerSecondIsEnabled

Get / Set if the Particle System Manager's UpdatesPerSecond property should be used for each of the particle systems it contains or not.

Default value is true.

pubproperty

Visible

Get / Set if this Particle Systems should be drawn or not.

NOTE: Setting this to false causes the particle systems' Draw() function to not be called, including the particle systems' BeforeDraw() and AfterDraw() functions.

collapse_allSee Also

ParticleSystemManager Class

DPSF Namespace

footer

Send comments on this topic to
Dan@DansKingdom.com