Navigation
API > API/Plugins > API/Plugins/NiagaraEditor > API/Plugins/NiagaraEditor/ViewModels
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
| Type | Name | Description | |
|---|---|---|---|
 |
FNiagaraEmitterHandleViewModel
(
bool bInIsForDataProcessingOnly |
Creates a new emitter editor view model. This must be initialized before it can be used. |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
FGuid | AddMessage
(
UNiagaraMessageData* NewMessage, |
Add a serialized message to the Emitter this viewmodel is managing. |
 |
void | ||
  |
bool | Gets whether or not this emitter can be renamed. | |
 |
void | Cleanup () |
|
 |
FNiagaraEmitterHandle * | Gets the emitter handled being view and edited by this view model. | |
 |
UNiagaraStackViewModel * | Gets the stack view model which represents the emitter pointed to by this handle. | |
 |
TSharedRef< FNiagaraEmitterViewModel > | Gets the view model for the emitter this handle references. | |
  |
FText | GetErrorText () |
Called to get the error state of the emitter handle. |
  |
FSlateColor | Called to get the error state of the emitter handle. | |
  |
EVisibility | Called to get the error state of the emitter handle. | |
  |
FGuid | GetId () |
Gets the id of the emitter handle. |
  |
bool | GetIsEnabled () |
Gets whether or not this emitter handle is enabled. |
  |
ECheckBoxState | Gets the check state for the is enabled check box. | |
  |
bool | Gets whether or not the emitter for this handle has been isolated in the UI. | |
  |
bool | 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. |
  |
ENiagaraSystemViewModelEditMode | Gets the current edit mode of the emitter's owning system. | |
  |
TSharedRef< FNiagaraSystemViewModel > | ||
 |
void | GetRendererEntries
(
TArray< UNiagaraStackEntry* >& InRenderingEntries |
|
 |
void | Initialize
(
TSharedRef< FNiagaraSystemViewModel > InOwningSystemViewModel, |
Initializes the emitter editor view model with the supplied emitter handle and simulation. |
  |
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. |
 |
FOnNameChanged & | Gets a multicast delegate which is called any time this handle is renamed. | |
 |
void | OnNameTextComitted
(
const FText& InText, |
Called when the contents of the name text control is committed. |
 |
FOnPropertyChanged & | Gets a multicast delegate which is called any time a property on the handle changes. | |
  |
void | RemoveMessage
(
const FGuid& MessageKey |
Remove a serialized message from the Emitter this viewmodel is managing. |
 |
void | Reset () |
Resets the data in the view model. |
 |
bool | 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 | Sets the name of the emitter handle. | |
 |
void | SetSimulation
(
TWeakPtr< FNiagaraEmitterInstance, ESPMode::ThreadSafe > InSimulation |
Sets the simulation for the emitter this handle references. |
 |
bool | VerifyNameTextChanged
(
const FText& NewText, |
Prevent invalid name being set on emitter. |
Overridden from FGCObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | AddReferencedObjects
(
FReferenceCollector& Collector |
Pure virtual that must be overloaded by the inheriting class. |
   |
FString | Overload this method to report a name for your referencer |
Typedefs
| Name | Description |
|---|---|
| FOnNameChanged | |
| FOnPropertyChanged |