1. Epic GamesDeveloper
  3. FNiagaraEmitterViewModel

FNiagaraEmitterViewModel

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

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

Inheritance Hierarchy

References

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

Syntax

class FNiagaraEmitterViewModel :  
    public TSharedFromThis< FNiagaraEmitterViewModel >,  
    public TNiagaraViewModelManager< UNiagaraEmitter, FNiagaraEmitterViewModel >,  
    public INiagaraParameterDefinitionsSubscriberViewModel,  
    public FGCObject

Remarks

The view model for the UNiagaraEmitter objects

Variables

  Type Name Description
Public variable FGuid PreviousEmitterVersion When the parent emitter version is changed, this is set to generate the changelist in the stack.
Public variable FString PythonUpgradeScriptWarnings Can be used by the ui after a version change to display change notes

Constructors

  Type Name Description
Public function  

FNiagaraEmitterViewModel ( bool bInIsForDataProcessingOnly
)

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

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddEventHandler ( FNiagaraEventScriptProperties& EventScriptProperties,
bool bResetGraphForOutput
)

 Add an event script to the owned emitter.
Public function void

Cleanup ()

  
Public function void  
Public function Const const UNiagaraEmitterEditorData & Gets editor specific data which can be stored per emitter.
Public function UNiagaraEmitterEditorData & Gets editor specific data which is stored per emitter.
Public function FVersionedNiagaraEmitter Gets the emitter represented by this view model.
Public function void  
Public function ENiagaraScriptCompileStatus Get the latest status of this view-model's script compilation.
Public function Const FVersionedNiagaraEmitter Gets the parent emitter for the emitter represented by this view model, if it has one.
Public function Const FText Gets the text representation of the parent emitter name.
Public function Const FText Gets the text representation of the parent emitter path.
Public function TSharedRef< FNiagaraScriptViewModel > Geta a view model for the update/spawn Script.
Public function Const TWeakPtr< FNiagaraEmitterInstance, ESPMode::ThreadSafe > Gets the currently assigned simulation if there is one.
Public function Const FText Gets text representing stats for the emitter.
Public function UNiagaraSummaryViewViewModel *  
Public function Const bool Gets whether or not this emitter has a parent emitter.
Public function bool

Initialize ( const FVersionedNiagaraEmitter& InEmitter,
TWeakPtr< FNiagaraEmitterInstance, ESPMode::ThreadSafe > InSimulation
)

 Initialize this view model with an emitter and simulation.
Public function FOnEmitterChanged & Gets a multicast delegate which is called when the emitter for this view model changes to a different emitter.
Public function FOnParentRemoved & Gets a delegate which is called when this emitters parent is removed.
Public function FOnPropertyChanged & Gets a delegate which is called when a property on the emitter changes.
Public function FOnScriptCompiled & Gets a delegate which is called when the shared script is compiled.
Public function FOnScriptGraphChanged & Gets a multicast delegate which is called any time a graph on a script owned by this emitter changes.
Public function FOnScriptParameterStoreChanged & Gets a multicast delegate which is called any time a parameter store on a script owned by this emitter changes.
Public function void Removes the parent emitter from this emitter.
Public function void

Reset ()

 Resets this view model to initial conditions.
Public function void

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

 Sets the current simulation for the emitter.
Public function void

UpdateParentEmitter ( const TArray< FAssetData >& ActivatedAssets,
EAssetTypeActivationMethod::Type ActivationMethod,
TSharedRef< FNiagaraEmitterHandleViewModel > EmitterHandleViewModel
)

  

Overridden from INiagaraParameterDefinitionsSubscriberViewModel

  Type Name Description
Protected function Virtual INiagaraParameterDefinitionsSubscriber *  

Typedefs

Name Description
FOnEmitterChanged  
FOnParentRemoved  
FOnPropertyChanged  
FOnScriptCompiled  
FOnScriptGraphChanged  
FOnScriptParameterStoreChanged  

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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page