Struct ParticlePool.Enumerator

Namespace

Stride.Particles

Assembly

Stride.Particles.dll

public struct ParticlePool.Enumerator : IEnumerator<Particle>, IEnumerator, IDisposable

Implements

IEnumerator<Particle>

IEnumerator

IDisposable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

Extension Methods

ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)

ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)

Constructors

Enumerator(ParticlePool)

Creates an enumarator which iterates over all particles (living and dead) in the particle pool.

public Enumerator(ParticlePool particlePool)

Parameters

particlePool ParticlePool

Particle pool to iterate

Enumerator(ParticlePool, int, int)

ParticlePool.Enumerator to the particles in this ParticlePool

public Enumerator(ParticlePool particlePool, int idxFrom, int idxTo)

Parameters

particlePool ParticlePool

Particle pool to iterate

idxFrom int

First valid particle index

idxTo int

Last valid particle index

Properties

Current

Gets the element in the collection at the current position of the enumerator.

public Particle Current { get; }

Property Value

Particle

The element in the collection at the current position of the enumerator.

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

MoveNext()

Advances the enumerator to the next element of the collection.

public bool MoveNext()

Returns

bool

true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection.

Exceptions

InvalidOperationException

The collection was modified after the enumerator was created.

RemoveCurrent(ref Particle)

Removes the current particle. A reference to the particle is required so that the addressing can be updated and prevent illegal access.

public void RemoveCurrent(ref Particle particle)

Parameters

particle Particle

Reference to the particle being removed

Reset()

Sets the enumerator to its initial position, which is before the first element in the collection.

public void Reset()

Exceptions

InvalidOperationException

The collection was modified after the enumerator was created.