1. Epic GamesDeveloper
  3. FNiagaraEmitterInstance

FNiagaraEmitterInstance

A Niagara particle simulation.

Unreal Engine C++ API Reference > Plugins > Niagara

References

   
Module Niagara
Header /Engine/Plugins/FX/Niagara/Source/Niagara/Classes/NiagaraEmitterInstance.h
Include #include "NiagaraEmitterInstance.h"

Syntax

class FNiagaraEmitterInstance

Remarks

A Niagara particle simulation.

Constructors

  Type Name Description
Public function  

FNiagaraEmitterInstance ( FNiagaraSystemInstance* InParentSystemInstance
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const bool  
Public function void

BindParameters ( bool bExternalOnly
)

 Void RebindParameterCollection(UNiagaraParameterCollectionInstance* OldInstance, UNiagaraParameterCollectionInstance* NewInstance);
Public function uint32

CalculateEventSpawnCount ( const FNiagaraEventScriptProperties& EventHandlerProps,
TArray< int32, TInlineAllocator< 16 >>& EventSpawnCounts,
FNiagaraDataSet* EventSet
)

 Calculate total number of spawned particles from events; these all come from event handler script with the SpawnedParticles execution mode We get the counts ahead of event processing time so we only have to allocate new particles once TODO: augment for multiple spawning event scripts
Public function void

CalculateFixedBounds ( const FTransform& ToWorldSpace
)

 Potentially reads back data from the GPU which will introduce a stall and should only be used for debug purposes.
Public function void  
Public function Const void

Dump ()

  
Public function Const UObject *

FindBinding ( const FNiagaraVariable& InVariable
)

  
Public function Const UNiagaraDataInterface *

FindDataInterface ( const FNiagaraVariable& InVariable
)

  
Public function Const bool

GetBoundRendererValue_GT ( const FNiagaraVariableBase& InBaseVar,
const FNiagaraVariableBase& InSubVar,
void* OutValueData
)

  
Public function Const FBox  
Public function Const FVersionedNiagaraEmitter  
Public function Const FVersionedNiagaraEmitterData *  
Public function Const FName  
Public function Const FNiagaraDataSet &

GetData ()

  
Public function Const const FNiagaraEmitterHandle &  
Public function TArrayView< FNiagaraScriptExecutionContext >  
Public function ENiagaraExecutionState  
Public function Const FBox  
Public function Const FNiagaraComputeExecutionContext *  
Public function Const int32  
Public function Const int32  
Public function Const FNiagaraSystemInstance *  
Public function Const int32  
Public function Const const FNiagaraParameterStore &  
Public function FNiagaraParameterStore &  
Public function Const const FNiagaraEmitterScalabilitySettings &  
Public function FNiagaraScriptExecutionContext &  
Public function TArray< FNiagaraSpawnInfo > &  
Public function int64  
Public function float  
Public function Const int32  
Public function FNiagaraScriptExecutionContext &  
Public function bool

HandleCompletion ( bool bForce
)

  
Public function Const bool  
Public function void

Init ( int32 InEmitterIdx,
FNiagaraSystemInstanceID SystemInstanceID
)

  
Public function void  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool

IsParticleComponentActive ( FObjectKey ComponentKey,
int32 ParticleID
)

  
Public function Const bool  
Public function void  
Public function void Do any post work such as calculating dynamic bounds.
Public function void

PreTick ()

 PreTick - handles killing dead particles, emitter death, and buffer swaps
Public function Const bool  
Public function void

ResetSimulation ( bool bKillExisting
)

  
Public function void  
Public function void

SetFixedBounds ( const FBox& InLocalBounds
)

  
Public function Const void

SetParticleComponentActive ( FObjectKey ComponentKey,
int32 ParticleID
)

  
Public function void

SetSystemFixedBoundsOverride ( FBox SystemFixedBounds
)

  
Public function Const bool  
Public function void

Tick ( float DeltaSeconds
)

 PreTick - handles killing dead particles, emitter death, and buffer swaps
Public function void  
Public function void

UnbindParameters ( bool bExternalOnly
)

  
Public function bool  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page