Class ParticleEmitterGraph

The Particle Emitter Graph used to simulate particles.

Inheritance

BaseType

ParticleEmitterGraph

Inherited Members

ParticleEmitterGraph

ParticleEmitterGraph

Assembly: FlaxEngine.dll

File: Engine/Particles/Graph/ParticleEmitterGraph.h

Syntax

public class ParticleEmitterGraph<BaseType, NodeType, ValueType>

Type Parameters

BaseType

NodeType

ValueType

Fields

_attrAge

Declaration

protected int32 _attrAge

Field Value

int32

_attrAngularVelocity

Declaration

protected int32 _attrAngularVelocity

Field Value

int32

_attrColor

Declaration

protected int32 _attrColor

Field Value

int32

_attrLifetime

Declaration

protected int32 _attrLifetime

Field Value

int32

_attrMass

Declaration

protected int32 _attrMass

Field Value

int32

_attrPosition

Declaration

protected int32 _attrPosition

Field Value

int32

_attrRadius

Declaration

protected int32 _attrRadius

Field Value

int32

_attrRibbonWidth

Declaration

protected int32 _attrRibbonWidth

Field Value

int32

_attrRotation

Declaration

protected int32 _attrRotation

Field Value

int32

_attrScale

Declaration

protected int32 _attrScale

Field Value

int32

_attrSpriteSize

Declaration

protected int32 _attrSpriteSize

Field Value

int32

_attrVelocity

Declaration

protected int32 _attrVelocity

Field Value

int32

AttributesDefaults

The particle layout attributes default values.

Declaration

public Array<Variant, FixedAllocation<PARTICLE_ATTRIBUTES_MAX_COUNT>> AttributesDefaults

Field Value

Array<Variant, FixedAllocation<PARTICLE_ATTRIBUTES_MAX_COUNT>>

Capacity

The particle emitter capacity (max particles limit for the simulation).

Declaration

public int32 Capacity

Field Value

int32

InitModules

The particles modules for Initialize context.

Declaration

public Array<NodeType* , FixedAllocation<PARTICLE_EMITTER_MAX_MODULES>> InitModules

Field Value

Array<NodeType , FixedAllocation<PARTICLE_EMITTER_MAX_MODULES>>

Layout

The particle layout.

Declaration

public ParticleLayout Layout

Field Value

ParticleLayout

LightModules

The particles modules for lights rendering.

Declaration

public Array<NodeType* , FixedAllocation<PARTICLE_EMITTER_MAX_MODULES>> LightModules

Field Value

Array<NodeType , FixedAllocation<PARTICLE_EMITTER_MAX_MODULES>>

RenderModules

The particles modules for Render context.

Declaration

public Array<NodeType* , FixedAllocation<PARTICLE_EMITTER_MAX_MODULES>> RenderModules

Field Value

Array<NodeType , FixedAllocation<PARTICLE_EMITTER_MAX_MODULES>>

RibbonRenderingModules

The particles modules for ribbon particles rendering.

Declaration

public Array<NodeType* , FixedAllocation<PARTICLE_EMITTER_MAX_MODULES>> RibbonRenderingModules

Field Value

Array<NodeType , FixedAllocation<PARTICLE_EMITTER_MAX_MODULES>>

Root

The cached root node.

Declaration

public NodeType* Root = nullptr

Field Value

NodeType

SimulationSpace

The particles simulation space.

Declaration

public ParticlesSimulationSpace SimulationSpace

Field Value

ParticlesSimulationSpace

SortModules

The particles modules for sorting particles.

Declaration

public Array<NodeType* , FixedAllocation<PARTICLE_EMITTER_MAX_MODULES>> SortModules

Field Value

Array<NodeType , FixedAllocation<PARTICLE_EMITTER_MAX_MODULES>>

SpawnModules

The particles modules for Spawn context.

Declaration

public Array<NodeType* , FixedAllocation<PARTICLE_EMITTER_MAX_MODULES>> SpawnModules

Field Value

Array<NodeType , FixedAllocation<PARTICLE_EMITTER_MAX_MODULES>>

UpdateModules

The particles modules for Update context.

Declaration

public Array<NodeType* , FixedAllocation<PARTICLE_EMITTER_MAX_MODULES>> UpdateModules

Field Value

Array<NodeType , FixedAllocation<PARTICLE_EMITTER_MAX_MODULES>>

UsesVolumetricFogRendering

Declaration

public bool UsesVolumetricFogRendering = false

Field Value

bool

Version

The Particle Emitter Graph data version number. Used to sync the Particle Emitter Graph data with the instances state. Handles graph reloads to ensure data is valid.

Declaration

public uint32 Version = 0

Field Value

uint32

Methods

Clear()

Declaration

public void Clear() override

InitializeNode(NodeType* node)

Declaration

public virtual void InitializeNode(NodeType* node)

Parameters

NodeType node

Load(ReadStream* stream, bool loadMeta)

Declaration

public bool Load(ReadStream* stream, bool loadMeta) override

Parameters

ReadStream stream

bool loadMeta

Returns

bool

onNodeLoaded(NodeType* n)

Declaration

public bool onNodeLoaded(NodeType* n) override

Parameters

NodeType n

Returns

bool