1. Epic GamesDeveloper
  3. FNiagaraSystemViewModel

FNiagaraSystemViewModel

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

API > API/Plugins > API/Plugins/NiagaraEditor

A view model for viewing and editing a UNiagaraSystem.

   
Name FNiagaraSystemViewModel
Type class
Header File /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/ViewModels/NiagaraSystemViewModel.h
Include Path #include "ViewModels/NiagaraSystemViewModel.h"

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FNiagaraSystemViewModel()

 Creates a new view model with the supplied System and System instance. ViewModels/NiagaraSystemViewModel.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FNiagaraSystemViewModel()

   ViewModels/NiagaraSystemViewModel.h  

Structs

Name Remarks
FEmitterHandleToDuplicate  

Enums

Public

Name Remarks
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 Type Remarks Include Path
FOnChangeWorkflowMode TBaseDelegate_OneParam< void, FName >   ViewModels/NiagaraSystemViewModel.h
FOnEmitterHandleViewModelsChanged TMulticastDelegate_NoParams< void >   ViewModels/NiagaraSystemViewModel.h
FOnEmitterThumbnailRequested TBaseDelegate_OneParam< void, FGuid EmitterGuid >   ViewModels/NiagaraSystemViewModel.h
FOnExternalRemoveParameter TMulticastDelegate_TwoParams< void, const FNiagaraVariableBase &, UNiagaraEmitter * >   ViewModels/NiagaraSystemViewModel.h
FOnExternalRenameParameter TMulticastDelegate_ThreeParams< void, const FNiagaraVariableBase &, const FNiagaraVariableBase &, UNiagaraEmitter * >   ViewModels/NiagaraSystemViewModel.h
FOnPinnedEmittersChanged TMulticastDelegate_NoParams< void >   ViewModels/NiagaraSystemViewModel.h
FOnPostSequencerTimeChange TMulticastDelegate_NoParams< void >   ViewModels/NiagaraSystemViewModel.h
FOnPreClose TMulticastDelegate_NoParams< void >   ViewModels/NiagaraSystemViewModel.h
FOnRequestFocusTab TMulticastDelegate_TwoParams< void, FName, bool >   ViewModels/NiagaraSystemViewModel.h
FOnSystemCompiled TMulticastDelegate_NoParams< void >   ViewModels/NiagaraSystemViewModel.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
StatDisplayMode ENiagaraStatDisplayMode   ViewModels/NiagaraSystemViewModel.h  
StatEvaluationType ENiagaraStatEvaluationType   ViewModels/NiagaraSystemViewModel.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bCanAutoCompile bool Whether or not the system represented by this view model can be automatically compiled. ViewModels/NiagaraSystemViewModel.h  
bCanModifyEmittersFromTimeline bool Whether or not the user can edit emitters from the timeline. ViewModels/NiagaraSystemViewModel.h  
bCanSimulate bool Whether or not the system represented by this view model can be simulated. ViewModels/NiagaraSystemViewModel.h  
bCompilePendingCompletion bool A flag which indicates that a compile has been requested, but has not completed. ViewModels/NiagaraSystemViewModel.h  
bForceAutoCompileOnce bool Whether or not the system requires a compilation ViewModels/NiagaraSystemViewModel.h  
bIsCompileForEdit bool What mode compile for edit is currently in. ViewModels/NiagaraSystemViewModel.h  
bIsForDataProcessingOnly bool Specifies that this view model is for data processing only and will not be displayed in the UI. ViewModels/NiagaraSystemViewModel.h  
bPendingAssetMessagesChanged bool Flag for when messages have been added/removed through the viewmodel to signal that the message manager needs to be refreshed. ViewModels/NiagaraSystemViewModel.h  
bPerformanceStatsEnabled bool If performance stats should be enable in the editor or not. ViewModels/NiagaraSystemViewModel.h  
bResetingSequencerTracks bool A flag for preventing selection changes when resetting the sequencer tracks due to the emitter handles array changing. ViewModels/NiagaraSystemViewModel.h  
bResetRequestPending bool A flag indicating that a reset has been request on the next tick ViewModels/NiagaraSystemViewModel.h  
bSettingSequencerTimeDirectly bool Flag which indicates we are setting the sequencer time directly in an internal operation. ViewModels/NiagaraSystemViewModel.h  
bSupportCompileForEdit bool Whether we should use the CompileForEdit mode for the assigned system. ViewModels/NiagaraSystemViewModel.h  
bUpdatingEmittersFromSequencerDataChange bool A flag for preventing reentrancy when syncrhonizing sequencer data. ViewModels/NiagaraSystemViewModel.h  
bUpdatingSequencerFromEmitterDataChange bool A flag for preventing reentrancy when syncrhonizing sequencer data. ViewModels/NiagaraSystemViewModel.h  
bUpdatingSequencerSelectionFromSystem bool A flag for preventing reentrancy when synchronizing sequencer selection with system selection ViewModels/NiagaraSystemViewModel.h  
bUpdatingSystemSelectionFromSequencer bool A flag for preventing reentrancy when synchronizing system selection with sequencer selection ViewModels/NiagaraSystemViewModel.h  
CachedEmitterIsolationState TArray< FGuid >   ViewModels/NiagaraSystemViewModel.h  
CurveSelectionViewModel TObjectPtr< UNiagaraCurveSelectionViewModel >   ViewModels/NiagaraSystemViewModel.h  
EditMode ENiagaraSystemViewModelEditMode The current editing mode for this view model. ViewModels/NiagaraSystemViewModel.h  
EditorDocumentsViewModel TObjectPtr< UNiagaraSystemEditorDocumentsViewModel >   ViewModels/NiagaraSystemViewModel.h  
EditorSettings UNiagaraEditorSettings * A cached reference to the niagara editor settings . ViewModels/NiagaraSystemViewModel.h  
EmitterHandleViewModels TArray< TSharedRef< FNiagaraEmitterHandleViewModel > > The view models for the emitter handles owned by the System. ViewModels/NiagaraSystemViewModel.h  
EmitterIdsRequiringSequencerTrackUpdate TArray< FGuid > An array of emitter handle ids which need their sequencer tracks refreshed next frame. ViewModels/NiagaraSystemViewModel.h  
GuidToCachedStackModuleData TMap< FGuid, TArray< FNiagaraStackModuleData > > The cache of stack module data for each emitter and for the system ViewModels/NiagaraSystemViewModel.h  
LatestCompileStatusCache TOptional< ENiagaraScriptCompileStatus >   ViewModels/NiagaraSystemViewModel.h  
MessageSourceObjectKeys TArray< FObjectKey > ObjectKeys for object viewed by this view model that supply messages. ViewModels/NiagaraSystemViewModel.h  
MovieSceneEventHandler UE::MovieScene::TNonIntrusiveEventHandler< UE::MovieScene::ISignedObjectEventHandler > Handles linking change events from the sequencer movie scene. ViewModels/NiagaraSystemViewModel.h  
NiagaraSequence TObjectPtr< UNiagaraSequence > A niagara sequence for displaying this System in the sequencer timeline. ViewModels/NiagaraSystemViewModel.h  
OnChangeWorkflowModeDelegate FOnChangeWorkflowMode A delegate that calls the toolkit's set current mode function ViewModels/NiagaraSystemViewModel.h  
OnEmitterHandleViewModelsChangedDelegate FOnEmitterHandleViewModelsChanged A multicast delegate which is called any time the array of emitter handle view models changes. ViewModels/NiagaraSystemViewModel.h  
OnEmitterThumbnailRequestedDelegate FOnEmitterThumbnailRequested A delegate that calls the toolkit's Create Thumbnail function ViewModels/NiagaraSystemViewModel.h  
OnExternalRemoveDelegate FOnExternalRemoveParameter   ViewModels/NiagaraSystemViewModel.h  
OnExternalRenameDelegate FOnExternalRenameParameter   ViewModels/NiagaraSystemViewModel.h  
OnGetSequencerAddMenuContent FOnGetAddMenuContent A delegate which is used to generate the content for the add menu in sequencer. ViewModels/NiagaraSystemViewModel.h  
OnGetWorkflowModeDelegate FOnGetWorkflowMode A delegate to retrieve the current workflow mode from the toolkit. ViewModels/NiagaraSystemViewModel.h  
OnPinnedChangedDelegate FOnPinnedEmittersChanged A single param delegate which is called when the pinned status is changed. ViewModels/NiagaraSystemViewModel.h  
OnPostSequencerTimeChangeDelegate FOnPostSequencerTimeChange A multicast delegate which is called whenever we've received and handled a sequencer time update. ViewModels/NiagaraSystemViewModel.h  
OnPreCloseDelegate FOnPreClose A multicast delegate which is called whenever this has been notified it's owner will be closing. ViewModels/NiagaraSystemViewModel.h  
OnPreSaveDelegate FSimpleMulticastDelegate A multicast delegate which is called before the asset is saved. ViewModels/NiagaraSystemViewModel.h  
OnRequestFocusTabDelegate FOnRequestFocusTab   ViewModels/NiagaraSystemViewModel.h  
OnScriptAppliedDelegateHandle FDelegateHandle   ViewModels/NiagaraSystemViewModel.h  
OnSystemCompiledDelegate FOnSystemCompiled A multicast delegate which is called whenever the system has been compiled. ViewModels/NiagaraSystemViewModel.h  
OverviewGraphViewModel TSharedPtr< FNiagaraOverviewGraphViewModel > ViewModel for the system overview graph ViewModels/NiagaraSystemViewModel.h  
ParameterPanelViewModel TWeakPtr< INiagaraParameterPanelViewModel >   ViewModels/NiagaraSystemViewModel.h  
PinnedEmitterHandles TArray< TSharedRef< FNiagaraEmitterHandleViewModel > > Array of FNiagaraEmitterHandleViewModel representing emitters that are pinned in the stack UI ViewModels/NiagaraSystemViewModel.h  
PlaceholderDataInterfaceManager TSharedPtr< FNiagaraPlaceholderDataInterfaceManager >   ViewModels/NiagaraSystemViewModel.h  
PreviewComponent TObjectPtr< UNiagaraComponent > The component used for previewing the System in a viewport. ViewModels/NiagaraSystemViewModel.h  
PreviewMovieViewModel TSharedPtr< FNiagaraPreviewMovieViewModel > The view model that owns and manages the singular movie player available to an asset. ViewModels/NiagaraSystemViewModel.h  
PreviousSequencerStatus EMovieScenePlayerStatus::Type The previous play status for sequencer timeline. ViewModels/NiagaraSystemViewModel.h  
PreviousSequencerTime float The previous time for the sequencer timeline. ViewModels/NiagaraSystemViewModel.h  
RegisteredHandle TNiagaraViewModelManager< UNiagaraSystem, FNiagaraSystemViewModel >::Handle   ViewModels/NiagaraSystemViewModel.h  
ScalabilityViewModel TObjectPtr< UNiagaraSystemScalabilityViewModel >   ViewModels/NiagaraSystemViewModel.h  
ScriptCompileStatuses TArray< ENiagaraScriptCompileStatus >   ViewModels/NiagaraSystemViewModel.h  
ScriptScratchPadViewModel TObjectPtr< UNiagaraScratchPadViewModel >   ViewModels/NiagaraSystemViewModel.h  
ScriptsToCheckForStatus TArray< UNiagaraScript * >   ViewModels/NiagaraSystemViewModel.h  
ScriptToOnParameterStoreChangedHandleMap TMap< FObjectKey, FDelegateHandle > A mapping of script to the delegate handle for it's on parameter map changed delegate. ViewModels/NiagaraSystemViewModel.h  
SelectionViewModel TObjectPtr< UNiagaraSystemSelectionViewModel >   ViewModels/NiagaraSystemViewModel.h  
Sequencer TSharedPtr< ISequencer > The sequencer instance viewing and editing the niagara sequence. ViewModels/NiagaraSystemViewModel.h  
System UNiagaraSystem * The System being viewed and edited by this view model. ViewModels/NiagaraSystemViewModel.h  
SystemChangedDelegateHandle FDelegateHandle   ViewModels/NiagaraSystemViewModel.h  
SystemGraphSelectionViewModel TSharedPtr< FNiagaraSystemGraphSelectionViewModel > ViewModel for caching the selected graph state and notifying when it changes. ViewModels/NiagaraSystemViewModel.h  
SystemInstance FNiagaraSystemInstance * The system instance currently simulating this system if available. ViewModels/NiagaraSystemViewModel.h  
SystemMessageLogGuidKey TOptional< const FGuid > GUID used when sending message jobs to FNiagaraMessageManager for notifying the FNiagaraMessageLogViewModel with the same GUID key ViewModels/NiagaraSystemViewModel.h  
SystemScriptGraphChangedHandle FDelegateHandle A handle to the on graph changed delegate for the system script. ViewModels/NiagaraSystemViewModel.h  
SystemScriptGraphNeedsRecompileHandle FDelegateHandle A handle to the on graph needs recompile delegate for the system script. ViewModels/NiagaraSystemViewModel.h  
SystemScriptViewModel TSharedPtr< FNiagaraSystemScriptViewModel > The view model for the System script. ViewModels/NiagaraSystemViewModel.h  
SystemStackViewModel TObjectPtr< UNiagaraStackViewModel >   ViewModels/NiagaraSystemViewModel.h  
ToolkitCommands TWeakPtr< class FUICommandList > The system toolkit commands. ViewModels/NiagaraSystemViewModel.h  
UserParameterPanelViewModel TSharedPtr< FNiagaraUserParameterPanelViewModel >   ViewModels/NiagaraSystemViewModel.h  
UserParametersHierarchyViewModel TObjectPtr< UNiagaraUserParametersHierarchyViewModel >   ViewModels/NiagaraSystemViewModel.h  
UserParameterStoreChangedHandle FDelegateHandle A handle to the on parameter changed delegate for the user parameter store. ViewModels/NiagaraSystemViewModel.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers
Adds a new emitter to the System. ViewModels/NiagaraSystemViewModel.h  
  ViewModels/NiagaraSystemViewModel.h  

TSharedPtr< FNiagaraEmitterHandleViewModel > AddEmitterFromAssetData ( const FAssetData& AssetData
)

 Adds a new emitter to the System from an emitter asset data. ViewModels/NiagaraSystemViewModel.h  
Adds a truly empty emitter to the system. ViewModels/NiagaraSystemViewModel.h  

FGuid AddMessage ( UNiagaraMessageData* NewMessage
) const

 Add a serialized message to the Emitter/System this viewmodel is managing. ViewModels/NiagaraSystemViewModel.h  
Adds the default empty emitter to the system, or a truly empty emitter as a fallback. ViewModels/NiagaraSystemViewModel.h  

FGuid AddStackMessage ( UNiagaraMessageData* NewMessage,
UNiagaraNodeFunctionCall* TargetFunctionCallNode
) const

 Add a serialized message to the target function call node inside a script this viewmodel is managing. ViewModels/NiagaraSystemViewModel.h  

TSharedPtr< FNiagaraEmitterHandleViewModel > AddStatelessEmitter()

 Adds a stateless emitter to the system. ViewModels/NiagaraSystemViewModel.h  

void CacheIsolatedEmitterState()

   ViewModels/NiagaraSystemViewModel.h  

bool ChangeEmitterVersion ( const FVersionedNiagaraEmitter& Emitter,
const FGuid& NewVersion
)

 Changes the version of an existing emitter in the system ViewModels/NiagaraSystemViewModel.h  

void Cleanup()

 Act as if the system has been fully destroyed although references might persist. ViewModels/NiagaraSystemViewModel.h  

void ClearEmitterStats()

 Clear the captures stats for all the emitters in the current system. ViewModels/NiagaraSystemViewModel.h  

void ClearSystemStats()

 Clear the captures stats for the current system. ViewModels/NiagaraSystemViewModel.h  

void CompileSystem ( bool bForce
)

 Compiles the spawn and update scripts. ViewModels/NiagaraSystemViewModel.h  

void DeleteEmitters ( TSet< FGuid > EmitterHandleIdsToDelete
)

 Deletes the emitters with the supplied ids from the system ViewModels/NiagaraSystemViewModel.h  

bool DeleteParameter ( const FNiagaraVariableBase Parameter
)

   ViewModels/NiagaraSystemViewModel.h  

void DisableEmitters ( TArray< FGuid > EmitterHandlesIdsToDisable
)

 Disable the supplied emitters. ViewModels/NiagaraSystemViewModel.h  

void DisableSelectedEmitters()

   ViewModels/NiagaraSystemViewModel.h  

void DismissMessageAndRefresh ( FNiagaraMessageSourceAndStore MessageSourceAndStore,
FGuid MessageKey
)

   ViewModels/NiagaraSystemViewModel.h  

void DumpToText ( FString& ExportText
)

 Export the current state of the system to text. ViewModels/NiagaraSystemViewModel.h  

void DuplicateEmitters ( TArray< FEmitterHandleToDuplicate > EmitterHandlesToDuplicate
)

 Duplicates a set of emitters and refreshes everything. ViewModels/NiagaraSystemViewModel.h  

void EnableEmitters ( TArray< FGuid > EmitterHandlesIdsToEnable
)

 Enable the supplied emitters. ViewModels/NiagaraSystemViewModel.h  

void EnableSelectedEmitters()

   ViewModels/NiagaraSystemViewModel.h  

void FocusTab ( FName TabName,
bool bDrawAttention
)

   ViewModels/NiagaraSystemViewModel.h  

TArray< UNiagaraGraph * > GetAllGraphs()

 Utility method to gather all graphs. ViewModels/NiagaraSystemViewModel.h  

bool GetCanModifyEmittersFromTimeline()

 Gets whether or not emitters can be added from the timeline. ViewModels/NiagaraSystemViewModel.h  

UNiagaraCurveSelectionViewModel * GetCurveSelectionViewModel()

   ViewModels/NiagaraSystemViewModel.h  

FText GetDisplayName()

   ViewModels/NiagaraSystemViewModel.h  

UNiagaraSystemEditorDocumentsViewModel * GetDocumentViewModel()

   ViewModels/NiagaraSystemViewModel.h  
Gets the current editing mode for this system view model. ViewModels/NiagaraSystemViewModel.h  
Gets editor specific data which can be stored per system. ViewModels/NiagaraSystemViewModel.h  

UNiagaraEditorParametersAdapter * GetEditorOnlyParametersAdapter()

 Helper to get the current System or Emitter's EditorParameters. ViewModels/NiagaraSystemViewModel.h  

TSharedPtr< FNiagaraEmitterHandleViewModel > GetEmitterHandleViewModelById ( FGuid InEmitterHandleId
)

 Gets an emitter handle view model by ID. Returns an invalid shared ptr if it can't be found. ViewModels/NiagaraSystemViewModel.h  
Gets an emitter handle view model for the given emitter. ViewModels/NiagaraSystemViewModel.h  

const TArray< TSharedRef< FNiagaraEmitterHandleViewModel > > & GetEmitterHandleViewModels()

 Gets an array of the view models for the emitter handles owned by this System. ViewModels/NiagaraSystemViewModel.h  

TArray< FNiagaraGraphParameterReference > GetGraphParameterReferences ( const FNiagaraVariable& Parameter,
ENiagaraGetGraphParameterReferencesMode Mode
)

 Utility method to gather graph parameter references ViewModels/NiagaraSystemViewModel.h  

bool GetIsEmitterPinned ( TSharedRef< FNiagaraEmitterHandleViewModel > EmitterHandleModel
)

 Checks whether or not an emitter is pinned in the stack UI ViewModels/NiagaraSystemViewModel.h  

bool GetIsForDataProcessingOnly()

 Gets whether or not this view model is for data processing only and will not be displayed in the UI. ViewModels/NiagaraSystemViewModel.h  

ENiagaraScriptCompileStatus GetLatestCompileStatus()

 Get the latest status of this view-model's script compilation. ViewModels/NiagaraSystemViewModel.h  

FGuid GetMessageLogGuid()

 Get the Guid Key for messages associated with this asset. ViewModels/NiagaraSystemViewModel.h  

FOnPinnedEmittersChanged & GetOnPinnedEmittersChanged()

 Returns a multicast delegate that is broadcast when an emitter pinned state has changed ViewModels/NiagaraSystemViewModel.h  

void GetOrderedScriptsForEmitter ( const FVersionedNiagaraEmitter& Emitter,
TArray< UNiagaraScript* >& OutScripts
)

 Gets all non-event scripts which will execute for an emitter. ViewModels/NiagaraSystemViewModel.h  

void GetOrderedScriptsForEmitterHandleId ( FGuid EmitterHandleId,
TArray< UNiagaraScript* >& OutScripts
)

 Get all non-event scripts which will execute for an emitter. ViewModels/NiagaraSystemViewModel.h  

TSharedPtr< FNiagaraOverviewGraphViewModel > GetOverviewGraphViewModel()

 Gets the ViewModel for the system overview graph. ViewModels/NiagaraSystemViewModel.h  

INiagaraParameterPanelViewModel * GetParameterPanelViewModel()

   ViewModels/NiagaraSystemViewModel.h  

ENiagaraPerformanceStateScopeMode GetPerformanceStateScopeMode()

 Returns what level of performance stats we have available in the editor. ViewModels/NiagaraSystemViewModel.h  

TArray< TSharedRef< FNiagaraEmitterHandleViewModel > > GetPinnedEmitterHandles()

 Keeps track of the emitters that are pinned in the stack UI, for persistence ViewModels/NiagaraSystemViewModel.h  

TSharedRef< FNiagaraPlaceholderDataInterfaceManager > GetPlaceholderDataInterfaceManager()

   ViewModels/NiagaraSystemViewModel.h  

UNiagaraComponent * GetPreviewComponent()

 Gets a niagara component for previewing the simulated System. ViewModels/NiagaraSystemViewModel.h  

TSharedPtr< FNiagaraPreviewMovieViewModel > GetPreviewMovieViewModel()

   ViewModels/NiagaraSystemViewModel.h  

UNiagaraSystemScalabilityViewModel * GetScalabilityViewModel()

   ViewModels/NiagaraSystemViewModel.h  

UNiagaraScratchPadViewModel * GetScriptScratchPadViewModel()

   ViewModels/NiagaraSystemViewModel.h  

TArray< UNiagaraGraph * > GetSelectedGraphs()

 Utility method to gather all graphs marked as selected via the system selection viewmodel. ViewModels/NiagaraSystemViewModel.h  

UNiagaraSystemSelectionViewModel * GetSelectionViewModel()

 Gets the a view model representing the selected entries in the overview. ViewModels/NiagaraSystemViewModel.h  

TSharedPtr< ISequencer > GetSequencer()

 Gets the sequencer for this System for displaying the timeline. ViewModels/NiagaraSystemViewModel.h  

const TArray< FNiagaraStackModuleData > & GetStackModuleDataByEmitterHandleId ( FGuid EmitterHandleId
)

 Gets the stack module data for the provided emitter handled id, for use in determining dependencies. ViewModels/NiagaraSystemViewModel.h  

const TArray< FNiagaraStackModuleData > & GetStackModuleDataByModuleEntry ( UNiagaraStackEntry* ModuleEntry
)

 Gets the stack module data for the provided module stack entry, for use in determining dependencies. ViewModels/NiagaraSystemViewModel.h  

UNiagaraSystem & GetSystem()

 Get access to the underlying system ViewModels/NiagaraSystemViewModel.h  

const TSharedPtr< FNiagaraSystemGraphSelectionViewModel > & GetSystemGraphSelectionViewModel()

   ViewModels/NiagaraSystemViewModel.h  

void GetSystemMessageStores ( TArray< FNiagaraMessageSourceAndStore >& OutMessageStores
)

   ViewModels/NiagaraSystemViewModel.h  

TSharedPtr< FNiagaraSystemScriptViewModel > GetSystemScriptViewModel()

 Gets the view model for the System script. ViewModels/NiagaraSystemViewModel.h  

UNiagaraStackViewModel * GetSystemStackViewModel()

 Gets the stack view model representing this system. ViewModels/NiagaraSystemViewModel.h  

TSharedPtr< FUICommandList > GetToolkitCommands()

 Gets the system toolkit command list. ViewModels/NiagaraSystemViewModel.h  

TSharedPtr< FNiagaraUserParameterPanelViewModel > GetUserParameterPanelViewModel()

   ViewModels/NiagaraSystemViewModel.h  

UNiagaraUserParametersHierarchyViewModel * GetUserParametersHierarchyViewModel()

   ViewModels/NiagaraSystemViewModel.h  

FName GetWorkflowMode()

 Gets the current workflow mode for this system view model. ViewModels/NiagaraSystemViewModel.h  

void Initialize ( UNiagaraSystem& InSystem,
FNiagaraSystemViewModelOptions InOptions
)

 Initializes this system view model with the supplied system and options. ViewModels/NiagaraSystemViewModel.h  

bool IsCompileForEdit()

 Are we running in compile for edit mode or not. ViewModels/NiagaraSystemViewModel.h  

void IsolateEmitters ( TArray< FGuid > EmitterHandlesIdsToIsolate
)

 Isolates the supplied emitters. This will remove all other emitters from isolation. ViewModels/NiagaraSystemViewModel.h  

void IsolateSelectedEmitters()

   ViewModels/NiagaraSystemViewModel.h  

bool IsPerformanceStatsEnabled()

 Are the performance stats enabled? ViewModels/NiagaraSystemViewModel.h  

bool IsValid()

 Returns whether or not this view model is initialized and safe to use. ViewModels/NiagaraSystemViewModel.h  

void NotifyDataObjectChanged ( TArray< UObject* > ChangedObjects,
ENiagaraDataObjectChange ChangeType
)

 Called to notify the system view model that one of the data objects in the system was modified. ViewModels/NiagaraSystemViewModel.h  

void NotifyObjectAssetChanged ( UNiagaraNode& OwningNode,
FName VariableReadName,
UObject* NewValue
)

 Called to notify the system view model that one of the object references in the system was modified. ViewModels/NiagaraSystemViewModel.h  

void NotifyParameterRemovedExternally ( const FNiagaraVariableBase& InVar,
UNiagaraEmitter* InOptionalEmitter
)

   ViewModels/NiagaraSystemViewModel.h  

void NotifyParameterRenamedExternally ( const FNiagaraVariableBase& InOldVar,
const FNiagaraVariableBase& InNewVar,
UNiagaraEmitter* InOptionalEmitter
)

   ViewModels/NiagaraSystemViewModel.h  

void NotifyPostSave()

   ViewModels/NiagaraSystemViewModel.h  

void NotifyPreClose()

   ViewModels/NiagaraSystemViewModel.h  

void NotifyPreSave()

   ViewModels/NiagaraSystemViewModel.h  

FOnChangeWorkflowMode & OnChangeWorkflowMode()

 Gets the delegate that is bound to the owning toolkit's SetCurrentMode function. ViewModels/NiagaraSystemViewModel.h  

FOnEmitterHandleViewModelsChanged & OnEmitterHandleViewModelsChanged()

 Gets a multicast delegate which is called any time the array of emitter handle view models changes. ViewModels/NiagaraSystemViewModel.h  

FOnEmitterThumbnailRequested & OnEmitterThumbnailRequested()

 Gets the delegate that is bound to the owning toolkit's CreateThumbnail function. ViewModels/NiagaraSystemViewModel.h  

TArray< float > OnGetPlaybackSpeeds()

   ViewModels/NiagaraSystemViewModel.h  

FOnGetWorkflowMode & OnGetWorkflowMode()

 Gets the delegate which is called any time the array of emitter handle view models changes. ViewModels/NiagaraSystemViewModel.h  

FOnExternalRemoveParameter & OnParameterRemovedExternally()

   ViewModels/NiagaraSystemViewModel.h  

FOnExternalRenameParameter & OnParameterRenamedExternally()

   ViewModels/NiagaraSystemViewModel.h  

FOnPostSequencerTimeChange & OnPostSequencerTimeChanged()

 Gets a multicast delegate which is called whenever we've received and handled a sequencer time update. ViewModels/NiagaraSystemViewModel.h  

FOnPreClose & OnPreClose()

   ViewModels/NiagaraSystemViewModel.h  

FSimpleMulticastDelegate & OnPreSave()

   ViewModels/NiagaraSystemViewModel.h  

FOnRequestFocusTab & OnRequestFocusTab()

   ViewModels/NiagaraSystemViewModel.h  

FOnSystemCompiled & OnSystemCompiled()

 Gets a multicast delegate which is called whenever the system has been compiled. ViewModels/NiagaraSystemViewModel.h  

void RefreshAll()

 Reinitializes all System instances, and rebuilds emitter handle view models and tracks. ViewModels/NiagaraSystemViewModel.h  

void RefreshAssetMessagesDeferred()

   ViewModels/NiagaraSystemViewModel.h  

void RemoveMessage ( const FGuid& MessageKey
) const

 Remove a serialized message from the Emitter/System this viewmodel is managing. ViewModels/NiagaraSystemViewModel.h  

void RemoveStackMessage ( const FGuid& MessageKey,
UNiagaraNodeFunctionCall* TargetFunctionCallNode
) const

 Remove a serialized message from the target function call node inside a script this viewmodel is managing. ViewModels/NiagaraSystemViewModel.h  

bool RenameParameter ( const FNiagaraVariable TargetParameter,
const FName NewName,
ENiagaraGetGraphParameterReferencesMode RenameScopeMode
)

 Rename a parameter within the RenameScope and update associated tracking metadata such as Parameter Definition synchronization. ViewModels/NiagaraSystemViewModel.h  
Resets the System instance to initial conditions on the next tick. ViewModels/NiagaraSystemViewModel.h  

void ResetStack()

   ViewModels/NiagaraSystemViewModel.h  

void ResetSystem ()

 Resets the System instance to initial conditions. ViewModels/NiagaraSystemViewModel.h  

void ResetSystem ( ETimeResetMode TimeResetMode,
EMultiResetMode MultiResetMode,
EReinitMode ReinitMode
)

 Resets the system instance to initial conditions. ViewModels/NiagaraSystemViewModel.h  

void RestoreIsolatedEmitterState()

   ViewModels/NiagaraSystemViewModel.h  

void SetCompileForEdit ( bool bNewState
)

 Update the compile for edit mode. ViewModels/NiagaraSystemViewModel.h  

void SetEmitterPinnedState ( TSharedRef< FNiagaraEmitterHandleViewModel > EmitterHandleModel,
bool bPinnedState
)

 Sets an internal state when an emitter was pinned/unpinned in the stack UI ViewModels/NiagaraSystemViewModel.h  

void SetParameterPanelViewModel ( TSharedPtr< INiagaraParameterPanelViewModel > InVM
)

   ViewModels/NiagaraSystemViewModel.h  

void SetPerformanceStatsEnabled ( bool bEnabled
)

 Set if performance stats should be enabled or not ViewModels/NiagaraSystemViewModel.h  

void SetSystenIsolationEnabled ( bool bIsolationEnabled
)

   ViewModels/NiagaraSystemViewModel.h  

void SetToolkitCommands ( const TSharedRef< FUICommandList >& InToolkitCommands
)

 Set the system toolkit command list. ViewModels/NiagaraSystemViewModel.h  

void SetWorkflowMode ( FName WorkflowMode
)

   ViewModels/NiagaraSystemViewModel.h  

void ToggleEmitterIsolation ( TSharedRef< FNiagaraEmitterHandleViewModel > InEmitterHandle
)

 Toggles the isolation state of a single emitter. ViewModels/NiagaraSystemViewModel.h  
This is specifically for UI with some unique behavior. ViewModels/NiagaraSystemViewModel.h  

void UpdateEmitterFixedBounds()

 Updates all selected emitter's fixed bounds with their current dynamic bounds. ViewModels/NiagaraSystemViewModel.h  

void UpdateSystemFixedBounds()

 Updates the current system's fixed bounds with its current dynamic bounds. ViewModels/NiagaraSystemViewModel.h  

Overridden from FGCObject

Name Remarks Include Path Unreal Specifiers

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

   ViewModels/NiagaraSystemViewModel.h  

virtual FString GetReferencerName()

   ViewModels/NiagaraSystemViewModel.h  

Overridden from FEditorUndoClient

Name Remarks Include Path Unreal Specifiers

virtual void PostRedo ( bool bSuccess
)

   ViewModels/NiagaraSystemViewModel.h  

virtual void PostUndo ( bool bSuccess
)

   ViewModels/NiagaraSystemViewModel.h  

Overridden from FTickableObjectBase

Name Remarks Include Path Unreal Specifiers

virtual TStatId GetStatId()

   ViewModels/NiagaraSystemViewModel.h  

virtual bool IsTickable()

   ViewModels/NiagaraSystemViewModel.h  

virtual void Tick ( float DeltaTime
)

 ~ FTickableEditorObject ViewModels/NiagaraSystemViewModel.h  

Overridden from ISignedObjectEventHandler

Name Remarks Include Path Unreal Specifiers

virtual void OnModifiedDirectly ( UMovieSceneSignedObject* MovieSceneSignedObject
)

   ViewModels/NiagaraSystemViewModel.h  

virtual void OnModifiedIndirectly ( UMovieSceneSignedObject* MovieSceneSignedObject
)

   ViewModels/NiagaraSystemViewModel.h  

Protected

Overridden from INiagaraParameterDefinitionsSubscriberViewModel

Name Remarks Include Path Unreal Specifiers

virtual INiagaraParameterDefinitionsSubscriber * GetParameterDefinitionsSubscriber()

   ViewModels/NiagaraSystemViewModel.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page