1. Epic GamesDeveloper
  3. FNiagaraEmitterHandleViewModel

FNiagaraEmitterHandleViewModel

The view model for the FNiagaraEmitterEditorWidget.

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

Inheritance Hierarchy

References

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

Syntax

class FNiagaraEmitterHandleViewModel :  
    public TSharedFromThis< FNiagaraEmitterHandleViewModel > ,  
    public FGCObject

Remarks

The view model for the FNiagaraEmitterEditorWidget.

Constructors

  Type Name Description
Public function  

FNiagaraEmitterHandleViewModel ( bool bInIsForDataProcessingOnly
)

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

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const FGuid

AddMessage ( UNiagaraMessageData* NewMessage,
const FGuid& InNewGuid
)

 Add a serialized message to the Emitter this viewmodel is managing.
Public function void  
Public function Const bool Gets whether or not this emitter can be renamed.
Public function void

Cleanup ()

  
Public function FNiagaraEmitterHandle * Gets the emitter handled being view and edited by this view model.
Public function UNiagaraStackViewModel * Gets the stack view model which represents the emitter pointed to by this handle.
Public function TSharedRef< FNiagaraEmitterViewModel > Gets the view model for the emitter this handle references.
Public function Const FText Called to get the error state of the emitter handle.
Public function Const FSlateColor  
Public function Const EVisibility  
Public function Const FGuid

GetId ()

 Gets the id of the emitter handle.
Public function Const bool Gets whether or not this emitter handle is enabled.
Public function Const ECheckBoxState Gets the check state for the is enabled check box.
Public function Const bool Gets whether or not the emitter for this handle has been isolated in the UI.
Public function Const bool Gets whether or not this emitter handle has a rename pending.
Public function Const FName

GetName ()

 Gets the name of the emitter handle.
Public function Const FText Gets the text representation of the emitter handle name.
Public function Const ENiagaraSystemViewModelEditMode Gets the current edit mode of the emitter's owning system.
Public function Const TSharedRef< FNiagaraSystemViewModel >  
Public function void

GetRendererEntries ( TArray< UNiagaraStackEntry* >& InRenderingEntries
)

  
Public function 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.
Public function Const bool

IsValid ()

 Returns whether or not this view model represents a valid emitter handle.
Public function void Called when the check state of the enabled check box changes.
Public function FOnNameChanged & Gets a multicast delegate which is called any time this handle is renamed.
Public function void

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

 Called when the contents of the name text control is committed.
Public function FOnPropertyChanged & Gets a multicast delegate which is called any time a property on the handle changes.
Public function Const void

RemoveMessage ( const FGuid& MessageKey
)

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

RequestEmitterSelection ( bool bClearSelection
)

  
Public function void

Reset ()

 Resets the data in the view model.
Public function bool

SetIsEnabled ( bool bInIsEnabled,
bool bRequestRecompile
)

 Sets whether or not this emitter handle is enabled.
Public function void

SetIsIsolated ( bool InIsIsolated
)

 Sets whether or not this emitter is isolated. May affect other emitters in the system.
Public function void

SetIsRenamePending ( bool bInIsRenamePending
)

 Sets whether or not this emitter handle has a rename pending.
Public function void

SetName ( FName InName
)

 Sets the name of the emitter handle.
Public function void Sets the simulation for the emitter this handle references.
Public function void  
Public function bool

VerifyNameTextChanged ( const FText& NewText,
FText& OutErrorMessage
)

 Prevent invalid name being set on emitter.

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

Typedefs

Name Description
FOnNameChanged  
FOnPropertyChanged  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page