Navigation
API > API/Plugins > API/Plugins/NiagaraEditor > API/Plugins/NiagaraEditor/ViewModels
Inheritance Hierarchy
- TSharedFromThis
- TNiagaraViewModelManager
- INiagaraParameterDefinitionsSubscriberViewModel
- FGCObject
- 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 >,
public INiagaraParameterDefinitionsSubscriberViewModel,
public FGCObject
Remarks
The view model for the UNiagaraEmitter objects
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FGuid | PreviousEmitterVersion | When the parent emitter version is changed, this is set to generate the changelist in the stack. |
 |
FString | PythonUpgradeScriptWarnings | Can be used by the ui after a version change to display change notes |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FNiagaraEmitterViewModel
(
bool bInIsForDataProcessingOnly |
Creates a new emitter editor view model. It must be initialized before use. |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | AddEventHandler
(
FNiagaraEventScriptProperties& EventScriptProperties, |
Add an event script to the owned emitter. |
 |
void | Cleanup () |
|
 |
void | CreateNewParentWindow
(
TSharedRef< FNiagaraEmitterHandleViewModel > EmitterHandleViewModel |
|
  |
const UNiagaraEmitterEditorData & | Gets editor specific data which can be stored per emitter. | |
 |
UNiagaraEmitterEditorData & | Gets editor specific data which is stored per emitter. | |
 |
FVersionedNiagaraEmitter | GetEmitter () |
Gets the emitter represented by this view model. |
 |
void | GetEmitterMessageStores
(
TArray< FNiagaraMessageSourceAndStore >& OutMessageStores |
|
 |
ENiagaraScriptCompileStatus | Get the latest status of this view-model's script compilation. | |
  |
FVersionedNiagaraEmitter | Gets the parent emitter for the emitter represented by this view model, if it has one. | |
  |
FText | Gets the text representation of the parent emitter name. | |
  |
FText | Gets the text representation of the parent emitter path. | |
 |
TSharedRef< FNiagaraScriptViewModel > | Geta a view model for the update/spawn Script. | |
  |
TWeakPtr< FNiagaraEmitterInstance, ESPMode::ThreadSafe > | Gets the currently assigned simulation if there is one. | |
  |
FText | GetStatsText () |
Gets text representing stats for the emitter. |
 |
UNiagaraSummaryViewViewModel * | ||
  |
bool | Gets whether or not this emitter has a parent emitter. | |
 |
bool | Initialize
(
const FVersionedNiagaraEmitter& InEmitter, |
Initialize this view model with an emitter and simulation. |
 |
FOnEmitterChanged & | Gets a multicast delegate which is called when the emitter for this view model changes to a different emitter. | |
 |
FOnParentRemoved & | Gets a delegate which is called when this emitters parent is removed. | |
 |
FOnPropertyChanged & | Gets a delegate which is called when a property on the emitter changes. | |
 |
FOnScriptCompiled & | Gets a delegate which is called when the shared script is compiled. | |
 |
FOnScriptGraphChanged & | Gets a multicast delegate which is called any time a graph on a script owned by this emitter changes. | |
 |
FOnScriptParameterStoreChanged & | Gets a multicast delegate which is called any time a parameter store on a script owned by this emitter changes. | |
 |
void | Removes the parent emitter from this emitter. | |
 |
void | Reset () |
Resets this view model to initial conditions. |
 |
void | SetSimulation
(
TWeakPtr< FNiagaraEmitterInstance, ESPMode::ThreadSafe > InSimulation |
Sets the current simulation for the emitter. |
 |
void | UpdateParentEmitter
(
const TArray< FAssetData >& ActivatedAssets, |
Overridden from INiagaraParameterDefinitionsSubscriberViewModel
| Type | Name | Description | |
|---|---|---|---|
  |
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. |