Navigation
API > API/Plugins > API/Plugins/NiagaraEditor
The view model for the UNiagaraEmitter objects
| Name | FNiagaraEmitterViewModel |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/ViewModels/NiagaraEmitterViewModel.h |
| Include Path | #include "ViewModels/NiagaraEmitterViewModel.h" |
Syntax
class FNiagaraEmitterViewModel :
public TSharedFromThis< FNiagaraEmitterViewModel > ,
public TNiagaraViewModelManager< UNiagaraEmitter, FNiagaraEmitterViewModel > ,
public INiagaraParameterDefinitionsSubscriberViewModel ,
public FGCObject
Inheritance Hierarchy
- FGCObject → FNiagaraEmitterViewModel
- FSharedFromThisBase → TSharedFromThis → FNiagaraEmitterViewModel
- TNiagaraViewModelManager → FNiagaraEmitterViewModel
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNiagaraEmitterViewModel
(
bool bInIsForDataProcessingOnly |
Creates a new emitter editor view model. It must be initialized before use. | ViewModels/NiagaraEmitterViewModel.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FNiagaraEmitterViewModel() |
ViewModels/NiagaraEmitterViewModel.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnEmitterChanged | TMulticastDelegate_NoParams< void > | ViewModels/NiagaraEmitterViewModel.h | |
| FOnEmitterSelectionRequested | TBaseDelegate_OneParam< void, bool > | ViewModels/NiagaraEmitterViewModel.h | |
| FOnParentRemoved | TMulticastDelegate_NoParams< void > | ViewModels/NiagaraEmitterViewModel.h | |
| FOnPropertyChanged | TMulticastDelegate_NoParams< void > | ViewModels/NiagaraEmitterViewModel.h | |
| FOnScriptCompiled | TMulticastDelegate_TwoParams< void, UNiagaraScript *, const FGuid & > | ViewModels/NiagaraEmitterViewModel.h | |
| FOnScriptGraphChanged | TMulticastDelegate_TwoParams< void, const FEdGraphEditAction &, const UNiagaraScript & > | ViewModels/NiagaraEmitterViewModel.h | |
| FOnScriptParameterStoreChanged | TMulticastDelegate_TwoParams< void, const FNiagaraParameterStore &, const UNiagaraScript & > | ViewModels/NiagaraEmitterViewModel.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ParticleDisabledDueToScalability | const FText | The text format stats to display when an emitter is disabled due to scalability. | ViewModels/NiagaraEmitterViewModel.h |
| StatsFormat | const FText | The text format stats display . | ViewModels/NiagaraEmitterViewModel.h |
| StatsParticleCountFormat | const FText | The text format stats to only display particles count. | ViewModels/NiagaraEmitterViewModel.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| PreviousEmitterVersion | FGuid | When the parent emitter version is changed, this is set to generate the changelist in the stack. | ViewModels/NiagaraEmitterViewModel.h | |
| PythonUpgradeScriptWarnings | FString | Can be used by the ui after a version change to display change notes | ViewModels/NiagaraEmitterViewModel.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bUpdatingSelectionInternally | bool | A flag to prevent reentrancy when updating selection sets. | ViewModels/NiagaraEmitterViewModel.h | |
| EmitterWeakPtr | FVersionedNiagaraEmitterWeakPtr | The emitter object being displayed by the control . | ViewModels/NiagaraEmitterViewModel.h | |
| ExecutionStateEnum | UEnum * | ViewModels/NiagaraEmitterViewModel.h | ||
| NewParentWindow | TSharedPtr< SWindow > | ViewModels/NiagaraEmitterViewModel.h | ||
| OnEmitterChangedDelegate | FOnEmitterChanged | A multicast delegate which is called whenever the emitter for this view model is changed to a different emitter. | ViewModels/NiagaraEmitterViewModel.h | |
| OnEmitterSelectionRequestedDelegate | FOnEmitterSelectionRequested | ViewModels/NiagaraEmitterViewModel.h | ||
| OnParentRemovedDelegate | FOnParentRemoved | A multicast delegate which is called when this emitters parent is removed. | ViewModels/NiagaraEmitterViewModel.h | |
| OnPropertyChangedDelegate | FOnPropertyChanged | A multicast delegate which is called whenever a property on the emitter changes. | ViewModels/NiagaraEmitterViewModel.h | |
| OnScriptCompiledDelegate | FOnScriptCompiled | ViewModels/NiagaraEmitterViewModel.h | ||
| OnScriptGraphChangedDelegate | FOnScriptGraphChanged | ViewModels/NiagaraEmitterViewModel.h | ||
| OnScriptParameterStoreChangedDelegate | FOnScriptParameterStoreChanged | ViewModels/NiagaraEmitterViewModel.h | ||
| RegisteredHandle | TNiagaraViewModelManager< UNiagaraEmitter, FNiagaraEmitterViewModel >::Handle | ViewModels/NiagaraEmitterViewModel.h | ||
| ScriptToOnGraphChangedHandleMap | TMap< FObjectKey, FDelegateHandle > | A mapping of script to the delegate handle for it's on graph changed delegate. | ViewModels/NiagaraEmitterViewModel.h | |
| ScriptToOnParameterStoreChangedHandleMap | TMap< FObjectKey, FDelegateHandle > | A mapping of script to the delegate handle for it's on parameter map changed delegate. | ViewModels/NiagaraEmitterViewModel.h | |
| ScriptToRecompileHandleMap | TMap< FObjectKey, FDelegateHandle > | ViewModels/NiagaraEmitterViewModel.h | ||
| SharedScriptViewModel | TSharedPtr< FNiagaraScriptViewModel > | The view model for the update/spawn/event script. | ViewModels/NiagaraEmitterViewModel.h | |
| Simulation | TWeakPtr< FNiagaraEmitterInstance, ESPMode::ThreadSafe > | The runtime simulation for the emitter being displayed by the control | ViewModels/NiagaraEmitterViewModel.h | |
| SummaryViewHierarchyViewModel | TObjectPtr< UNiagaraSummaryViewViewModel > | ViewModels/NiagaraEmitterViewModel.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddEventHandler
(
FNiagaraEventScriptProperties& EventScriptProperties, |
Add an event script to the owned emitter. | ViewModels/NiagaraEmitterViewModel.h | |
void Cleanup() |
ViewModels/NiagaraEmitterViewModel.h | ||
void CreateNewParentWindow
(
TSharedRef< FNiagaraEmitterHandleViewModel > EmitterHandleViewModel |
ViewModels/NiagaraEmitterViewModel.h | ||
const UNiagaraEmitterEditorData & GetEditorData () |
Gets editor specific data which can be stored per emitter. | ViewModels/NiagaraEmitterViewModel.h | |
| Gets editor specific data which is stored per emitter. | ViewModels/NiagaraEmitterViewModel.h | ||
FVersionedNiagaraEmitter GetEmitter() |
Gets the emitter represented by this view model. | ViewModels/NiagaraEmitterViewModel.h | |
void GetEmitterMessageStores
(
TArray< FNiagaraMessageSourceAndStore >& OutMessageStores |
ViewModels/NiagaraEmitterViewModel.h | ||
ENiagaraScriptCompileStatus GetLatestCompileStatus() |
Get the latest status of this view-model's script compilation. | ViewModels/NiagaraEmitterViewModel.h | |
FVersionedNiagaraEmitter GetParentEmitter() |
Gets the parent emitter for the emitter represented by this view model, if it has one. | ViewModels/NiagaraEmitterViewModel.h | |
FText GetParentNameText() |
Gets the text representation of the parent emitter name. | ViewModels/NiagaraEmitterViewModel.h | |
FText GetParentPathNameText() |
Gets the text representation of the parent emitter path. | ViewModels/NiagaraEmitterViewModel.h | |
TSharedRef< FNiagaraScriptViewModel > GetSharedScriptViewModel() |
Geta a view model for the update/spawn Script. | ViewModels/NiagaraEmitterViewModel.h | |
TWeakPtr< FNiagaraEmitterInstance, ESPMode::ThreadSafe > GetSimulation() |
Gets the currently assigned simulation if there is one. | ViewModels/NiagaraEmitterViewModel.h | |
FText GetStatsText() |
Gets text representing stats for the emitter. | ViewModels/NiagaraEmitterViewModel.h | |
UNiagaraSummaryViewViewModel * GetSummaryHierarchyViewModel() |
ViewModels/NiagaraEmitterViewModel.h | ||
bool HasParentEmitter() |
Gets whether or not this emitter has a parent emitter. | ViewModels/NiagaraEmitterViewModel.h | |
bool Initialize
(
const FVersionedNiagaraEmitter& InEmitter, |
Initialize this view model with an emitter and simulation. | ViewModels/NiagaraEmitterViewModel.h | |
FOnEmitterChanged & OnEmitterChanged() |
Gets a multicast delegate which is called when the emitter for this view model changes to a different emitter. | ViewModels/NiagaraEmitterViewModel.h | |
FOnEmitterSelectionRequested & OnEmitterSelectionRequested() |
ViewModels/NiagaraEmitterViewModel.h | ||
FOnParentRemoved & OnParentRemoved() |
Gets a delegate which is called when this emitters parent is removed. | ViewModels/NiagaraEmitterViewModel.h | |
FOnPropertyChanged & OnPropertyChanged() |
Gets a delegate which is called when a property on the emitter changes. | ViewModels/NiagaraEmitterViewModel.h | |
FOnScriptCompiled & OnScriptCompiled() |
Gets a delegate which is called when the shared script is compiled. | ViewModels/NiagaraEmitterViewModel.h | |
FOnScriptGraphChanged & OnScriptGraphChanged() |
Gets a multicast delegate which is called any time a graph on a script owned by this emitter changes. | ViewModels/NiagaraEmitterViewModel.h | |
FOnScriptParameterStoreChanged & OnScriptParameterStoreChanged() |
Gets a multicast delegate which is called any time a parameter store on a script owned by this emitter changes. | ViewModels/NiagaraEmitterViewModel.h | |
void RemoveParentEmitter() |
Removes the parent emitter from this emitter. | ViewModels/NiagaraEmitterViewModel.h | |
void Reset() |
Resets this view model to initial conditions. | ViewModels/NiagaraEmitterViewModel.h | |
void SetSimulation
(
TWeakPtr< FNiagaraEmitterInstance, ESPMode::ThreadSafe > InSimulation |
Sets the current simulation for the emitter. | ViewModels/NiagaraEmitterViewModel.h | |
void UpdateParentEmitter
(
const TArray< FAssetData >& ActivatedAssets, |
ViewModels/NiagaraEmitterViewModel.h |
Protected
Overridden from INiagaraParameterDefinitionsSubscriberViewModel
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual INiagaraParameterDefinitionsSubscriber * GetParameterDefinitionsSubscriber() |
ViewModels/NiagaraEmitterViewModel.h |