FNiagaraEmitterViewModel

The view model for the [UNiagaraEmitter](API\Plugins\Niagara\UNiagaraEmitter) objects

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

NiagaraEditor

Header

/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/ViewModels/NiagaraEmitterViewModel.h

Include

#include "ViewModels/NiagaraEmitterViewModel.h"

Syntax

Remarks

The view model for the UNiagaraEmitter objects

Constructors

Name Description

Public function

FNiagaraEmitterViewModel

(
    bool bInIsForDataProcessingOnly
)

Creates a new emitter editor view model. It must be initialized before use.

Destructors

Name Description

Public function Virtual

~FNiagaraEmitterViewModel()

Functions

Name Description

Public function

void

 

AddEventHandler

(
    FNiagaraEventScriptProperties& Eve...,
    bool bResetGraphForOutput
)

Add an event script to the owned emitter.

Public function

void

 

Cleanup()

Public function

void

 

CreateNewParentWindow

Public function Const

const UNiaga...

 

GetEditorData()

Gets editor specific data which can be stored per emitter.

Public function

UNiagaraEmit...

 

GetEmitter()

Gets the emitter represented by this view model.

Public function

ENiagaraScri...

 

GetLatestCompileStatus()

Get the latest status of this view-model's script compilation.

Public function

UNiagaraEmit...

 

GetOrCreateEditorData()

Gets editor specific data which is stored per emitter.

Public function Const

const UNiaga...

 

GetParentEmitter()

Gets the parent emitter for the emitter represented by this view model, if it has one.

Public function Const

FText

 

GetParentNameText()

Gets the text representation of the parent emitter name.

Public function Const

FText

 

GetParentPathNameText()

Gets the text representation of the parent emitter path.

Public function

TSharedRef< ...

 

GetSharedScriptViewModel()

Geta a view model for the update/spawn Script.

Public function Const

TWeakPtr< FN...

 

GetSimulation()

Gets the currently assigned simulation if there is one.

Public function Const

FText

 

GetStatsText()

Gets text representing stats for the emitter.

Public function Const

bool

 

HasParentEmitter()

Gets whether or not this emitter has a parent emitter.

Public function

bool

 

Initialize

(
    UNiagaraEmitter* InEmitter,
    TWeakPtr< FNiagaraEmitterInstance, ...
)

Initialize this view model with an emitter and simulation.

Public function

FOnEmitterCh...

 

OnEmitterChanged()

Gets a multicast delegate which is called when the emitter for this view model changes to a different emitter.

Public function

FOnParentRem...

 

OnParentRemoved()

Gets a delegate which is called when this emitters parent is removed.

Public function

FOnPropertyC...

 

OnPropertyChanged()

Gets a delegate which is called when a property on the emitter changes.

Public function

FOnScriptCom...

 

OnScriptCompiled()

Gets a delegate which is called when the shared script is compiled.

Public function

FOnScriptGra...

 

OnScriptGraphChanged()

Gets a multicast delegate which is called any time a graph on a script owned by this emitter changes.

Public function

FOnScriptPar...

 

OnScriptParameterStoreChanged()

Gets a multicast delegate which is called any time a parameter store on a script owned by this emitter changes.

Public function

void

 

RemoveParentEmitter()

Removes the parent emitter from this emitter.

Public function

void

 

Reset()

Resets this view model to initial conditions.

Public function

void

 

SetSimulation

Sets the current simulation for the emitter.

Public function

void

 

UpdateParentEmitter

(
    const TArray< FAssetData >& Activa...,
    EAssetTypeActivationMethod::Type Ac...,
    TSharedRef< FNiagaraEmitterHandleVi...
)

Overridden from INiagaraParameterDefinitionsSubscriberViewModel

Typedefs

Constants

Name

Description

ParticleDisabledDueToScalability

The text format stats to display when an emitter is disabled due to scalability.

StatsFormat

The text format stats display .

StatsParticleCountFormat

The text format stats to only display particles count.