InitialPositionArc Class
Namespace: Stride.Particles.InitializersAssembly: Stride.Particles.dll
The InitialPositionArc is an initializer which sets the particle's initial position along a line or an arc
[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 |
|
| 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) | ||
Constructors
InitialPositionArc()
Default constructor which also registers the fields required by this updater
public InitialPositionArc()
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
[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 |
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 |
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 |