1. Epic GamesDeveloper
  3. FNiagaraEmitterHandleViewModel

FNiagaraEmitterHandleViewModel

The view model for the FNiagaraEmitterEditorWidget.

API > API/Plugins > API/Plugins/NiagaraEditor

The view model for the FNiagaraEmitterEditorWidget.

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

Syntax

class FNiagaraEmitterHandleViewModel :  
    public TSharedFromThis< FNiagaraEmitterHandleViewModel > ,  
    public FGCObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FNiagaraEmitterHandleViewModel ( bool bInIsForDataProcessingOnly
)

 Creates a new emitter editor view model. This must be initialized before it can be used. ViewModels/NiagaraEmitterHandleViewModel.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FNiagaraEmitterHandleViewModel()

   ViewModels/NiagaraEmitterHandleViewModel.h  

Typedefs

Name Type Remarks Include Path
FOnNameChanged TMulticastDelegate_NoParams< void >   ViewModels/NiagaraEmitterHandleViewModel.h
FOnPropertyChanged TMulticastDelegate_NoParams< void >   ViewModels/NiagaraEmitterHandleViewModel.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsRenamePending bool Gets whether or not this emitter has a pending rename. ViewModels/NiagaraEmitterHandleViewModel.h  
EmitterHandle FNiagaraEmitterHandle * The emitter handle being displayed and edited by this view model. ViewModels/NiagaraEmitterHandleViewModel.h  
EmitterHandleIndex int32 The index of this handle in the system when it was initialized. ViewModels/NiagaraEmitterHandleViewModel.h  
EmitterStackViewModel TObjectPtr< UNiagaraStackViewModel > The stack view model which represents the emitter pointed to by this handle. ViewModels/NiagaraEmitterHandleViewModel.h  
EmitterViewModel TSharedRef< FNiagaraEmitterViewModel > The view model for emitter this handle references. ViewModels/NiagaraEmitterHandleViewModel.h  
OnNameChangedDelegate FOnNameChanged A multicast delegate which is called any time this emitter handle is renamed. ViewModels/NiagaraEmitterHandleViewModel.h  
OnPropertyChangedDelegate FOnPropertyChanged A multicast delegate which is called any time a property on the handle changes. ViewModels/NiagaraEmitterHandleViewModel.h  
OwningSystemViewModelWeak TWeakPtr< FNiagaraSystemViewModel > The system view model which owns this emitter handle view model. ViewModels/NiagaraEmitterHandleViewModel.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FGuid AddMessage ( UNiagaraMessageData* NewMessage,
const FGuid& InNewGuid
) const

 Add a serialized message to the Emitter this viewmodel is managing. ViewModels/NiagaraEmitterHandleViewModel.h  

void BeginDebugEmitter()

   ViewModels/NiagaraEmitterHandleViewModel.h  

bool CanRenameEmitter()

 Gets whether or not this emitter can be renamed. ViewModels/NiagaraEmitterHandleViewModel.h  

void Cleanup()

   ViewModels/NiagaraEmitterHandleViewModel.h  

FNiagaraEmitterHandle * GetEmitterHandle()

 Gets the emitter handled being view and edited by this view model. ViewModels/NiagaraEmitterHandleViewModel.h  

UNiagaraStackViewModel * GetEmitterStackViewModel()

 Gets the stack view model which represents the emitter pointed to by this handle. ViewModels/NiagaraEmitterHandleViewModel.h  

TSharedRef< FNiagaraEmitterViewModel > GetEmitterViewModel()

 Gets the view model for the emitter this handle references. ViewModels/NiagaraEmitterHandleViewModel.h  

FText GetErrorText()

 Called to get the error state of the emitter handle. ViewModels/NiagaraEmitterHandleViewModel.h  

FSlateColor GetErrorTextColor()

   ViewModels/NiagaraEmitterHandleViewModel.h  

EVisibility GetErrorTextVisibility()

   ViewModels/NiagaraEmitterHandleViewModel.h  

FGuid GetId()

 Gets the id of the emitter handle. ViewModels/NiagaraEmitterHandleViewModel.h  

bool GetIsEnabled()

 Gets whether or not this emitter handle is enabled. ViewModels/NiagaraEmitterHandleViewModel.h  

ECheckBoxState GetIsEnabledCheckState()

 Gets the check state for the is enabled check box. ViewModels/NiagaraEmitterHandleViewModel.h  

bool GetIsIsolated()

 Gets whether or not the emitter for this handle has been isolated in the UI. ViewModels/NiagaraEmitterHandleViewModel.h  

bool GetIsRenamePending()

 Gets whether or not this emitter handle has a rename pending. ViewModels/NiagaraEmitterHandleViewModel.h  

FName GetName()

 Gets the name of the emitter handle. ViewModels/NiagaraEmitterHandleViewModel.h  

FText GetNameText()

 Gets the text representation of the emitter handle name. ViewModels/NiagaraEmitterHandleViewModel.h  

ENiagaraSystemViewModelEditMode GetOwningSystemEditMode()

 Gets the current edit mode of the emitter's owning system. ViewModels/NiagaraEmitterHandleViewModel.h  

TSharedRef< FNiagaraSystemViewModel > GetOwningSystemViewModel()

   ViewModels/NiagaraEmitterHandleViewModel.h  

void GetRendererEntries ( TArray< UNiagaraStackEntry* >& InRenderingEntries
)

   ViewModels/NiagaraEmitterHandleViewModel.h  

void Initialize ( TSharedRef< FNiagaraSystemViewModel > InOwningSystemViewModel,
int32 InEmitterHandleIndex,
TWeakPtr< FNiagaraEmitterInstance, ESPMode::ThreadSafe > InSimulation
)

 Initializes the emitter editor view model with the supplied emitter handle and simulation. ViewModels/NiagaraEmitterHandleViewModel.h  

bool IsValid()

 Returns whether or not this view model represents a valid emitter handle. ViewModels/NiagaraEmitterHandleViewModel.h  

void OnIsEnabledCheckStateChanged ( ECheckBoxState InCheckState
)

 Called when the check state of the enabled check box changes. ViewModels/NiagaraEmitterHandleViewModel.h  

FOnNameChanged & OnNameChanged()

 Gets a multicast delegate which is called any time this handle is renamed. ViewModels/NiagaraEmitterHandleViewModel.h  

void OnNameTextComitted ( const FText& InText,
ETextCommit::Type CommitInfo
)

 Called when the contents of the name text control is committed. ViewModels/NiagaraEmitterHandleViewModel.h  

FOnPropertyChanged & OnPropertyChanged()

 Gets a multicast delegate which is called any time a property on the handle changes. ViewModels/NiagaraEmitterHandleViewModel.h  

void RemoveMessage ( const FGuid& MessageKey
) const

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

void RequestCaptureThumbnail()

   ViewModels/NiagaraEmitterHandleViewModel.h  

void RequestEmitterSelection ( bool bClearSelection
)

   ViewModels/NiagaraEmitterHandleViewModel.h  

void Reset()

 Resets the data in the view model. ViewModels/NiagaraEmitterHandleViewModel.h  

bool SetIsEnabled ( bool bInIsEnabled,
bool bRequestRecompile
)

 Sets whether or not this emitter handle is enabled. ViewModels/NiagaraEmitterHandleViewModel.h  

void SetIsIsolated ( bool InIsIsolated
)

 Sets whether or not this emitter is isolated. May affect other emitters in the system. ViewModels/NiagaraEmitterHandleViewModel.h  

void SetIsRenamePending ( bool bInIsRenamePending
)

 Sets whether or not this emitter handle has a rename pending. ViewModels/NiagaraEmitterHandleViewModel.h  

void SetName ( FName InName
)

 Sets the name of the emitter handle. ViewModels/NiagaraEmitterHandleViewModel.h  

void SetSimulation ( TWeakPtr< FNiagaraEmitterInstance, ESPMode::ThreadSafe > InSimulation
)

 Sets the simulation for the emitter this handle references. ViewModels/NiagaraEmitterHandleViewModel.h  

void ToggleIsIsolated()

   ViewModels/NiagaraEmitterHandleViewModel.h  

bool VerifyNameTextChanged ( const FText& NewText,
FText& OutErrorMessage
)

 Prevent invalid name being set on emitter. ViewModels/NiagaraEmitterHandleViewModel.h  

Overridden from FGCObject

Name Remarks Include Path Unreal Specifiers

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

   ViewModels/NiagaraEmitterHandleViewModel.h  

virtual FString GetReferencerName()

   ViewModels/NiagaraEmitterHandleViewModel.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page