OmegaEngine API  1.0.3
Public Member Functions | Static Public Member Functions | Properties | List of all members
OmegaEngine.Graphics.Renderables.GpuParticlePreset Class Reference

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

Inheritance diagram for OmegaEngine.Graphics.Renderables.GpuParticlePreset:
NanoByte::Common::ICloneable< T >

Public Member Functions

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

Static Public Member Functions

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

Properties

float SpawnRadius = 1 [get, set]
 The largest distance from the emitter at which particle shall be spawned More...
 
float SystemHeight = 80 [get, set]
 The largest distance from the emitter particles can travel before dying More...
 
Vector3 Movement = new Vector3(0, 0.48f, 0) [get, set]
 The direction and speed with which the particles move More...
 
float ParticleSpread = 20 [get, set]
 How to spread the particles More...
 
float ParticleSize = 7.8f [get, set]
 The size of the particles More...
 
float ParticleShape = 0.38f [get, set]
 The shape of the particles More...
 
string ParticleTexture [get, set]
 The ID of the texture to use for color lookup More...
 

Detailed Description

A set of information about a particle system as a whole

Member Function Documentation

◆ Clone()

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

Creates a deep copy of the this particle system preset

Returns
The cloned preset

Implements NanoByte::Common::ICloneable< T >.

◆ FromContent()

static GpuParticlePreset OmegaEngine.Graphics.Renderables.GpuParticlePreset.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.

Property Documentation

◆ Movement

Vector3 OmegaEngine.Graphics.Renderables.GpuParticlePreset.Movement = new Vector3(0, 0.48f, 0)
getset

The direction and speed with which the particles move

◆ ParticleShape

float OmegaEngine.Graphics.Renderables.GpuParticlePreset.ParticleShape = 0.38f
getset

The shape of the particles

◆ ParticleSize

float OmegaEngine.Graphics.Renderables.GpuParticlePreset.ParticleSize = 7.8f
getset

The size of the particles

◆ ParticleSpread

float OmegaEngine.Graphics.Renderables.GpuParticlePreset.ParticleSpread = 20
getset

How to spread the particles

◆ ParticleTexture

string OmegaEngine.Graphics.Renderables.GpuParticlePreset.ParticleTexture
getset

The ID of the texture to use for color lookup

◆ SpawnRadius

float OmegaEngine.Graphics.Renderables.GpuParticlePreset.SpawnRadius = 1
getset

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

◆ SystemHeight

float OmegaEngine.Graphics.Renderables.GpuParticlePreset.SystemHeight = 80
getset

The largest distance from the emitter particles can travel before dying


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