Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    InitialPositionArc Class

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

    The InitialPositionArc is an initializer which sets the particle's initial position along a line or an arc

    System.Object → ParticleTransform → ParticleModule → ParticleInitializer → InitialPositionArc
    Derived from InitialPositionArc:

    [DataContract("InitialPositionArc")]
    [Display("Position (Arc)", null)]
    public class InitialPositionArc : ParticleInitializer
    Name Description
    Constructors
    InitialPositionArc()

    Default constructor which also registers the fields required by this updater

    Fields
    ArcHeight

    The height of the arc in the center, which is also subject to scale and rotation if inherited

    FallbackTarget

    In case the Target is null, the FallbackTarget offset will be used

    FixedLength

    If positive, it will limit the number of possible positions where the particles can appear along the arc to the specified count. More particles will start appearing over from the biginning of the arc path.

    Sequential

    If true the particles will appear along the arc path in the order they are added. Otherwise, their positions will be random along the arc, not preserving the order of appearance.

    Target

    An arc initializer needs a second point so that it can position the particles in a line or arc between two locators

    Properties
    PositionMax

    The right upper front corner of the box

    PositionMin

    The left bottom back corner of the box

    SeedOffset

    The seed offset used to match or separate random values

    Methods
    Initialize(ParticlePool, Int32, Int32, Int32)
    | Improve this Doc View Source

    Constructors


    InitialPositionArc()

    Default constructor which also registers the fields required by this updater

    public InitialPositionArc()
    | Improve this Doc View Source

    Fields


    ArcHeight

    The height of the arc in the center, which is also subject to scale and rotation if inherited

    [DataMember(20)]
    [Display("Arc Height", null)]
    public float ArcHeight
    Field Value
    Type Description
    System.Single

    FallbackTarget

    In case the Target is null, the FallbackTarget offset will be used

    [DataMember(12)]
    [Display("Fallback Target", null)]
    public Vector3 FallbackTarget
    Field Value
    Type Description
    Vector3

    FixedLength

    If positive, it will limit the number of possible positions where the particles can appear along the arc to the specified count. More particles will start appearing over from the biginning of the arc path.

    [DataMember(35)]
    [Display("Fixed Count", null)]
    public int FixedLength
    Field Value
    Type Description
    System.Int32

    Sequential

    If true the particles will appear along the arc path in the order they are added. Otherwise, their positions will be random along the arc, not preserving the order of appearance.

    [DataMember(30)]
    [Display("Ordered", null)]
    public bool Sequential
    Field Value
    Type Description
    System.Boolean

    Target

    An arc initializer needs a second point so that it can position the particles in a line or arc between two locators

    [DataMember(10)]
    [Display("Target", null)]
    public TransformComponent Target
    Field Value
    Type Description
    TransformComponent
    | Improve this Doc View Source

    Properties


    PositionMax

    The right upper front corner of the box

    [DataMember(42)]
    [Display("Position max", null)]
    public Vector3 PositionMax { get; set; }
    Property Value
    Type Description
    Vector3

    PositionMin

    The left bottom back corner of the box

    [DataMember(40)]
    [Display("Position min", null)]
    public Vector3 PositionMin { get; set; }
    Property Value
    Type Description
    Vector3

    SeedOffset

    The seed offset used to match or separate random values

    [DataMember(50)]
    [Display("Random Seed", null)]
    public uint SeedOffset { get; set; }
    Property Value
    Type Description
    System.UInt32
    | Improve this Doc View Source

    Methods


    Initialize(ParticlePool, Int32, Int32, Int32)

    public override void Initialize(ParticlePool pool, int startIdx, int endIdx, int maxCapacity)
    Parameters
    Type Name Description
    ParticlePool pool
    System.Int32 startIdx
    System.Int32 endIdx
    System.Int32 maxCapacity
    Overrides
    ParticleInitializer.Initialize(ParticlePool, Int32, Int32, Int32)

    Inherited Members

    ParticleModule.Enabled
    ParticleModule.ResetSimulation()
    ParticleModule.TryGetDebugDrawShape(DebugDrawShape, Vector3, Quaternion, Vector3)
    ParticleModule.RequiredFields
    ParticleModule.SetParentTRS(ParticleTransform, ParticleSystem)
    ParticleModule.InvalidateRelations()
    ParticleModule.PreUpdate()
    ParticleTransform.InheritPosition
    ParticleTransform.Position
    ParticleTransform.InheritRotation
    ParticleTransform.Rotation
    ParticleTransform.InheritScale
    ParticleTransform.Scale
    ParticleTransform.ScaleUniform
    ParticleTransform.DisplayParticlePosition
    ParticleTransform.DisplayParticleRotation
    ParticleTransform.DisplayParticleScale
    ParticleTransform.DisplayParticleScaleUniform
    ParticleTransform.WorldPosition
    ParticleTransform.WorldRotation
    ParticleTransform.WorldScale
    ParticleTransform.SetParentTransform(ParticleTransform)

    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