Space Engineers
Public Member Functions | Public Attributes | Properties | Events | List of all members
VRage.Game.MyParticleEffect Class Reference

Public Member Functions

void SetShowOnlyThisGeneration (IMyParticleGeneration generation)
 
void SetShowOnlyThisGeneration (int generationIndex)
 
 MyParticleEffect ()
 
void Start (int particleID)
 
void Restart ()
 
void Close (bool done)
 
void Clear ()
 
MyParticleEffect CreateInstance ()
 
void Stop ()
 This method stops & deletes effect completely More...
 
void Play ()
 This method restores effect More...
 
void Pause ()
 This methods freezes effect and particles More...
 
void StopEmitting ()
 This method stops generating any new particles More...
 
void SetDirty ()
 
void SetAnimDirty ()
 
void SetPositionDirty ()
 
void RemoveInstance (MyParticleEffect effect)
 
MyParticleEffect Duplicate ()
 
MatrixD GetDeltaMatrix ()
 
bool Update ()
 
void SetRandomDuration ()
 
float GetScale ()
 
float GetEmitterScale ()
 
Vector3 GetEmitterAxisScale ()
 
float GetElapsedTime ()
 
int GetID ()
 
int GetParticlesCount ()
 
void SetID (int id)
 
string GetName ()
 
void SetName (string name)
 
void AddGeneration (IMyParticleGeneration generation)
 
void RemoveGeneration (int index)
 
void RemoveGeneration (IMyParticleGeneration generation)
 
List< IMyParticleGeneration > GetGenerations ()
 
BoundingBoxD GetAABB ()
 
void AddParticleLight (MyParticleLight particleLight)
 
void RemoveParticleLight (int index)
 
void RemoveParticleLight (MyParticleLight particleLight)
 
List< MyParticleLight > GetParticleLights ()
 
void AddParticleSound (MyParticleSound particleSound)
 
void RemoveParticleSound (int index)
 
void RemoveParticleSound (MyParticleSound particleSound)
 
List< MyParticleSound > GetParticleSounds ()
 
void Serialize (XmlWriter writer)
 
void Deserialize (XmlReader reader)
 
void DeserializeFromObjectBuilder (MyObjectBuilder_ParticleEffect builder)
 
void PrepareForDraw ()
 
void Draw (List< VRageRender.MyBillboard > collectedBillboards)
 
void DebugDraw ()
 

Public Attributes

bool EnableLods
 
Vector3 UserAxisScale
 
bool UserDraw
 
bool CalculateDeltaMatrix
 
MatrixD DeltaMatrix
 
uint RenderCounter = 0
 
Vector3 Velocity
 

Properties

float UserEmitterScale [get, set]
 
float UserScale [get, set]
 
float UserBirthMultiplier [get, set]
 
float UserRadiusMultiplier [get, set]
 
Vector4 UserColorMultiplier [get, set]
 
int ShowOnlyThisGeneration [get]
 
Vector3 Gravity [get, set]
 
bool Enabled [get, set]
 
int ID [get, set]
 
float Length [get, set]
 
float Duration [get]
 
float DurationMin [get, set]
 
float DurationMax [get, set]
 
bool Loop [get, set]
 
MatrixD WorldMatrix [get, set]
 
string Name [get, set]
 
float Distance [get]
 
object Tag [get, set]
 
bool IsStopped [get]
 
bool IsSimulationPaused [get]
 
bool IsEmittingStopped [get]
 

Events

EventHandler OnDelete = null
 
EventHandler OnUpdate = null
 

Detailed Description

Definition at line 19 of file MyParticleEffect.cs.

Constructor & Destructor Documentation

VRage.Game.MyParticleEffect.MyParticleEffect ( )
inline

Definition at line 178 of file MyParticleEffect.cs.

Member Function Documentation

void VRage.Game.MyParticleEffect.AddGeneration ( IMyParticleGeneration  generation)
inline

Definition at line 751 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.AddParticleLight ( MyParticleLight  particleLight)
inline

Definition at line 813 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.AddParticleSound ( MyParticleSound  particleSound)
inline

Definition at line 858 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.Clear ( )
inline

Definition at line 282 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.Close ( bool  done)
inline

Definition at line 221 of file MyParticleEffect.cs.

MyParticleEffect VRage.Game.MyParticleEffect.CreateInstance ( )
inline

Definition at line 302 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.DebugDraw ( )
inline

Definition at line 1162 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.Deserialize ( XmlReader  reader)
inline

Definition at line 958 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.DeserializeFromObjectBuilder ( MyObjectBuilder_ParticleEffect  builder)
inline

Definition at line 1074 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.Draw ( List< VRageRender.MyBillboard >  collectedBillboards)
inline

Definition at line 1148 of file MyParticleEffect.cs.

MyParticleEffect VRage.Game.MyParticleEffect.Duplicate ( )
inline

Definition at line 453 of file MyParticleEffect.cs.

BoundingBoxD VRage.Game.MyParticleEffect.GetAABB ( )
inline

Definition at line 803 of file MyParticleEffect.cs.

MatrixD VRage.Game.MyParticleEffect.GetDeltaMatrix ( )
inline

Definition at line 489 of file MyParticleEffect.cs.

float VRage.Game.MyParticleEffect.GetElapsedTime ( )
inline

Definition at line 681 of file MyParticleEffect.cs.

Vector3 VRage.Game.MyParticleEffect.GetEmitterAxisScale ( )
inline

Definition at line 676 of file MyParticleEffect.cs.

float VRage.Game.MyParticleEffect.GetEmitterScale ( )
inline

Definition at line 672 of file MyParticleEffect.cs.

List<IMyParticleGeneration> VRage.Game.MyParticleEffect.GetGenerations ( )
inline

Definition at line 790 of file MyParticleEffect.cs.

int VRage.Game.MyParticleEffect.GetID ( )
inline

Definition at line 686 of file MyParticleEffect.cs.

string VRage.Game.MyParticleEffect.GetName ( )
inline

Definition at line 706 of file MyParticleEffect.cs.

List<MyParticleLight> VRage.Game.MyParticleEffect.GetParticleLights ( )
inline

Definition at line 849 of file MyParticleEffect.cs.

int VRage.Game.MyParticleEffect.GetParticlesCount ( )
inline

Definition at line 691 of file MyParticleEffect.cs.

List<MyParticleSound> VRage.Game.MyParticleEffect.GetParticleSounds ( )
inline

Definition at line 894 of file MyParticleEffect.cs.

float VRage.Game.MyParticleEffect.GetScale ( )
inline

Definition at line 668 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.Pause ( )
inline

This methods freezes effect and particles

Definition at line 376 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.Play ( )
inline

This method restores effect

Definition at line 366 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.PrepareForDraw ( )
inline

Definition at line 1136 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.RemoveGeneration ( int  index)
inline

Definition at line 767 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.RemoveGeneration ( IMyParticleGeneration  generation)
inline

Definition at line 784 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.RemoveInstance ( MyParticleEffect  effect)
inline

Definition at line 439 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.RemoveParticleLight ( int  index)
inline

Definition at line 826 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.RemoveParticleLight ( MyParticleLight  particleLight)
inline

Definition at line 843 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.RemoveParticleSound ( int  index)
inline

Definition at line 871 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.RemoveParticleSound ( MyParticleSound  particleSound)
inline

Definition at line 888 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.Restart ( )
inline

Definition at line 216 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.Serialize ( XmlWriter  writer)
inline

Definition at line 903 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.SetAnimDirty ( )
inline

Definition at line 400 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.SetDirty ( )
inline

Definition at line 392 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.SetID ( int  id)
inline

Definition at line 696 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.SetName ( string  name)
inline

Definition at line 711 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.SetPositionDirty ( )
inline

Definition at line 408 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.SetRandomDuration ( )
inline

Definition at line 619 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.SetShowOnlyThisGeneration ( IMyParticleGeneration  generation)
inline

Definition at line 126 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.SetShowOnlyThisGeneration ( int  generationIndex)
inline

Definition at line 140 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.Start ( int  particleID)
inline

Definition at line 183 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.Stop ( )
inline

This method stops & deletes effect completely

Definition at line 356 of file MyParticleEffect.cs.

void VRage.Game.MyParticleEffect.StopEmitting ( )
inline

This method stops generating any new particles

Definition at line 386 of file MyParticleEffect.cs.

bool VRage.Game.MyParticleEffect.Update ( )
inline

Definition at line 496 of file MyParticleEffect.cs.

Member Data Documentation

bool VRage.Game.MyParticleEffect.CalculateDeltaMatrix

Definition at line 155 of file MyParticleEffect.cs.

MatrixD VRage.Game.MyParticleEffect.DeltaMatrix

Definition at line 156 of file MyParticleEffect.cs.

bool VRage.Game.MyParticleEffect.EnableLods

Definition at line 61 of file MyParticleEffect.cs.

uint VRage.Game.MyParticleEffect.RenderCounter = 0

Definition at line 158 of file MyParticleEffect.cs.

Vector3 VRage.Game.MyParticleEffect.UserAxisScale

Definition at line 84 of file MyParticleEffect.cs.

bool VRage.Game.MyParticleEffect.UserDraw

Definition at line 121 of file MyParticleEffect.cs.

Vector3 VRage.Game.MyParticleEffect.Velocity

Definition at line 159 of file MyParticleEffect.cs.

Property Documentation

float VRage.Game.MyParticleEffect.Distance
get

Definition at line 740 of file MyParticleEffect.cs.

float VRage.Game.MyParticleEffect.Duration
get

Definition at line 613 of file MyParticleEffect.cs.

float VRage.Game.MyParticleEffect.DurationMax
getset

Definition at line 615 of file MyParticleEffect.cs.

float VRage.Game.MyParticleEffect.DurationMin
getset

Definition at line 614 of file MyParticleEffect.cs.

bool VRage.Game.MyParticleEffect.Enabled
getset

Definition at line 591 of file MyParticleEffect.cs.

Vector3 VRage.Game.MyParticleEffect.Gravity
getset

Definition at line 163 of file MyParticleEffect.cs.

int VRage.Game.MyParticleEffect.ID
getset

Definition at line 593 of file MyParticleEffect.cs.

bool VRage.Game.MyParticleEffect.IsEmittingStopped
get

Definition at line 801 of file MyParticleEffect.cs.

bool VRage.Game.MyParticleEffect.IsSimulationPaused
get

Definition at line 800 of file MyParticleEffect.cs.

bool VRage.Game.MyParticleEffect.IsStopped
get

Definition at line 797 of file MyParticleEffect.cs.

float VRage.Game.MyParticleEffect.Length
getset

Definition at line 596 of file MyParticleEffect.cs.

bool VRage.Game.MyParticleEffect.Loop
getset

Definition at line 617 of file MyParticleEffect.cs.

string VRage.Game.MyParticleEffect.Name
getset

Definition at line 733 of file MyParticleEffect.cs.

int VRage.Game.MyParticleEffect.ShowOnlyThisGeneration
get

Definition at line 124 of file MyParticleEffect.cs.

object VRage.Game.MyParticleEffect.Tag
getset

Definition at line 745 of file MyParticleEffect.cs.

float VRage.Game.MyParticleEffect.UserBirthMultiplier
getset

Definition at line 90 of file MyParticleEffect.cs.

Vector4 VRage.Game.MyParticleEffect.UserColorMultiplier
getset

Definition at line 112 of file MyParticleEffect.cs.

float VRage.Game.MyParticleEffect.UserEmitterScale
getset

Definition at line 65 of file MyParticleEffect.cs.

float VRage.Game.MyParticleEffect.UserRadiusMultiplier
getset

Definition at line 101 of file MyParticleEffect.cs.

float VRage.Game.MyParticleEffect.UserScale
getset

Definition at line 76 of file MyParticleEffect.cs.

MatrixD VRage.Game.MyParticleEffect.WorldMatrix
getset

Definition at line 718 of file MyParticleEffect.cs.

Event Documentation

EventHandler VRage.Game.MyParticleEffect.OnDelete = null

Definition at line 21 of file MyParticleEffect.cs.

EventHandler VRage.Game.MyParticleEffect.OnUpdate = null

Definition at line 22 of file MyParticleEffect.cs.

The documentation for this class was generated from the following file:
Generated on Mon Jan 23 2017 01:18:08 for Space Engineers by   doxygen 1.8.8