Class ParticleEmitterInstance

The particle emitter simulation graph instance data storage. Required to update the particles.

ParticleEmitterInstance
Assembly: FlaxEngine.dll
File: Engine/Particles/ParticlesSimulation.h
Syntax
public class ParticleEmitterInstance

Constructors

~ParticleEmitterInstance()

Finalizes an instance of the ParticleEmitterInstance class.

Declaration
public ~ParticleEmitterInstance()

ParticleEmitterInstance()

Initializes a new instance of the ParticleEmitterInstance class.

Declaration
public ParticleEmitterInstance()

Fields

Buffer

The buffer for the particles simulation.

Declaration
public ParticleBuffer* Buffer = nullptr
Field Value
ParticleBuffer

CustomData

Custom per-node data (eg. position on spiral module for arc progress tracking)

Declaration
public Array<byte> CustomData
Field Value
Array<byte>

CustomSpawnCount

The external amount of the particles to spawn.

Declaration
public int32 CustomSpawnCount = 0
Field Value
int32

DeltaTime

The accumulated delta time for the GPU simulation update.

Declaration
public float DeltaTime
Field Value
float

GPU

Declaration
public struct ParticleEmitterInstance::@182 GPU
Field Value
struct ParticleEmitterInstance::@182

Parameters

The graph parameters collection (instanced, override the default values).

Declaration
public Array<Variant> Parameters
Field Value
Array<Variant>

SpawnCount

The accumulated amount of the particles to spawn.

Declaration
public int32 SpawnCount
Field Value
int32

SpawnModulesData

The particles spawning modules data (one instance per module).

Declaration
public Array<SpawnerData> SpawnModulesData
Field Value
Array<SpawnerData>

Time

The total simulation time.

Declaration
public float Time
Field Value
float

Version

The instance data version number. Used to sync the Particle Emitter Graph data with the instance state. Handles Particle Emitter reloads to enure data is valid.

Declaration
public uint32 Version = 0
Field Value
uint32

Methods

ClearState()

Clears this container state data.

Declaration
public void ClearState()

Sync(ParticleSystemInstance& systemInstance, ParticleSystem* system, int32 emitterIndex)

Synchronizes the instance data with the specified emitter from the given system.

Declaration
public void Sync(ParticleSystemInstance& systemInstance, ParticleSystem* system, int32 emitterIndex)
Parameters
ParticleSystemInstance systemInstance

The system instance data.
ParticleSystem system

The system.
int32 emitterIndex

The emitter index (in the particle system).