Class ParticleEmitterDescription

Class that represents the information of a particle system emitter.

Inheritance

object

ParticleEmitterDescription

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Evergine.Framework.Particles

Assembly: Evergine.Framework.dll

Syntax

public class ParticleEmitterDescription

Fields

ColorAnimated

Gets or sets a value indicating whether the particle color is animated during its lifetime.

Declaration

[RenderProperty(Tag = 7, CustomPropertyName = "Color Animated", Tooltip = "Indicating if a particle color will be changed during its life.")]
public bool ColorAnimated

Field Value

Type	Description
bool

ColorOverLife1

Gets or sets the 1st color of the color over life gradient.

Declaration

[RenderProperty(AttachToTag = 7, AttachToValue = true)]
public Color ColorOverLife1

Field Value

Type	Description
Color

ColorOverLife2

Gets or sets the 2nd color of the color over life gradient.

Declaration

[RenderProperty(AttachToTag = 7, AttachToValue = true)]
public Color ColorOverLife2

Field Value

Type	Description
Color

ColorOverLife2Position

Gets or sets the relative position on the lifetime of the 2nd step.

Declaration

[RenderPropertyAsFInput(0, 1, AsSlider = true, DesiredChange = 0.05, DesiredLargeChange = 0.2, AttachToValue = true, AttachToTag = 7)]
public float ColorOverLife2Position

Field Value

Type	Description
float

ColorOverLife3

Gets or sets the 3rd color of the color over life gradient.

Declaration

[RenderProperty(AttachToTag = 7, AttachToValue = true)]
public Color ColorOverLife3

Field Value

Type	Description
Color

ColorOverLife3Position

Gets or sets the relative position on the lifetime of the 3rd step.

Declaration

[RenderPropertyAsFInput(0, 1, AsSlider = true, DesiredChange = 0.05, DesiredLargeChange = 0.2, AttachToValue = true, AttachToTag = 7)]
public float ColorOverLife3Position

Field Value

Type	Description
float

ColorOverLife4

Gets or sets the 4th color of the color over life gradient.

Declaration

[RenderProperty(AttachToTag = 7, AttachToValue = true)]
public Color ColorOverLife4

Field Value

Type	Description
Color

Drag

Gets or sets the drag strength of the particle system.

Declaration

public float Drag

Field Value

Type	Description
float

ForcesCategory

Gets or sets a value indicating whether the particle forces are enabled for this system.

Declaration

[RenderProperty(AttachToTag = 10, AttachToValue = true)]
public CollisionCategory3D ForcesCategory

Field Value

Type	Description
CollisionCategory3D

ForcesEnabled

Gets or sets a value indicating whether the particle forces are enabled for this system.

Declaration

[RenderProperty(Tag = 10, CustomPropertyName = "Forces enabled", Tooltip = "Indicating whether a particle will be affected by external forces.")]
public bool ForcesEnabled

Field Value

Type	Description
bool

Gravity

Gets or sets the particle gravity.

Declaration

public float Gravity

Field Value

Type	Description
float

InitAngle

Gets or sets the init particle angle.

Declaration

public float InitAngle

Field Value

Type	Description
float

InitAngle2

Gets or sets the init particle angle.

Declaration

[RenderProperty(AttachToTag = 3, AttachToValue = ParameterMode.RandomBetweenTwoConstants)]
public float InitAngle2

Field Value

Type	Description
float

InitAngleMode

Gets or sets the init angle generation mode.

Declaration

[RenderProperty(Tag = 3, CustomPropertyName = "Init Angle mode", Tooltip = "Indicating which strategy will choose to set the initial angle of a particle.")]
public ParameterMode InitAngleMode

Field Value

Type	Description
ParameterMode

InitAngularSpeed

Gets or sets the particle initial angular speed.

Declaration

public float InitAngularSpeed

Field Value

Type	Description
float

InitAngularSpeed2

Gets or sets the particle initial angular speed.

Declaration

[RenderProperty(AttachToTag = 4, AttachToValue = ParameterMode.RandomBetweenTwoConstants)]
public float InitAngularSpeed2

Field Value

Type	Description
float

InitAngularSpeedMode

Gets or sets the init Angular Speed generation mode.

Declaration

[RenderProperty(Tag = 4, CustomPropertyName = "Init Angular Speed mode", Tooltip = "Indicating which strategy will choose to set the initial angular speed of a particle.")]
public ParameterMode InitAngularSpeedMode

Field Value

Type	Description
ParameterMode

InitColor

Gets or sets the init particle color.

Declaration

public Color InitColor

Field Value

Type	Description
Color

InitColor2

Gets or sets the init particle color.

Declaration

[RenderProperty(AttachToTag = 1, AttachToValue = ParameterMode.RandomBetweenTwoConstants)]
public Color InitColor2

Field Value

Type	Description
Color

InitColorMode

Gets or sets the init color generation mode.

Declaration

[RenderProperty(Tag = 1, CustomPropertyName = "Init Color mode", Tooltip = "Indicating which strategy will choose to set the initial color of a particle.")]
public ParameterMode InitColorMode

Field Value

Type	Description
ParameterMode

InitLife

Gets or sets the particle initial life.

Declaration

public float InitLife

Field Value

Type	Description
float

InitLife2

Gets or sets the particle initial life.

Declaration

[RenderProperty(AttachToTag = 5, AttachToValue = ParameterMode.RandomBetweenTwoConstants)]
public float InitLife2

Field Value

Type	Description
float

InitLifeMode

Gets or sets the init Life generation mode.

Declaration

[RenderProperty(Tag = 5, CustomPropertyName = "Init Life mode", Tooltip = "Indicating which strategy will choose to set the initial life of a particle.")]
public ParameterMode InitLifeMode

Field Value

Type	Description
ParameterMode

InitSize

Gets or sets the particle initial size.

Declaration

public float InitSize

Field Value

Type	Description
float

InitSize2

Gets or sets the particle initial size.

Declaration

[RenderProperty(AttachToTag = 6, AttachToValue = ParameterMode.RandomBetweenTwoConstants)]
public float InitSize2

Field Value

Type	Description
float

InitSizeMode

Gets or sets the init Size generation mode.

Declaration

[RenderProperty(Tag = 6, CustomPropertyName = "Init Size mode", Tooltip = "Indicating which strategy will choose to set the initial size of a particle.")]
public ParameterMode InitSizeMode

Field Value

Type	Description
ParameterMode

InitSpeed

Gets or sets the init particle speed.

Declaration

public float InitSpeed

Field Value

Type	Description
float

InitSpeed2

Gets or sets the init particle speed.

Declaration

[RenderProperty(AttachToTag = 2, AttachToValue = ParameterMode.RandomBetweenTwoConstants)]
public float InitSpeed2

Field Value

Type	Description
float

InitSpeedMode

Gets or sets the init speed generation mode.

Declaration

[RenderProperty(Tag = 2, CustomPropertyName = "Init Speed mode", Tooltip = "Indicating which strategy will choose to set the initial speed of a particle.")]
public ParameterMode InitSpeedMode

Field Value

Type	Description
ParameterMode

MaxParticles

Gets or sets the max amount of particles of the system.

Declaration

public uint MaxParticles

Field Value

Type	Description
uint

NoiseEnabled

Gets or sets a value indicating whether the particle noise field is enabled for this system.

Declaration

[RenderProperty(Tag = 9, CustomPropertyName = "Noise enabled")]
public bool NoiseEnabled

Field Value

Type	Description
bool

NoiseFrequency

Gets or sets the noise frequency.

Declaration

[RenderProperty(AttachToTag = 9, AttachToValue = true)]
public float NoiseFrequency

Field Value

Type	Description
float

NoiseSize

Gets or sets the noise size.

Declaration

[RenderProperty(AttachToTag = 9, AttachToValue = true)]
public float NoiseSize

Field Value

Type	Description
float

NoiseStrength

Gets or sets the noise strength.

Declaration

[RenderProperty(AttachToTag = 9, AttachToValue = true)]
public float NoiseStrength

Field Value

Type	Description
float

NoiseVelocity

Gets or sets the noise frequency.

Declaration

[RenderProperty(AttachToTag = 9, AttachToValue = true)]
public Vector3 NoiseVelocity

Field Value

Type	Description
Vector3

ParticleSampler

Gets or sets the particle texture sampler.

Declaration

public Guid ParticleSampler

Field Value

Type	Description
Guid

ParticleTexture

Gets or sets the particle texture.

Declaration

public Guid ParticleTexture

Field Value

Type	Description
Guid

PreserveHighlights

Gets or sets a value indicating whether the tint color doesn't affect the highlights.

Declaration

public bool PreserveHighlights

Field Value

Type	Description
bool

RandomPrecission

Gets or sets the random precission level of the particl system.

Declaration

public RandomPrecissionEnum RandomPrecission

Field Value

Type	Description
RandomPrecissionEnum

RenderLayer

Gets or sets the particles render layer.

Declaration

public Guid RenderLayer

Field Value

Type	Description
Guid

Shape

The emission shape.

Declaration

public ShapeDescription Shape

Field Value

Type	Description
ShapeDescription

SimulationSpace

Gets or sets the simulation space of the particle system.

Declaration

public SimulationSpaceMode SimulationSpace

Field Value

Type	Description
SimulationSpaceMode

SizeAnimated

Gets or sets a value indicating whether the particle size is animated during its lifetime.

Declaration

[RenderProperty(Tag = 8, CustomPropertyName = "Size Animated", Tooltip = "Indicating if a particle size will be changed during its life.")]
public bool SizeAnimated

Field Value

Type	Description
bool

SizeOverLife1

Gets or sets the 1st size of the size over life curve.

Declaration

[RenderProperty(AttachToTag = 8, AttachToValue = true)]
public float SizeOverLife1

Field Value

Type	Description
float

SizeOverLife2

Gets or sets the 2nd size of the size over life curve.

Declaration

[RenderProperty(AttachToTag = 8, AttachToValue = true)]
public float SizeOverLife2

Field Value

Type	Description
float

SizeOverLife2Position

Gets or sets the relative position on the lifetime of the 2nd step.

Declaration

[RenderPropertyAsFInput(0, 1, AsSlider = true, DesiredChange = 0.05, DesiredLargeChange = 0.2, AttachToValue = true, AttachToTag = 8)]
public float SizeOverLife2Position

Field Value

Type	Description
float

SizeOverLife3

Gets or sets the 3rd size of the size over life curve.

Declaration

[RenderProperty(AttachToTag = 8, AttachToValue = true)]
public float SizeOverLife3

Field Value

Type	Description
float

SizeOverLife3Position

Gets or sets the relative position on the lifetime of the 3rd step.

Declaration

[RenderPropertyAsFInput(0, 1, AsSlider = true, DesiredChange = 0.05, DesiredLargeChange = 0.2, AttachToValue = true, AttachToTag = 8)]
public float SizeOverLife3Position

Field Value

Type	Description
float

SizeOverLife4

Gets or sets the 4th size of the size over life curve.

Declaration

[RenderProperty(AttachToTag = 8, AttachToValue = true)]
public float SizeOverLife4

Field Value

Type	Description
float

Spawn

The spawn information.

Declaration

public SpawnDescription Spawn

Field Value

Type	Description
SpawnDescription

Extension Methods

ReflectionHelper.GetMemberAssembly(object)

ReflectionHelper.GetTypeName(object)