Stride

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

  • Discord
  • Facebook
  • Twitter
  • YouTube

LANGUAGE

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

    InitialPositionSeed Class

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

    The InitialPositionSeed is an initializer which sets the particle's initial position at the time of spawning

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

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

    Default constructor which also registers the fields required by this updater

    Fields
    Interpolate

    If set to true it will interpolate the particles between the old and the new position, rather than using only the new one

    Properties
    DebugDraw

    Should this Particle Module's bounds be displayed as a debug draw

    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)
    TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3)

    Attepmts to get a debug shape (shape type and location matrix) for the current module in order to display its boundaries better

    | Improve this Doc View Source

    Constructors


    InitialPositionSeed()

    Default constructor which also registers the fields required by this updater

    public InitialPositionSeed()
    | Improve this Doc View Source

    Fields


    Interpolate

    If set to true it will interpolate the particles between the old and the new position, rather than using only the new one

    [DataMember(50)]
    [Display("Interpolate", null)]
    public bool Interpolate
    Field Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Properties


    DebugDraw

    Should this Particle Module's bounds be displayed as a debug draw

    [DataMember(-1)]
    public bool DebugDraw { get; set; }
    Property Value
    Type Description
    System.Boolean

    PositionMax

    The right upper front corner of the box

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

    PositionMin

    The left bottom back corner of the box

    [DataMember(30)]
    [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(8)]
    [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)

    TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3)

    Attepmts to get a debug shape (shape type and location matrix) for the current module in order to display its boundaries better

    public override bool TryGetDebugDrawShape(out DebugDrawShape debugDrawShape, out Vector3 translation, out Quaternion rotation, out Vector3 scale)
    Parameters
    Type Name Description
    DebugDrawShape debugDrawShape

    Type of the debug draw shape

    Vector3 translation

    Translation of the shape

    Quaternion rotation

    Rotation of the shape

    Vector3 scale

    Scaling of the shape

    Returns
    Type Description
    System.Boolean
    Overrides
    ParticleModule.TryGetDebugDrawShape(out DebugDrawShape, out Vector3, out Quaternion, out Vector3)

    Inherited Members

    ParticleModule.Enabled
    ParticleModule.ResetSimulation()
    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