Navigation
Unreal Engine C++ API Reference > Plugins > NiagaraEditor > ViewModels
Inheritance Hierarchy
- TSharedFromThis
- FEditorUndoClient
- TNiagaraViewModelManager
- INiagaraParameterDefinitionsSubscriberViewModel
- FNiagaraScriptViewModel
- FNiagaraScratchPadScriptViewModel
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 | |
---|---|---|---|
![]() |
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. |
![]() |
bool | bUpdatingSelectionInternally | A flag for preventing reentrancy when synchronizing selection. |
![]() |
TArray< FString > | CompileErrors | |
![]() |
TArray< FString > | CompilePaths | |
![]() |
TArray< ENiagaraScriptCompileStatus > | CompileStatuses | |
![]() |
TArray< TPair< ENiagaraScriptUsage, FGuid > > | CompileTypes | |
![]() |
TSharedRef< FNiagaraScriptGraphViewModel > | GraphViewModel | The view model for the graph. |
![]() |
TSharedRef< FNiagaraScriptInputCollectionViewModel > | InputCollectionViewModel | The view model for the input parameter collection. |
![]() |
ENiagaraScriptCompileStatus | LastCompileStatus | The stored latest compile status. |
![]() |
FDelegateHandle | OnGraphChangedHandle | The handle to the graph changed delegate needed for removing. |
![]() |
TSharedRef< FNiagaraScriptOutputCollectionViewModel > | OutputCollectionViewModel | The view model for the output parameter collection . |
![]() |
TArray< TNiagaraViewModelManager< UNiagaraScript, FNiagaraScriptViewModel >::Handle > | RegisteredHandles | |
![]() |
TArray< FVersionedNiagaraScriptWeakPtr > | Scripts | The script which provides the data for this view model. |
![]() |
TWeakObjectPtr< UNiagaraScriptSource > | Source | |
![]() |
TSharedRef< FNiagaraObjectSelection > | VariableSelection | The set of variables currently selected in the graph or the parameters panel. |
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
FNiagaraScriptViewModel
(
TAttribute< FText > DisplayName, |
Destructors
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
Functions
Type | Name | Description | |
---|---|---|---|
![]() |
void | CompileStandaloneScript
(
bool bForceCompile |
Compiles a script that isn't part of an emitter or System. |
![]() |
UNiagaraScript * | GetContainerScript
(
ENiagaraScriptUsage InUsage, |
|
![]() ![]() |
FText | ||
![]() |
TSharedRef< FNiagaraScriptGraphViewModel > | Gets the view model for the graph. | |
![]() |
TSharedRef< FNiagaraScriptInputCollectionViewModel > | Gets the view model for the input parameter collection. | |
![]() ![]() |
ENiagaraScriptCompileStatus | GetLatestCompileStatus
(
FGuid VersionGuid |
Get the latest status of this view-model's script compilation. |
![]() |
TSharedRef< FNiagaraScriptOutputCollectionViewModel > | Gets the view model for the output parameter collection. | |
![]() |
UNiagaraScript * | GetScript
(
ENiagaraScriptUsage InUsage, |
Implements a globally unique identifier. |
![]() ![]() |
ENiagaraScriptCompileStatus | GetScriptCompileStatus
(
ENiagaraScriptUsage InUsage, |
|
![]() ![]() |
FText | GetScriptErrors
(
ENiagaraScriptUsage InUsage, |
|
![]() ![]() |
const TArray< FVersionedNiagaraScriptWeakPtr > & | GetScripts () |
|
![]() ![]() |
FVersionedNiagaraScript | If this is editing a standalone script, returns the script being edited. | |
![]() |
TSharedRef< FNiagaraObjectSelection > | Gets the currently selected script variables. | |
![]() ![]() |
bool | IsGraphDirty
(
FGuid VersionGuid |
|
![]() ![]() |
void | OnGPUScriptCompiled
(
UNiagaraScript* InScript, |
|
![]() ![]() |
void | OnVMScriptCompiled
(
UNiagaraScript* InScript, |
|
![]() |
void | RefreshNodes () |
Refreshes the nodes in the script graph, updating the pins to match external changes. |
![]() |
bool | RenameParameter
(
const FNiagaraVariable TargetParameter, |
|
![]() |
void | SetScript
(
FVersionedNiagaraScript InScript |
Sets the view model to a different script. |
![]() |
void | SetScripts
(
FVersionedNiagaraEmitter InEmitter |
|
![]() |
void | UpdateCompileStatus
(
ENiagaraScriptCompileStatus InAggregateCompileStatus, |
Updates the script with the latest compile status. |
Overridden from FEditorUndoClient
Type | 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 INiagaraParameterDefinitionsSubscriberViewModel
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
INiagaraParameterDefinitionsSubscriber * |