Class CpuParticlePreset

Namespace

OmegaEngine.Graphics.Renderables

Assembly

OmegaEngine.dll

A set of information about a particle system as a whole

public class CpuParticlePreset : ICloneable

Inheritance

object

CpuParticlePreset

Implements

ICloneable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

XmlStorage.SaveXmlZip<T>(T, Stream, string?, params EmbeddedFile[])

XmlStorage.SaveXmlZip<T>(T, string, string?, params EmbeddedFile[])

XmlStorage.SaveXml<T>(T, Stream, string?)

XmlStorage.SaveXml<T>(T, string, string?)

XmlStorage.ToXmlString<T>(T, string?)

Constructors

CpuParticlePreset()

public CpuParticlePreset()

Properties

EmitterRepelRange

How far the emitter's repelling force can reach

public float EmitterRepelRange { get; set; }

Property Value

float

EmitterRepelSpeed

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

public float EmitterRepelSpeed { get; set; }

Property Value

float

EmitterSuctionRange

From where the emitter suction force starts to act

public float EmitterSuctionRange { get; set; }

Property Value

float

EmitterSuctionSpeed

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

public float EmitterSuctionSpeed { get; set; }

Property Value

float

Gravity

A permanent acceleration force applied to all particles

public Vector3 Gravity { get; set; }

Property Value

Vector3

InfiniteLifetime1

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

[Browsable(false)]
public bool InfiniteLifetime1 { get; }

Property Value

bool

InfiniteLifetime2

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

[Browsable(false)]
public bool InfiniteLifetime2 { get; }

Property Value

bool

LowerParameters1

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

[Browsable(false)]
public CpuParticleParameters LowerParameters1 { get; set; }

Property Value

CpuParticleParameters

LowerParameters2

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

[Browsable(false)]
public CpuParticleParameters LowerParameters2 { get; set; }

Property Value

CpuParticleParameters

MaxParticles

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

public int MaxParticles { get; set; }

Property Value

int

Particle1Alpha

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

public int Particle1Alpha { get; set; }

Property Value

int

Particle1Texture

The ID of the texture to place on the particles

public string Particle1Texture { get; set; }

Property Value

string

Particle2Alpha

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

public int Particle2Alpha { get; set; }

Property Value

int

Particle2Texture

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

public string Particle2Texture { get; set; }

Property Value

string

RandomAcceleration

Randomly accelerate particles with up to the specified speed

public float RandomAcceleration { get; set; }

Property Value

float

SpawnRadius

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

public float SpawnRadius { get; set; }

Property Value

float

SpawnRate

How many new particles shall be spawned per second

public float SpawnRate { get; set; }

Property Value

float

Speed

A factor by which all elapsed times are multiplied

public float Speed { get; set; }

Property Value

float

UpperParameters1

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

[Browsable(false)]
public CpuParticleParameters UpperParameters1 { get; set; }

Property Value

CpuParticleParameters

UpperParameters2

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

[Browsable(false)]
public CpuParticleParameters UpperParameters2 { get; set; }

Property Value

CpuParticleParameters

WarmupTime

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

public float WarmupTime { get; set; }

Property Value

float

Methods

Clone()

Creates a deep copy of the this particle system preset

public CpuParticlePreset Clone()

Returns

CpuParticlePreset

The cloned preset

FromContent(string)

Loads a preset from an XML file via the ContentManager.

public static CpuParticlePreset FromContent(string id)

Parameters

id string

The ID of the XML file to load

Returns

CpuParticlePreset

The loaded preset

Exceptions

FileNotFoundException

The specified file could not be found.

IOException

There was an error reading the file.

UnauthorizedAccessException

Read access to the file is not permitted.

InvalidOperationException

A problem occurred while deserializing the XML data.