Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    ParticleSystemControl Class

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

    Edit-time controls for the ParticleSystemComponent

    System.Object → ParticleSystemControl
    Derived from ParticleSystemControl:

    [DataContract("ParticleSystemControl")]
    public class ParticleSystemControl
    Name Description
    Properties
    Control

    State control used to Play, Pause or Stop the ParticleSystem

    ResetSeconds

    Resets the ParticleSystem every X seconds, starting the simulation over again. Setting it to 0 means the particle system won't be resetted

    ThumbnailWarmupTime

    Warm-up time is the amount of time the system should spend in background pre-simulation when capturing the thumbnail

    Methods
    Update(Single, ParticleSystem)

    Update the control with delta time. It will pause or restart the ParticleSystem if necessary

    | Improve this Doc View Source

    Properties


    Control

    State control used to Play, Pause or Stop the ParticleSystem

    [DataMember(30)]
    public StateControl Control { get; set; }
    Property Value
    Type Description
    StateControl

    ResetSeconds

    Resets the ParticleSystem every X seconds, starting the simulation over again. Setting it to 0 means the particle system won't be resetted

    [DataMember(20)]
    [Display("Reset after (seconds)", null)]
    public float ResetSeconds { get; set; }
    Property Value
    Type Description
    System.Single

    ThumbnailWarmupTime

    Warm-up time is the amount of time the system should spend in background pre-simulation when capturing the thumbnail

    [DataMember(40)]
    [Display("Thumbnail Warm-up", null)]
    [DataMemberRange(0, 5, 0.01, 1, 3)]
    public float ThumbnailWarmupTime { get; set; }
    Property Value
    Type Description
    System.Single
    | Improve this Doc View Source

    Methods


    Update(Single, ParticleSystem)

    Update the control with delta time. It will pause or restart the ParticleSystem if necessary

    public void Update(float dt, ParticleSystem particleSystem)
    Parameters
    Type Name Description
    System.Single dt

    Delta time elapsed since the last update call

    ParticleSystem particleSystem

    The ParticleSystem which this control should manage


    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