OmegaEngine API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Static Public Member Functions | Public Attributes | Package Attributes | Properties | List of all members
OmegaEngine.Graphics.Renderables.CpuParticlePreset Class Reference

A set of information about a particle system as a whole More...

Inheritance diagram for OmegaEngine.Graphics.Renderables.CpuParticlePreset:

Public Member Functions

CpuParticlePreset Clone ()
 Creates a deep copy of the this particle system preset More...
 

Static Public Member Functions

static CpuParticlePreset FromContent (string id)
 Loads a preset from an XML file via the ContentManager. More...
 

Public Attributes

bool InfiniteLifetime1 => LowerParameters1.LifeTime == CpuParticleParameters.InfiniteFlag || UpperParameters1.LifeTime == CpuParticleParameters.InfiniteFlag
 true CpuParticleParameters.LifeTime is set to CpuParticleParameters.InfiniteFlag for LowerParameters1 or UpperParameters1. More...
 
bool InfiniteLifetime2 => LowerParameters2.LifeTime == CpuParticleParameters.InfiniteFlag || UpperParameters2.LifeTime == CpuParticleParameters.InfiniteFlag
 true CpuParticleParameters.LifeTime is set to CpuParticleParameters.InfiniteFlag for LowerParameters2 or UpperParameters2. More...
 

Package Attributes

bool TexturesDirty
 Flag indicating that Particle1Texture and/or Particle2Texture have changed and need to be reloaded More...
 

Properties

CpuParticleParameters LowerParameters1 [get, set]
 The lower values of the range of parameters used to spawn new particles More...
 
CpuParticleParameters UpperParameters1 [get, set]
 The upper values of the range of parameters used to spawn new particles More...
 
CpuParticleParameters LowerParameters2 [get, set]
 The lower values of the range of parameters used to start particles' "second life" More...
 
CpuParticleParameters UpperParameters2 [get, set]
 The upper values of the range of parameters used to start particles' "second life" More...
 
float SpawnRate [get, set]
 How many new particles shall be spawned per second More...
 
float SpawnRadius [get, set]
 The largest distance from the emitter at which particle shall be spawned More...
 
int MaxParticles [get, set]
 The maximum number particles in existance at any one point in time More...
 
float EmitterRepelRange = 512 [get, set]
 How far the emitter's repelling force can reach More...
 
float EmitterRepelSpeed [get, set]
 How fast particles will be pushed away from the emitter's centre More...
 
float EmitterSuctionRange [get, set]
 From where the emitter suction force starts to act More...
 
float EmitterSuctionSpeed = 32768 [get, set]
 How fast particles will be sucked back to the emitter's centre More...
 
Vector3 Gravity [get, set]
 A permanent acceleration force applied to all particles More...
 
float RandomAcceleration [get, set]
 Randomly accelerate particles with up to the specified speed More...
 
float Speed [get, set]
 A factor by which all elapsed times are multiplied More...
 
float WarmupTime = 1 [get, set]
 How many seconds to "fast forward" the particle system before it's render the first time More...
 
string Particle1Texture [get, set]
 The ID of the texture to place on the particles More...
 
int Particle1Alpha [get, set]
 The level of transparency from 0 (solid) to 255 (invisible), EngineState.AlphaChannel, EngineState.BinaryAlphaChannel or EngineState.AdditivBlending More...
 
string Particle2Texture [get, set]
 The ID of the texture to place on the particles during their "second life" More...
 
int Particle2Alpha [get, set]
 The level of transparency from 0 (solid) to 255 (invisible) for particles' "second life", EngineState.AlphaChannel, EngineState.BinaryAlphaChannel or EngineState.AdditivBlending More...
 

Detailed Description

A set of information about a particle system as a whole

Member Function Documentation

CpuParticlePreset OmegaEngine.Graphics.Renderables.CpuParticlePreset.Clone ( )
inline

Creates a deep copy of the this particle system preset

Returns
The cloned preset
static CpuParticlePreset OmegaEngine.Graphics.Renderables.CpuParticlePreset.FromContent ( string  id)
inlinestatic

Loads a preset from an XML file via the ContentManager.

Parameters
idThe ID of the XML file to load
Returns
The loaded preset
Exceptions
FileNotFoundExceptionThe specified file could not be found.
IOExceptionThere was an error reading the file.
UnauthorizedAccessExceptionRead access to the file is not permitted.
InvalidOperationExceptionA problem occurred while deserializing the XML data.

Member Data Documentation

bool OmegaEngine.Graphics.Renderables.CpuParticlePreset.InfiniteLifetime1 => LowerParameters1.LifeTime == CpuParticleParameters.InfiniteFlag || UpperParameters1.LifeTime == CpuParticleParameters.InfiniteFlag

true CpuParticleParameters.LifeTime is set to CpuParticleParameters.InfiniteFlag for LowerParameters1 or UpperParameters1.

bool OmegaEngine.Graphics.Renderables.CpuParticlePreset.InfiniteLifetime2 => LowerParameters2.LifeTime == CpuParticleParameters.InfiniteFlag || UpperParameters2.LifeTime == CpuParticleParameters.InfiniteFlag

true CpuParticleParameters.LifeTime is set to CpuParticleParameters.InfiniteFlag for LowerParameters2 or UpperParameters2.

bool OmegaEngine.Graphics.Renderables.CpuParticlePreset.TexturesDirty
package

Flag indicating that Particle1Texture and/or Particle2Texture have changed and need to be reloaded

Property Documentation

float OmegaEngine.Graphics.Renderables.CpuParticlePreset.EmitterRepelRange = 512
getset

How far the emitter's repelling force can reach

float OmegaEngine.Graphics.Renderables.CpuParticlePreset.EmitterRepelSpeed
getset

How fast particles will be pushed away from the emitter's centre

float OmegaEngine.Graphics.Renderables.CpuParticlePreset.EmitterSuctionRange
getset

From where the emitter suction force starts to act

float OmegaEngine.Graphics.Renderables.CpuParticlePreset.EmitterSuctionSpeed = 32768
getset

How fast particles will be sucked back to the emitter's centre

Vector3 OmegaEngine.Graphics.Renderables.CpuParticlePreset.Gravity
getset

A permanent acceleration force applied to all particles

CpuParticleParameters OmegaEngine.Graphics.Renderables.CpuParticlePreset.LowerParameters1
getset

The lower values of the range of parameters used to spawn new particles

CpuParticleParameters OmegaEngine.Graphics.Renderables.CpuParticlePreset.LowerParameters2
getset

The lower values of the range of parameters used to start particles' "second life"

int OmegaEngine.Graphics.Renderables.CpuParticlePreset.MaxParticles
getset

The maximum number particles in existance at any one point in time

int OmegaEngine.Graphics.Renderables.CpuParticlePreset.Particle1Alpha
getset

The level of transparency from 0 (solid) to 255 (invisible), EngineState.AlphaChannel, EngineState.BinaryAlphaChannel or EngineState.AdditivBlending

string OmegaEngine.Graphics.Renderables.CpuParticlePreset.Particle1Texture
getset

The ID of the texture to place on the particles

int OmegaEngine.Graphics.Renderables.CpuParticlePreset.Particle2Alpha
getset

The level of transparency from 0 (solid) to 255 (invisible) for particles' "second life", EngineState.AlphaChannel, EngineState.BinaryAlphaChannel or EngineState.AdditivBlending

string OmegaEngine.Graphics.Renderables.CpuParticlePreset.Particle2Texture
getset

The ID of the texture to place on the particles during their "second life"

float OmegaEngine.Graphics.Renderables.CpuParticlePreset.RandomAcceleration
getset

Randomly accelerate particles with up to the specified speed

float OmegaEngine.Graphics.Renderables.CpuParticlePreset.SpawnRadius
getset

The largest distance from the emitter at which particle shall be spawned

float OmegaEngine.Graphics.Renderables.CpuParticlePreset.SpawnRate
getset

How many new particles shall be spawned per second

float OmegaEngine.Graphics.Renderables.CpuParticlePreset.Speed
getset

A factor by which all elapsed times are multiplied

CpuParticleParameters OmegaEngine.Graphics.Renderables.CpuParticlePreset.UpperParameters1
getset

The upper values of the range of parameters used to spawn new particles

CpuParticleParameters OmegaEngine.Graphics.Renderables.CpuParticlePreset.UpperParameters2
getset

The upper values of the range of parameters used to start particles' "second life"

float OmegaEngine.Graphics.Renderables.CpuParticlePreset.WarmupTime = 1
getset

How many seconds to "fast forward" the particle system before it's render the first time


The documentation for this class was generated from the following file: