Class ParticleSystem

Class that represents a particle system asset.

Inheritance
object
DisposableObject
ParticleSystem
Implements
Inherited Members
Namespace: Evergine.Framework.Particles.Asset
Assembly: Evergine.Framework.dll
Syntax
public class ParticleSystem : DisposableObject, ILoadable, IDependencyObject

Properties

Dependencies

Gets the list of dependencies.

Declaration
public Lazy<List<IDependencyLink>> Dependencies { get; }
Property Value
Type Description
Lazy<List<IDependencyLink>>

Emitters

Gets the particle system emitters.

Declaration
public IEnumerable<ParticlesEmitter> Emitters { get; }
Property Value
Type Description
IEnumerable<ParticlesEmitter>

Id

Gets or sets the asset ID.

Declaration
public Guid Id { get; set; }
Property Value
Type Description
Guid

The asset path.

ReaderVersion

Gets the particle system asset version.

Declaration
public Version ReaderVersion { get; }
Property Value
Type Description
Version

Methods

AddEmitter(ParticlesEmitter)

Adds a new particle system emitter.

Declaration
public void AddEmitter(ParticlesEmitter emitter)
Parameters
Type Name Description
ParticlesEmitter emitter

The new emitter.

AddEmitterAt(ParticlesEmitter, int)

Adds a new particle system emitter.

Declaration
public void AddEmitterAt(ParticlesEmitter emitter, int index)
Parameters
Type Name Description
ParticlesEmitter emitter

The new emitter.
int index

The index at which the emitter should be added.

Destroy()

Destroys all resources of this instance.

Declaration
protected override void Destroy()
Overrides

Instantiate()

Generates an entity that contains this asset.

Declaration
public Entity Instantiate()
Returns
Type Description
Entity

The entity.

Invalidate(ILoadable)

Invalidates this instance and raises the Invalidated event with the new ILoadable instance.

Declaration
public void Invalidate(ILoadable newInstance)
Parameters
Type Name Description
ILoadable newInstance

The new ILoadable instance.

ReleaseUnusedMemory()

Releases unused memory.

Declaration
public void ReleaseUnusedMemory()

RemoveEmitter(ParticlesEmitter)

Removes the particle system emitter.

Declaration
public void RemoveEmitter(ParticlesEmitter emitter)
Parameters
Type Name Description
ParticlesEmitter emitter

The emitter to remove.

RemoveEmitter(int)

Removes the particle system emitter.

Declaration
public void RemoveEmitter(int index)
Parameters
Type Name Description
int index

The index of the emitter to remove.

Events

EmitterAdded

Event triggered when an emitter is added to the system.

Declaration
public event EventHandler<ParticlesEmitter> EmitterAdded
Event Type
Type Description
EventHandler<ParticlesEmitter>

EmitterRemoved

Event launched when an emitter has been removed from the system.

Declaration
public event EventHandler<ParticlesEmitter> EmitterRemoved
Event Type
Type Description
EventHandler<ParticlesEmitter>

Invalidated

Occurs when this instance is invalidated and all references must be reloaded.

Declaration
public event EventHandler<ILoadable> Invalidated
Event Type
Type Description
EventHandler<ILoadable>

Implements

Extension Methods