FNiagaraEmitterHandleViewModel

The view model for the FNiagaraEmitterEditorWidget.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

TSharedFromThis

FGCObject

FNiagaraEmitterHandleViewModel

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

Name Description

Public function

FNiagaraEmitterHandleViewModel

(
    bool bInIsForDataProcessingOnly
)

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

Destructors

Functions

Name Description

Public function Const

FGuid

 

AddMessage

(
    UNiagaraMessageData* NewMessag...,
    const FGuid& InNewGuid
)

Add a serialized message to the Emitter this viewmodel is managing.

Public function Const

bool

 

CanRenameEmitter()

Gets whether or not this emitter can be renamed.

Public function

void

 

Cleanup()

Public function

FNiagaraEmit...

 

GetEmitterHandle()

Gets the emitter handled being view and edited by this view model.

Public function

UNiagaraStac...

 

GetEmitterStackViewModel()

Gets the stack view model which represents the emitter pointed to by this handle.

Public function

TSharedRef< ...

 

GetEmitterViewModel()

Gets the view model for the emitter this handle references.

Public function Const

FText

 

GetErrorText()

Called to get the error state of the emitter handle.

Public function Const

FSlateColor

 

GetErrorTextColor()

Called to get the error state of the emitter handle.

Public function Const

EVisibility

 

GetErrorTextVisibility()

Called to get the error state of the emitter handle.

Public function Const

FGuid

 

GetId()

Gets the id of the emitter handle.

Public function Const

bool

 

GetIsEnabled()

Gets whether or not this emitter handle is enabled.

Public function Const

ECheckBoxSta...

 

GetIsEnabledCheckState()

Gets the check state for the is enabled check box.

Public function Const

bool

 

GetIsIsolated()

Gets whether or not the emitter for this handle has been isolated in the UI.

Public function Const

bool

 

GetIsRenamePending()

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

 

GetNameText()

Gets the text representation of the emitter handle name.

Public function Const

ENiagaraSyst...

 

GetOwningSystemEditMode()

Gets the current edit mode of the emitter's owning system.

Public function Const

TSharedRef< ...

 

GetOwningSystemViewModel()

Public function

void

 

GetRendererEntries

(
    TArray< UNiagaraStackEntry* > ...
)

Public function

void

 

Initialize

(
    TSharedRef< FNiagaraSystemViewModel...,
    int32 InEmitterHandleIndex,
    TWeakPtr< FNiagaraEmitterInstance, ...
)

Initializes the emitter editor view model with the supplied emitter handle and simulation.

Public function Const

bool

 

IsSynchronized()

Called to get the synch state of the emitter handle to its source.

Public function Const

bool

 

IsValid()

Returns whether or not this view model represents a valid emitter handle.

Public function

void

 

OnIsEnabledCheckStateChanged

(
    ECheckBoxState InCheckState
)

Called when the check state of the enabled check box changes.

Public function

FOnNameChang...

 

OnNameChanged()

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

FOnPropertyC...

 

OnPropertyChanged()

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

 

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

 

SetSimulation

Sets the simulation for the emitter this handle references.

Public function

bool

 

VerifyNameTextChanged

(
    const FText& NewText,
    FText& OutErrorMessage
)

Prevent invalid name being set on emitter.

Overridden from FGCObject

Name Description

Public function Virtual

void

 

AddReferencedObjects

(
    FReferenceCollector& Collector
)

Pure virtual that must be overloaded by the inheriting class.

Public function Virtual Const

FString

 

GetReferencerName()

Use this method to report a name for your referencer.

Typedefs