1. Epic GamesDeveloper
  3. FNiagaraScriptViewModel

FNiagaraScriptViewModel

A view model for Niagara scripts which manages other script related view models.

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

Inheritance Hierarchy

References

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

Syntax

class FNiagaraScriptViewModel :  
    public TSharedFromThis< FNiagaraScriptViewModel >,  
    public FEditorUndoClient,  
    public TNiagaraViewModelManager< UNiagaraScript, FNiagaraScriptViewModel >,  
    public INiagaraParameterDefinitionsSubscriberViewModel

Remarks

A view model for Niagara scripts which manages other script related view models.

Variables

  Type Name Description
Protected variable bool bIsForDataProcessingOnly Whether or not this view model is going to be used for data processing only and will not be shown in the UI.
Protected variable bool bUpdatingSelectionInternally A flag for preventing reentrancy when synchronizing selection.
Protected variable TArray< FString > CompileErrors  
Protected variable TArray< FString > CompilePaths  
Protected variable TArray< ENiagaraScriptCompileStatus > CompileStatuses  
Protected variable TArray< TPair< ENiagaraScriptUsage, FGuid > > CompileTypes  
Protected variable TSharedRef< FNiagaraScriptGraphViewModel > GraphViewModel The view model for the graph.
Protected variable TSharedRef< FNiagaraScriptInputCollectionViewModel > InputCollectionViewModel The view model for the input parameter collection.
Protected variable ENiagaraScriptCompileStatus LastCompileStatus The stored latest compile status.
Protected variable FDelegateHandle OnGraphChangedHandle The handle to the graph changed delegate needed for removing.
Protected variable TSharedRef< FNiagaraScriptOutputCollectionViewModel > OutputCollectionViewModel The view model for the output parameter collection .
Protected variable TArray< TNiagaraViewModelManager< UNiagaraScript, FNiagaraScriptViewModel >::Handle > RegisteredHandles  
Protected variable TArray< FVersionedNiagaraScriptWeakPtr > Scripts The script which provides the data for this view model.
Protected variable TWeakObjectPtr< UNiagaraScriptSource > Source  
Protected variable TSharedRef< FNiagaraObjectSelection > VariableSelection The set of variables currently selected in the graph or the parameters panel.

Constructors

  Type Name Description
Public function  

FNiagaraScriptViewModel ( TAttribute< FText > DisplayName,
ENiagaraParameterEditMode InParameterEditMode,
bool bInIsForDataProcessingOnly
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

CompileStandaloneScript ( bool bForceCompile
)

 Compiles a script that isn't part of an emitter or System.
Public function UNiagaraScript *  
Public function Const FText  
Public function TSharedRef< FNiagaraScriptGraphViewModel > Gets the view model for the graph.
Public function TSharedRef< FNiagaraScriptInputCollectionViewModel > Gets the view model for the input parameter collection.
Public function Virtual ENiagaraScriptCompileStatus

GetLatestCompileStatus ( FGuid VersionGuid
)

 Get the latest status of this view-model's script compilation.
Public function TSharedRef< FNiagaraScriptOutputCollectionViewModel > Gets the view model for the output parameter collection.
Public function UNiagaraScript *

GetScript ( ENiagaraScriptUsage InUsage,
FGuid InUsageId
)

 Implements a globally unique identifier.
Public function Const ENiagaraScriptCompileStatus  
Public function Const FText

GetScriptErrors ( ENiagaraScriptUsage InUsage,
FGuid InUsageId
)

  
Public function Const const TArray< FVersionedNiagaraScriptWeakPtr > &  
Public function Virtual FVersionedNiagaraScript If this is editing a standalone script, returns the script being edited.
Public function TSharedRef< FNiagaraObjectSelection > Gets the currently selected script variables.
Protected function Const bool

IsGraphDirty ( FGuid VersionGuid
)

  
Protected function Virtual void

OnGPUScriptCompiled ( UNiagaraScript* InScript,
const FGuid& ScriptVersion
)

  
Protected function Virtual void

OnVMScriptCompiled ( UNiagaraScript* InScript,
const FGuid& ScriptVersion
)

  
Public function void Refreshes the nodes in the script graph, updating the pins to match external changes.
Public function bool

RenameParameter ( const FNiagaraVariable TargetParameter,
const FName NewName
)

  
Public function void Sets the view model to a different script.
Public function void  
Public function void

UpdateCompileStatus ( ENiagaraScriptCompileStatus InAggregateCompileStatus,
const FString& InAggregateCompileErrors,
const TArray< ENiagaraScriptCompileStatus >& InCompileStatuses,
const TArray< FString >& InCompileErrors,
const TArray< FString >& InCompilePaths,
const TArray< UNiagaraScript* >& InCompileSources
)

 Updates the script with the latest compile status.

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 INiagaraParameterDefinitionsSubscriberViewModel

  Type Name Description
Protected function Virtual INiagaraParameterDefinitionsSubscriber *  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page