Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > NiagaraEditor > ViewModels > FNiagaraEmitterViewModel

Light Theme

Dark Theme

FNiagaraEmitterViewModel

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

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

TNiagaraViewModelManager

FNiagaraEmitterViewModel

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 >

Remarks

The view model for the UNiagaraEmitter objects

Constructors

	Name	Description
	FNiagaraEmitterViewModel()	Creates a new emitter editor view model. It must be initialized before use.

Destructors

	Name	Description
	~FNiagaraEmitterViewModel()

Functions

	Name	Description
void	Cleanup()
void	CreateNewParentWindow ( TSharedRef< FNiagaraEmitterHandleVi... )
const UNiaga...	GetEditorData()	Gets editor specific data which can be stored per emitter.
UNiagaraEmit...	GetEmitter()	Gets the emitter represented by this view model.
ENiagaraScri...	GetLatestCompileStatus()	Get the latest status of this view-model's script compilation.
UNiagaraEmit...	GetOrCreateEditorData()	Gets editor specific data which is stored per emitter.
const UNiaga...	GetParentEmitter()	Gets the parent emitter for the emitter represented by this view model, if it has one.
FText	GetParentNameText()	Gets the text representation of the parent emitter name.
FText	GetParentPathNameText()	Gets the text representation of the parent emitter path.
TSharedRef< ...	GetSharedScriptViewModel()	Geta a view model for the update/spawn Script.
TWeakPtr< FN...	GetSimulation()	Gets the currently assigned simulation if there is one.
FText	GetStatsText()	Gets text representing stats for the emitter.
bool	HasParentEmitter()	Gets whether or not this emitter has a parent emitter.
bool	Initialize ( UNiagaraEmitter* InEmitter, TWeakPtr< FNiagaraEmitterInstance, ... )	Initialize this view model with an emitter and simulation.
FOnEmitterCh...	OnEmitterChanged()	Gets a multicast delegate which is called when the emitter for this view model changes to a different emitter.
FOnParentRem...	OnParentRemoved()	Gets a delegate which is called when this emitters parent is removed.
FOnPropertyC...	OnPropertyChanged()	Gets a delegate which is called when a property on the emitter changes.
FOnScriptCom...	OnScriptCompiled()	Gets a delegate which is called when the shared script is compiled.
FOnScriptGra...	OnScriptGraphChanged()	Gets a multicast delegate which is called any time a graph on a script owned by this emitter changes.
FOnScriptPar...	OnScriptParameterStoreChanged()	Gets a multicast delegate which is called any time a parameter store on a script owned by this emitter changes.
void	RemoveParentEmitter()	Removes the parent emitter from this emitter.
void	Reset()	Resets this view model to initial conditions.
void	SetSimulation ( TWeakPtr< FNiagaraEmitterInstance, ... )	Sets the current simulation for the emitter.
void	UpdateParentEmitter ( const TArray< FAssetData >& Activa..., EAssetTypeActivationMethod::Type Ac..., TSharedRef< FNiagaraEmitterHandleVi... )

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.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss