FNiagaraSystemInstanceController | Unreal Engine 5.5 Documentation

Inheritance Hierarchy

TSharedFromThis
FGCObject
FNiagaraSystemInstanceController

References


Module	Niagara
Header	/Engine/Plugins/FX/Niagara/Source/Niagara/Public/NiagaraSystemInstanceController.h
Include	#include "NiagaraSystemInstanceController.h"

Syntax

class FNiagaraSystemInstanceController :  
    public TSharedFromThis< FNiagaraSystemInstanceController, ESPMode::ThreadSafe > ,  
    private FGCObject

Remarks

This is the main asynchronous interface for controlling operation of a single instance of a Niagara System.

Constructors

	Type	Name	Description
		FNiagaraSystemInstanceController ()
		FNiagaraSystemInstanceController ( const FNiagaraSystemInstanceController& )

Destructors

	Type	Name	Description
		~FNiagaraSystemInstanceController ()

Functions

Type	Name	Description
auto	Activate ( ArgTypes... Args )
auto	AdvanceSimulation ( ArgTypes... Args )
void	AdvanceSimulation_Deferred ( ArgTypes... Args )
auto	CalculateTickGroup ( ArgTypes... Args )
auto	ClearLODDistance ( ArgTypes... Args )
void	CollectPSOPrecacheData ( const FPSOPrecacheParams& BasePrecachePSOParams, FMaterialInterfacePSOPrecacheParamsList& List )
FNiagaraSystemRenderData *	CreateSystemRenderData ( ERHIFeatureLevel::Type FeatureLevel )	Render data operations.
auto	Deactivate ( ArgTypes... Args )
void	DebugDump ( bool bFullDump )	Dumps system instance state and info to the log (Used by fx.Niagara.DumpComponents commandlet)
void	GenerateSetDynamicDataCommands ( FNiagaraSystemRenderData::FSetDynamicDataCommandList& Commands, FNiagaraSystemRenderData& RenderData, const FNiagaraSceneProxy& SceneProxy )
auto	GetActualExecutionState ( ArgTypes... Args )
auto	GetAge ( ArgTypes... Args )
auto	GetAreDataInterfacesInitialized ( ArgTypes... Args )
auto	GetAttachComponent ( ArgTypes... Args )
auto	GetComputeDispatchInterface ( ArgTypes... Args )
auto	GetEmitterFixedBounds ( ArgTypes... Args )
ENiagaraGpuComputeTickStage::Type	GetGpuComputeTickStage ()
auto	GetLocalBounds ( ArgTypes... Args )
auto	GetLODDistance ( ArgTypes... Args )
UMaterialInterface *	GetMaterialOverride ( const UNiagaraRendererProperties* InProps, int32 InMaterialSubIndex )
void	GetMaterialStreamingInfo ( FNiagaraMaterialAndScaleArray& OutMaterialAndScales )
auto	GetRequestedExecutionState ( ArgTypes... Args )
FNiagaraSystemInstance *	GetSoloSystemInstance ()	Solo systems should be okay to access the system instance/simulation, as they are ticked manually, not concurrently.
FNiagaraSystemSimulationPtr	GetSoloSystemSimulation ()
void	GetStreamingMeshInfo ( const FBoxSphereBounds& OwnerBounds, FStreamingTextureLevelContext& LevelContext, TArray< FStreamingRenderAssetPrimitiveInfo >& OutStreamingRenderAssets )
auto	GetSystem ( ArgTypes... Args )	The goal is to get this list of methods down to only accessors that don't change throughout the lifetime of the system.
auto	GetSystemFixedBounds ( ArgTypes... Args )
FNiagaraSystemInstance *	GetSystemInstance_Unsafe ()	These methods are deprecated, as they expose internals that may be concurrently accessed.
FNiagaraSystemInstanceID	GetSystemInstanceID ()
FNiagaraSystemSimulationPtr	GetSystemSimulation_Unsafe ()
auto	GetTickBehavior ( ArgTypes... Args )
SIZE_T	GetTotalBytesUsed ()
void	GetUsedMaterials ( TArray< UMaterialInterface* >& OutMaterials )
auto	HandleNeedsUIResync ( ArgTypes... Args )
bool	HasValidSimulation ()
void	Initialize ( UWorld& World, UNiagaraSystem& System, FNiagaraUserRedirectionParameterStore* OverrideParameters, USceneComponent* AttachComponent, ENiagaraTickBehavior TickBehavior, bool bPooled, int32 RandomSeedOffset, bool bForceSolo, int32 WarmupTickCount, float WarmupTickDelta )	Initializes the controller with an instance of the provided system
auto	IsComplete ( ArgTypes... Args )
auto	IsPaused ( ArgTypes... Args )
auto	IsPendingSpawn ( ArgTypes... Args )
auto	IsSolo ( ArgTypes... Args )
bool	IsValid ()
auto	ManualTick ( ArgTypes... Args )
void	NotifyRenderersComplete ( FNiagaraSystemRenderData& RenderData )
void	OnPooledReuse ( UWorld& NewWorld )
auto	OnSimulationDestroyed ( ArgTypes... Args )
void	PostTickRenderers ( FNiagaraSystemRenderData& RenderData )
void	Release ()	Deactivates the underlying system and queues it up for destruction.
auto	Reset ( ArgTypes... Args )
void	Reset_Deferred ( ArgTypes... Args )	Deferred methods - With NIAGARA_SYSTEM_INSTANCE_CONTROLLER_ASYNC, these are executed in a deferred queue.
auto	SetEmitterEnable ( ArgTypes... Args )
auto	SetEmitterFixedBounds ( ArgTypes... Args )
auto	SetForceSolo ( ArgTypes... Args )
auto	SetGpuComputeDebug ( ArgTypes... Args )
auto	SetLastRenderTime ( ArgTypes... Args )
auto	SetLODDistance ( ArgTypes... Args )
auto	SetOnComplete ( ArgTypes... Args )
void	SetOnMaterialsUpdated ( const FOnMaterialsUpdated& Delegate )
auto	SetOnPostTick ( ArgTypes... Args )
auto	SetPaused ( ArgTypes... Args )
void	SetPaused_Deferred ( ArgTypes... Args )
auto	SetRandomSeedOffset ( ArgTypes... Args )
void	SetRequestedExecutionState_Deferred ( ArgTypes... Args )
auto	SetSystemFixedBounds ( ArgTypes... Args )
auto	SetSystemSignificanceIndex ( ArgTypes... Args )
auto	SetTickBehavior ( ArgTypes... Args )
void	SetVariable_Deferred ( ArgTypes... Args )
auto	SimCacheTick_GameThread ( ArgTypes... Args )
auto	WaitForConcurrentTickAndFinalize ( ArgTypes... Args )

Typedefs

Name	Description
FMaterialOverride
FOnMaterialsUpdated

Navigation

Inheritance Hierarchy

References

Syntax

Remarks

Constructors

Destructors

Functions

Typedefs