Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > NiagaraEditor > ViewModels > FNiagaraSystemViewModel

Light Theme

Dark Theme

FNiagaraSystemViewModel

A view model for viewing and editing a [UNiagaraSystem](API\Plugins\Niagara\UNiagaraSystem).

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

TSharedFromThis

FGCObject

FEditorUndoClient

FTickableEditorObject

TNiagaraViewModelManager

INiagaraParameterDefinitionsSubscriberViewModel

FNiagaraSystemViewModel

References

Module	NiagaraEditor
Header	/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/ViewModels/NiagaraSystemViewModel.h
Include	#include "ViewModels/NiagaraSystemViewModel.h"

Syntax

class FNiagaraSystemViewModel :
    public TSharedFromThis< FNiagaraSystemViewModel >,
    public FGCObject,
    public FEditorUndoClient,
    public FTickableEditorObject,
    public TNiagaraViewModelManager< UNiagaraSystem, FNiagaraSystemViewModel >,
    public INiagaraParameterDefinitionsSubscriberViewModel

Remarks

A view model for viewing and editing a UNiagaraSystem.

Variables

		Name	Description
	ENiagaraStatDis...	StatDisplayMode
	ENiagaraStatEva...	StatEvaluationType

Constructors

	Name	Description
	FNiagaraSystemViewModel()	Creates a new view model with the supplied System and System instance.

Destructors

	Name	Description
	~FNiagaraSystemViewModel()

Functions

	Name	Description
TSharedPtr< ...	AddEmitter ( UNiagaraEmitter& Emitter )	Adds a new emitter to the System.
TSharedPtr< ...	AddEmitterFromAssetData ( const FAssetData& AssetData )	Adds a new emitter to the System from an emitter asset data.
FGuid	AddMessage ( UNiagaraMessageData* NewMessag... )	Add a serialized message to the Emitter/System this viewmodel is managing.
FGuid	AddStackMessage ( UNiagaraMessageData* NewMessag..., UNiagaraNodeFunctionCall* Targ... )	Add a serialized message to the target function call node inside a script this viewmodel is managing.
void	Cleanup()	Act as if the system has been fully destroyed although references might persist.
void	ClearEmitterStats()	Clear the captures stats for all the emitters in the current system.
void	CompileSystem ( bool bForce )	Compiles the spawn and update scripts.
void	DeleteEmitters ( TSet< FGuid > EmitterHandleIdsToDel... )	Deletes the emitters with the supplied ids from the system
void	DisableEmitters ( TArray< FGuid > EmitterHandlesIdsTo... )	Disable the supplied emitters.
void	DisableSelectedEmitters()
void	DumpToText ( FString& ExportText )	Export the current state of the system to text.
void	DuplicateEmitters ( TArray< FEmitterHandleToDuplicate >... )	Duplicates a set of emitters and refreshes everything.
void	ExecuteMessageDelegateAndRefreshMessages ( FSimpleDelegate MessageDelegate )	Wrapper to set bPendingMessagesChanged after calling a delegate off of a message link.
void	FocusTab ( FName TabName )
bool	GetCanModifyEmittersFromTimeline()	Gets whether or not emitters can be added from the timeline.
UNiagaraCurv...	GetCurveSelectionViewModel()
FText	GetDisplayName()
ENiagaraSyst...	GetEditMode()	Gets the current editing mode for this system view model.
UNiagaraSyst...	GetEditorData()	Gets editor specific data which can be stored per system.
UNiagaraEdit...	GetEditorOnlyParametersAdapter()	Helper to get the current System or Emitter's EditorParameters.
TSharedPtr< ...	GetEmitterHandleViewModelById ( FGuid InEmitterHandleId )	Gets an emitter handle view model by ID. Returns an invalid shared ptr if it can't be found.
TSharedPtr< ...	GetEmitterHandleViewModelForEmitter ( UNiagaraEmitter* InEmitter )	Gets an emitter handle view model for the given emitter.
const TArray...	GetEmitterHandleViewModels()	Gets an array of the view models for the emitter handles owned by this System.
bool	GetIsEmitterPinned ( TSharedRef< FNiagaraEmitterHandleVi... )	Checks whether or not an emitter is pinned in the stack UI
bool	GetIsForDataProcessingOnly()	Gets whether or not this view model is for data processing only and will not be displayed in the UI.
ENiagaraScri...	GetLatestCompileStatus()	Get the latest status of this view-model's script compilation.
FGuid	GetMessageLogGuid()	Get the Guid Key for messages associated with this asset.
FOnPinnedEmi...	GetOnPinnedEmittersChanged()	Returns a multicast delegate that is broadcast when an emitter pinned state has changed
void	GetOrderedScriptsForEmitter ( UNiagaraEmitter* Emitter, TArray< UNiagaraScript* >& Ou... )	Gets all non-event scripts which will execute for an emitter.
void	GetOrderedScriptsForEmitterHandleId ( FGuid EmitterHandleId, TArray< UNiagaraScript* >& Ou... )	Get all non-event scripts which will execute for an emitter.
TSharedPtr< ...	GetOverviewGraphViewModel()	Gets the ViewModel for the system overview graph.
TArray< TSha...	GetPinnedEmitterHandles()	Keeps track of the emitters that are pinned in the stack UI, for persistence
TSharedRef< ...	GetPlaceholderDataInterfaceManager()
UNiagaraComp...	GetPreviewComponent()	Gets a niagara component for previewing the simulated System.
UNiagaraScra...	GetScriptScratchPadViewModel()
UNiagaraSyst...	GetSelectionViewModel()	Gets the a view model representing the selected entries in the overview.
TSharedPtr< ...	GetSequencer()	Gets the sequencer for this System for displaying the timeline.
const TArray...	GetStackModuleDataByEmitterHandleId ( FGuid EmitterHandleId )	Gets the stack module data for the provided emitter handled id, for use in determining dependencies.
const TArray...	GetStackModuleDataByModuleEntry ( UNiagaraStackEntry* ModuleEntr... )	Gets the stack module data for the provided module stack entry, for use in determining dependencies.
UNiagaraSyst...	GetSystem()	Get access to the underlying system
TSharedPtr< ...	GetSystemScriptViewModel()	Gets the view model for the System script.
UNiagaraStac...	GetSystemStackViewModel()	Gets the stack view model representing this system.
TSharedPtr< ...	GetToolkitCommands()	Gets the system toolkit command list.
void	Initialize ( UNiagaraSystem& InSystem, FNiagaraSystemViewModelOptions InOp... )	Initializes this system view model with the supplied system and options.
void	IsolateEmitters ( TArray< FGuid > EmitterHandlesIdsTo... )	Isolates the supplied emitters. This will remove all other emitters from isolation.
void	IsolateSelectedEmitters()
bool	IsValid()	Returns whether or not this view model is initialized and safe to use.
void	NotifyDataObjectChanged ( TArray< UObject* > ChangedObje..., ENiagaraDataObjectChange ChangeType )	Called to notify the system view model that one of the data objects in the system was modified.
void	NotifyParameterRemovedExternally ( const FNiagaraVariableBase& InVar, UNiagaraEmitter* InOptionalEmi... )
void	NotifyParameterRenamedExternally ( const FNiagaraVariableBase& InOldV..., const FNiagaraVariableBase& InNewV..., UNiagaraEmitter* InOptionalEmi... )
void	NotifyPreClose()
void	NotifyPreSave()
FOnEmitterHa...	OnEmitterHandleViewModelsChanged()	Gets a multicast delegate which is called any time the array of emitter handle view models changes.
TArray< floa...	OnGetPlaybackSpeeds()
FOnExternalR...	OnParameterRemovedExternally()
FOnExternalR...	OnParameterRenamedExternally()
FOnPostSeque...	OnPostSequencerTimeChanged()	Gets a multicast delegate which is called whenever we've received and handled a sequencer time update.
FOnPreClose ...	OnPreClose()
FOnRequestFo...	OnRequestFocusTab()
FOnSystemCom...	OnSystemCompiled()	Gets a multicast delegate which is called whenever the system has been compiled.
void	RefreshAll()	Reinitializes all System instances, and rebuilds emitter handle view models and tracks.
void	RemoveMessage ( const FGuid& MessageKey )	Remove a serialized message from the Emitter/System this viewmodel is managing.
void	RemoveStackMessage ( const FGuid& MessageKey, UNiagaraNodeFunctionCall* Targ... )	Remove a serialized message from the target function call node inside a script this viewmodel is managing.
void	RequestResetSystem()	Resets the System instance to initial conditions on the next tick.
void	ResetSystem()	Resets the System instance to initial conditions.
void	ResetSystem ( ETimeResetMode TimeResetMode, EMultiResetMode MultiResetMode, EReinitMode ReinitMode )	Resets the system instance to initial conditions.
void	SetEmitterPinnedState ( TSharedRef< FNiagaraEmitterHandleVi..., bool bPinnedState )	Sets an internal state when an emitter was pinned/unpinned in the stack UI
void	SetToolkitCommands ( const TSharedRef< FUICommandList > ... )	Set the system toolkit command list.
void	ToggleEmitterIsolation ( TSharedRef< FNiagaraEmitterHandleVi... )	Toggles the isolation state of a single emitter.
void	UpdateEmitterFixedBounds()	Updates all selected emitter's fixed bounds with their current dynamic bounds.
void	UpdateSystemFixedBounds()	Updates the current system's fixed bounds with its current dynamic bounds.

Overridden from FGCObject

		Name	Description
	void	AddReferencedObjects ( FReferenceCollector& Collector )	Pure virtual that must be overloaded by the inheriting class.
	FString	GetReferencerName()	Use this method to report a name for your referencer.

Overridden from FEditorUndoClient

		Name	Description
	void	PostRedo ( bool bSuccess )	Signal that client should run any PostRedo code
	void	PostUndo ( bool bSuccess )	Signal that client should run any PostUndo code

Overridden from FTickableObjectBase

	Name	Description
TStatId	GetStatId()	Return the stat id to use for this tickable
bool	IsTickable()	Virtual that can be overloaded by the inheriting class.
void	Tick ( float DeltaTime )	~ FTickableEditorObject

Overridden from INiagaraParameterDefinitionsSubscriberViewModel

		Name	Description
	INiagaraPara...	GetParameterDefinitionsSubscriber()

Classes

	Name	Description
	FEmitterHandleToDuplicate

Enums

	Name	Description
	EMultiResetMode	Defines different multi-system reset modes for this system view model
	EReinitMode	Defines different initialization modes when resetting for this system view model
	ETimeResetMode	Defines different time reset modes for this system view model

Typedefs

Name	Description
FOnEmitterHandleViewModelsChanged
FOnExternalRemoveParameter
FOnExternalRenameParameter
FOnPinnedEmittersChanged
FOnPostSequencerTimeChange
FOnPreClose
FOnRequestFocusTab
FOnSystemCompiled