| TSharedFromThis | ||
| FGCObject
|
Module |
|
Header |
/Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraSystemSimulation.h |
Include |
#include "NiagaraSystemSimulation.h" |
class FNiagaraSystemSimulation :
public TSharedFromThis< FNiagaraSystemSimulation, ESPMode::ThreadSafe >,
private FGCObject
Simulation performing all system and emitter scripts for a instances of a UNiagaraSystem in a world.
Name | Description | ||
---|---|---|---|
|
AllWorkCompleteGraphEvent |
Event to track all work is complete, i.e. System Concurrent, Instance Concurrent, Finalize |
|
|
Batcher |
||
|
uint32: 1 |
bBindingsInitialized |
|
|
uint32: 1 |
bCanExecute |
|
|
uint32: 1 |
bInSpawnPhase |
|
|
uint32: 1 |
bIsSolo |
|
|
ConcurrentTickGraphEvent |
Event to track the system simulation async tick is complete. |
|
|
CrashReporterTag |
||
|
DataSetToEmitterEventParameters |
Binding to push system attributes into each emitter event parameters. |
|
|
DataSetToEmitterGPUParameters |
Binding to push system attributes into each emitter gpu parameters. |
|
|
DataSetToEmitterRendererParameters |
Binding to push system attributes into each emitter renderer parameters. |
|
|
DataSetToEmitterSpawnParameters |
Binding to push system attributes into each emitter spawn parameters. |
|
|
DataSetToEmitterUpdateParameters |
Binding to push system attributes into each emitter update parameters. |
|
|
EffectType |
We cache off the effect type in the unlikely even that someone GCs the System from under us so that we can keep the effect types instance count etc accurate. |
|
|
MainDataSet |
Data set for the Running instance state. |
|
|
TOptional< floa... |
MaxDeltaTime |
|
|
PausedDataSet |
Data set for the Paused instance state. |
|
|
PendingTickGroupPromotions |
List of instances that are pending a tick group promotion. |
|
|
ScriptDefinedDataInterfaceParameters |
A parameter store which contains the data interfaces parameters which were defined by the scripts. |
|
|
TUniquePtr< FNi... |
SpawnExecContext |
|
|
SpawnGlobalSpawnCountScaleParam |
||
|
SpawnGlobalSystemCountScaleParam |
||
|
SpawningDataSet |
Data set for the Spawning instance state. |
|
|
SpawnInstanceParameterDataSet |
As there's a 1 to 1 relationship between system instance and their execution in this simulation we must pull all that instances parameters into a dataset for simulation. |
|
|
SpawnInstanceParameterToDataSetBinding |
Bindings that pull per component parameters into the spawn parameter dataset. |
|
|
SpawnNumSystemInstancesParam |
Direct bindings for Engine variables in System Spawn and Update scripts. |
|
|
SystemInstancesPerState |
System instance per state. |
|
|
SystemTickGroup |
Which tick group we are in, only valid when not in Solo mode. |
|
|
TickBatch |
Current tick batch we're filling ready for processing, potentially in an async task. |
|
|
TUniquePtr< FNi... |
UpdateExecContext |
|
|
UpdateGlobalSpawnCountScaleParam |
||
|
UpdateGlobalSystemCountScaleParam |
||
|
UpdateInstanceParameterDataSet |
||
|
UpdateInstanceParameterToDataSetBinding |
Bindings that pull per component parameters into the update parameter dataset. |
|
|
UpdateNumSystemInstancesParam |
||
|
TWeakObjectPtr<... |
WeakSystem |
System of instances being simulated. |
|
UWorld * |
World |
World this system simulation belongs to. |
Name | Description | |
---|---|---|
|
FNiagaraSystemSimulation() |
Name | Description | |
---|---|---|
|
~FNiagaraSystemSimulation() |
Name | Description | ||
---|---|---|---|
|
AddInstance ( |
||
|
AddSystemToTickBatch ( |
||
|
AddTickGroupPromotion ( |
||
|
AddToInstanceList ( |
||
|
BuildConstantBufferTable ( |
Builds the constant buffer table for a given script execution |
|
|
Destroy() |
||
|
DumpInstance ( |
||
|
DumpTickInfo ( |
Dump information about all instances tick |
|
|
FlushTickBatch |
||
|
NiagaraEmitt... |
GetBatcher() |
|
|
const FStrin... |
GetCrashReporterTag() |
|
|
ENiagaraGPUT... |
GetGPUTickHandlingMode() |
|
|
GetIsSolo() |
||
|
UNiagaraPara... |
GetParameterCollectionInstance ( |
|
|
FNiagaraPara... |
GetScriptDefinedDataInterfaceParameters() |
|
|
FNiagaraScri... |
GetSpawnExecutionContext() |
|
|
UNiagaraSyst... |
GetSystem() |
|
|
GetSystemInstances ( |
||
|
ETickingGrou... |
GetTickGroup() |
|
|
FNiagaraScri... |
GetUpdateExecutionContext() |
|
|
UWorld * |
GetWorld() |
|
|
Init ( |
||
|
InitParameterDataSetBindings ( |
||
|
IsValid() |
||
|
OnChanged_UseLegacySystemSimulationContexts ( |
If true we use legacy simulation contexts that could not handle per instance DI calls in the system scripts and would force the whole simulation solo. |
|
|
PauseInstance ( |
||
|
PrepareForSystemSimulate |
Does any prep work for system simulation such as pulling instance parameters into a dataset. |
|
|
RemoveFromInstanceList ( |
||
|
RemoveInstance ( |
||
|
SetInstanceState ( |
||
|
SetupParameters_GameThread ( |
Sets constant parameter values |
|
|
Spawn_Concurrent |
Spawn any pending instances |
|
|
Spawn_GameThread ( |
Spawn any pending instances, assumes that you have update tick groups ahead of time. |
|
|
SpawnSystemInstances |
Runs the system spawn script for new system instances. |
|
|
Tick_Concurrent |
Second phase of system sim tick that can run on any thread. |
|
|
Tick_GameThread ( |
First phase of system sim tick. Must run on GameThread. |
|
|
TransferInstance ( |
Transfers a system instance from the current simulation into this one. |
|
|
TransferSystemSimResults |
Transfers the results of the system simulation into the emitter instances. |
|
|
UnpauseInstance ( |
||
|
UpdateSystemInstances |
Runs the system update script. |
|
|
UpdateTickGroups_GameThread() |
Update TickGroups for pending instances and execute tick group promotions. |
|
|
UseLegacySystemSimulationContexts() |
If true we use legacy simulation contexts that could not handle per instance DI calls in the system scripts and would force the whole simulation solo. |
|
|
WaitForConcurrentTickComplete ( |
Promote instances that have ticked during Wait for system simulation concurrent tick to complete. |
|
|
WaitForInstancesTickComplete ( |
Wait for system instances concurrent tick to complete. |
Name | Description | ||
---|---|---|---|
|
AddReferencedObjects ( |
Pure virtual that must be overloaded by the inheriting class. |
Name |
Description |
---|---|
bUseLegacyExecContexts |