1. Epic GamesDeveloper
  3. FNiagaraSystemViewModel

FNiagaraSystemViewModel

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

Unreal Engine C++ API Reference > Plugins > NiagaraEditor > ViewModels

Inheritance Hierarchy

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

  Type Name Description
Public variable ENiagaraStatDisplayMode StatDisplayMode  
Public variable ENiagaraStatEvaluationType StatEvaluationType  

Constructors

  Type Name Description
Public function   Creates a new view model with the supplied System and System instance.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function TSharedPtr< FNiagaraEmitterHandleViewModel >

AddEmitter ( UNiagaraEmitter& Emitter,
FGuid EmitterVersion
)

 Adds a new emitter to the System.
Public function TSharedPtr< FNiagaraEmitterHandleViewModel > Adds a new emitter to the System.
Public function TSharedPtr< FNiagaraEmitterHandleViewModel >

AddEmitterFromAssetData ( const FAssetData& AssetData
)

 Adds a new emitter to the System from an emitter asset data.
Public function TSharedPtr< FNiagaraEmitterHandleViewModel > Adds an empty emitter to the system.
Public function Const FGuid Add a serialized message to the Emitter/System this viewmodel is managing.
Public function Const FGuid

AddStackMessage ( UNiagaraMessageData* NewMessage,
UNiagaraNodeFunctionCall* TargetFunctionCallNode
)

 Add a serialized message to the target function call node inside a script this viewmodel is managing.
Public function bool

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

 Changes the version of an existing emitter in the system
Public function void

Cleanup ()

 Act as if the system has been fully destroyed although references might persist.
Public function void Clear the captures stats for all the emitters in the current system.
Public function void

CompileSystem ( bool bForce
)

 Compiles the spawn and update scripts.
Public function void

DeleteEmitters ( TSet< FGuid > EmitterHandleIdsToDelete
)

 Deletes the emitters with the supplied ids from the system
Public function void

DisableEmitters ( TArray< FGuid > EmitterHandlesIdsToDisable
)

 Disable the supplied emitters.
Public function void  
Public function void

DismissMessageAndRefresh ( FNiagaraMessageSourceAndStore MessageSourceAndStore,
FGuid MessageKey
)

  
Public function void

DumpToText ( FString& ExportText
)

 Export the current state of the system to text.
Public function void

DuplicateEmitters ( TArray< FEmitterHandleToDuplicate > EmitterHandlesToDuplicate
)

 Duplicates a set of emitters and refreshes everything.
Public function void

FocusTab ( FName TabName,
bool bDrawAttention
)

  
Public function TArray< UNiagaraGraph * > Utility method to gather all graphs.
Public function Const bool Gets whether or not emitters can be added from the timeline.
Public function UNiagaraCurveSelectionViewModel *  
Public function Const FText  
Public function UNiagaraSystemEditorDocumentsViewModel *  
Public function Const ENiagaraSystemViewModelEditMode Gets the current editing mode for this system view model.
Public function Const UNiagaraSystemEditorData & Gets editor specific data which can be stored per system.
Public function Const UNiagaraEditorParametersAdapter * Helper to get the current System or Emitter's EditorParameters.
Public function TSharedPtr< FNiagaraEmitterHandleViewModel >

GetEmitterHandleViewModelById ( FGuid InEmitterHandleId
)

 Gets an emitter handle view model by ID. Returns an invalid shared ptr if it can't be found.
Public function Const TSharedPtr< FNiagaraEmitterHandleViewModel > Gets an emitter handle view model for the given emitter.
Public function Const const TArray< TSharedRef< FNiagaraEmitterHandleViewModel > > & Gets an array of the view models for the emitter handles owned by this System.
Public function TArray< FNiagaraGraphParameterReference > Utility method to gather graph parameter references
Public function bool Checks whether or not an emitter is pinned in the stack UI
Public function Const bool Gets whether or not this view model is for data processing only and will not be displayed in the UI.
Public function Const ENiagaraScriptCompileStatus Get the latest status of this view-model's script compilation.
Public function Const FGuid Get the Guid Key for messages associated with this asset.
Public function FOnPinnedEmittersChanged & Returns a multicast delegate that is broadcast when an emitter pinned state has changed
Public function void Gets all non-event scripts which will execute for an emitter.
Public function void

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

 Get all non-event scripts which will execute for an emitter.
Public function Const TSharedPtr< FNiagaraOverviewGraphViewModel > Gets the ViewModel for the system overview graph.
Public function Const INiagaraParameterPanelViewModel *  
Public function TArray< TSharedRef< FNiagaraEmitterHandleViewModel > > Keeps track of the emitters that are pinned in the stack UI, for persistence
Public function TSharedRef< FNiagaraPlaceholderDataInterfaceManager >  
Public function UNiagaraComponent * Gets a niagara component for previewing the simulated System.
Public function UNiagaraSystemScalabilityViewModel *  
Public function UNiagaraScratchPadViewModel *  
Public function TArray< UNiagaraGraph * > Utility method to gather all graphs marked as selected via the system selection viewmodel.
Public function UNiagaraSystemSelectionViewModel * Gets the a view model representing the selected entries in the overview.
Public function TSharedPtr< ISequencer > Gets the sequencer for this System for displaying the timeline.
Public function const TArray< FNiagaraStackModuleData > & Gets the stack module data for the provided emitter handled id, for use in determining dependencies.
Public function const TArray< FNiagaraStackModuleData > & Gets the stack module data for the provided module stack entry, for use in determining dependencies.
Public function Const UNiagaraSystem & Get access to the underlying system
Public function Const const TSharedPtr< FNiagaraSystemGraphSelectionViewModel > &  
Public function void  
Public function TSharedPtr< FNiagaraSystemScriptViewModel > Gets the view model for the System script.
Public function UNiagaraStackViewModel * Gets the stack view model representing this system.
Public function TSharedPtr< FUICommandList > Gets the system toolkit command list.
Public function Const TSharedPtr< FNiagaraUserParameterPanelViewModel >  
Public function UNiagaraUserParametersHierarchyViewModel *  
Public function Const FName Gets the current workflow mode for this system view model.
Public function void Initializes this system view model with the supplied system and options.
Public function void

IsolateEmitters ( TArray< FGuid > EmitterHandlesIdsToIsolate
)

 Isolates the supplied emitters. This will remove all other emitters from isolation.
Public function void  
Public function Const bool

IsValid ()

 Returns whether or not this view model is initialized and safe to use.
Public function 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.
Public function 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.
Public function void  
Public function void

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

  
Public function void  
Public function void  
Public function void  
Public function FOnChangeWorkflowMode & Gets the delegate that is bound to the owning toolkit's SetCurrentMode function.
Public function FOnEmitterHandleViewModelsChanged & Gets a multicast delegate which is called any time the array of emitter handle view models changes.
Public function Const TArray< float >  
Public function FOnGetWorkflowMode & Gets the delegate which is called any time the array of emitter handle view models changes.
Public function FOnExternalRemoveParameter &  
Public function FOnExternalRenameParameter &  
Public function FOnPostSequencerTimeChange & Gets a multicast delegate which is called whenever we've received and handled a sequencer time update.
Public function FOnPreClose &  
Public function FSimpleMulticastDelegate &  
Public function FOnRequestFocusTab &  
Public function FOnSystemCompiled & Gets a multicast delegate which is called whenever the system has been compiled.
Public function void Reinitializes all System instances, and rebuilds emitter handle view models and tracks.
Public function void  
Public function Const void

RemoveMessage ( const FGuid& MessageKey
)

 Remove a serialized message from the Emitter/System this viewmodel is managing.
Public function Const void

RemoveStackMessage ( const FGuid& MessageKey,
UNiagaraNodeFunctionCall* TargetFunctionCallNode
)

 Remove a serialized message from the target function call node inside a script this viewmodel is managing.
Public function 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.
Public function void Resets the System instance to initial conditions on the next tick.
Public function void  
Public function void Resets the System instance to initial conditions.
Public function void

ResetSystem ( ETimeResetMode TimeResetMode,
EMultiResetMode MultiResetMode,
EReinitMode ReinitMode
)

 Resets the system instance to initial conditions.
Public function void

SetEmitterPinnedState ( TSharedRef< FNiagaraEmitterHandleViewModel > EmitterHandleModel,
bool bPinnedState
)

 Sets an internal state when an emitter was pinned/unpinned in the stack UI
Public function void  
Public function void

SetToolkitCommands ( const TSharedRef< FUICommandList >& InToolkitCommands
)

 Set the system toolkit command list.
Public function void

SetWorkflowMode ( FName WorkflowMode
)

  
Public function void Toggles the isolation state of a single emitter.
Public function void This is specifically for UI with some unique behavior.
Public function void Updates all selected emitter's fixed bounds with their current dynamic bounds.
Public function void Updates the current system's fixed bounds with its current dynamic bounds.

Overridden from FGCObject

  Type Name Description
Public function Virtual void Pure virtual that must be overloaded by the inheriting class.
Public function Virtual Const FString Overload this method to report a name for your referencer

Overridden from FEditorUndoClient

  Type Name Description
Public function Virtual void

PostRedo ( bool bSuccess
)

 Signal that client should run any PostRedo code
Public function Virtual void

PostUndo ( bool bSuccess
)

 Signal that client should run any PostUndo code

Overridden from FTickableObjectBase

  Type Name Description
Public function Virtual Const TStatId Return the stat id to use for this tickable
Public function Virtual Const bool Virtual that can be overloaded by the inheriting class.
Public function Virtual void

Tick ( float DeltaTime
)

 ~ FTickableEditorObject

Overridden from INiagaraParameterDefinitionsSubscriberViewModel

  Type Name Description
Protected function Virtual INiagaraParameterDefinitionsSubscriber *  

Classes

  Type Name Description
Public struct FEmitterHandleToDuplicate    

Enums

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

Typedefs

Name Description
FOnChangeWorkflowMode  
FOnEmitterHandleViewModelsChanged  
FOnExternalRemoveParameter  
FOnExternalRenameParameter  
FOnPinnedEmittersChanged  
FOnPostSequencerTimeChange  
FOnPreClose  
FOnRequestFocusTab  
FOnSystemCompiled  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page