Stride

OPEN / CLOSE
  • Features
  • Blog
  • Documentation
  • Community
(icon) Download

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

OPEN / CLOSE
  • English
  • 日本語
    Show / Hide Table of Contents

    ParticlePool.Enumerator Struct

    Namespace: Stride.Particles
    Assembly: Stride.Particles.dll

    public struct Enumerator : IEnumerator<Particle>, IEnumerator, IDisposable
    Name Description
    Constructors
    Enumerator(ParticlePool)

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

    Enumerator(ParticlePool, Int32, Int32) ParticlePool.Enumerator to the particles in this ParticlePool
    Properties
    Current
    Methods
    Dispose()
    MoveNext()
    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.

    Reset()
    Explicit Interface Implementations
    IEnumerator.Current
    | Improve this Doc View Source

    Constructors


    Enumerator(ParticlePool)

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

    public Enumerator(ParticlePool particlePool)
    Parameters
    Type Name Description
    ParticlePool particlePool

    Particle pool to iterate


    Enumerator(ParticlePool, Int32, Int32)

    ParticlePool.Enumerator to the particles in this ParticlePool
    public Enumerator(ParticlePool particlePool, int idxFrom, int idxTo)
    Parameters
    Type Name Description
    ParticlePool particlePool

    Particle pool to iterate

    System.Int32 idxFrom

    First valid particle index

    System.Int32 idxTo

    Last valid particle index

    | Improve this Doc View Source

    Properties


    Current

    public readonly Particle Current { get; }
    Property Value
    Type Description
    Particle
    | Improve this Doc View Source

    Methods


    Dispose()

    public void Dispose()

    MoveNext()

    public bool MoveNext()
    Returns
    Type Description
    System.Boolean

    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
    Type Name Description
    Particle particle

    Reference to the particle being removed


    Reset()

    public void Reset()
    | Improve this Doc View Source

    Explicit Interface Implementations


    IEnumerator.Current

    readonly object IEnumerator.Current { get; }
    Returns
    Type Description
    System.Object

    Inherited Members

    System.ValueType.Equals(System.Object)
    System.ValueType.GetHashCode()
    System.ValueType.ToString()

    Extension Methods

    ComponentBaseExtensions.DisposeBy<T>(T, ICollectorHolder)
    ComponentBaseExtensions.RemoveDisposeBy<T>(T, ICollectorHolder)
    • Improve this Doc
    • View Source
    In This Article

    Back to top

    Copyright © 2019-2021 .NET Foundation and Contributors
    Supported by the .NET Foundation