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 > FNiagaraEmitterHandleViewModel

Light Theme

Dark Theme

FNiagaraEmitterHandleViewModel

The view model for the FNiagaraEmitterEditorWidget.

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
	FNiagaraEmitterHandleViewModel()	Creates a new emitter editor view model. This must be initialized before it can be used.

Destructors

	Name	Description
	~FNiagaraEmitterHandleViewModel()

Functions

	Name	Description
bool	CanRenameEmitter()	Gets whether or not this emitter can be renamed.
void	Cleanup()
FNiagaraEmit...	GetEmitterHandle()	Gets the emitter handled being view and edited by this view model.
UNiagaraStac...	GetEmitterStackViewModel()	Gets the stack view model which represents the emitter pointed to by this handle.
TSharedRef< ...	GetEmitterViewModel()	Gets the view model for the emitter this handle references.
FText	GetErrorText()	Called to get the error state of the emitter handle.
FSlateColor	GetErrorTextColor()	Called to get the error state of the emitter handle.
EVisibility	GetErrorTextVisibility()	Called to get the error state of the emitter handle.
FGuid	GetId()	Gets the id of the emitter handle.
FText	GetIdText()	Gets the id of the emitter handle.
bool	GetIsEnabled()	Gets whether or not this emitter handle is enabled.
ECheckBoxSta...	GetIsEnabledCheckState()	Gets the check state for the is enabled check box.
bool	GetIsIsolated()	Gets whether or not the emitter for this handle has been isolated in the UI.
bool	GetIsRenamePending()	Gets whether or not this emitter handle has a rename pending.
FName	GetName()	Gets the name of the emitter handle.
FText	GetNameText()	Gets the text representation of the emitter handle name.
ENiagaraSyst...	GetOwningSystemEditMode()	Gets the current edit mode of the emitter's owning system.
TSharedRef< ...	GetOwningSystemViewModel()
void	GetRendererEntries ( TArray< UNiagaraStackEntry* > ... )
void	Initialize ( TSharedRef< FNiagaraSystemViewModel..., FNiagaraEmitterHandle* InEmitt..., TWeakPtr< FNiagaraEmitterInstance, ... )	Initializes the emitter editor view model with the supplied emitter handle and simulation.
bool	IsSynchronized()	Called to get the synch state of the emitter handle to its source.
bool	IsValid()	Returns whether or not this view model represents a valid emitter handle.
void	OnIsEnabledCheckStateChanged ( ECheckBoxState InCheckState )	Called when the check state of the enabled check box changes.
FOnNameChang...	OnNameChanged()	Gets a multicast delegate which is called any time this handle is renamed.
void	OnNameTextComitted ( const FText& InText, ETextCommit::Type CommitInfo )	Called when the contents of the name text control is committed.
FOnPropertyC...	OnPropertyChanged()	Gets a multicast delegate which is called any time a property on the handle changes.
void	Reset()	Resets the data in the view model.
void	SetIsEnabled ( bool bInIsEnabled )	Sets whether or not this emitter handle is enabled.
void	SetIsIsolated ( bool InIsIsolated )	Sets whether or not this emitter is isolated. May affect other emitters in the system.
void	SetIsRenamePending ( bool bInIsRenamePending )	Sets whether or not this emitter handle has a rename pending.
void	SetName ( FName InName )	Sets the name of the emitter handle.
void	SetSimulation ( TWeakPtr< FNiagaraEmitterInstance, ... )	Sets the simulation for the emitter this handle references.
bool	VerifyNameTextChanged ( const FText& NewText, FText& OutErrorMessage )	Prevent invalid name being set on emitter.

Overridden from FGCObject

		Name	Description
	void	AddReferencedObjects ( FReferenceCollector& Collector )	Pure virtual that must be overloaded by the inheriting class.

Typedefs

Name	Description
FOnNameChanged
FOnPropertyChanged

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

Take our survey

Dismiss