Navigation
API > API/Plugins > API/Plugins/NiagaraEditor
Base class for inline parameter editors. These editors are expected to maintain an internal value which is populated from a parameter struct.
| Name | SNiagaraParameterEditor |
| Type | class |
| Header File | /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/SNiagaraParameterEditor.h |
| Include Path | #include "SNiagaraParameterEditor.h" |
Syntax
class SNiagaraParameterEditor : public SCompoundWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SNiagaraParameterEditor
- FSlateControlledConstruction → SWidget → SCompoundWidget → SNiagaraParameterEditor
Structs
| Name | Remarks |
|---|---|
| FArguments |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnValueChange | TBaseDelegate_NoParams< void > | SNiagaraParameterEditor.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| DefaultInputSize | const float | SNiagaraParameterEditor.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bContinousChangeActive | bool | SNiagaraParameterEditor.h | ||
| bIsEditingExclusively | bool | Whether this is currently the exclusive editor of this parameter, meaning that the corresponding details view should not be updated. | SNiagaraParameterEditor.h | |
| HorizontalAlignment | EHorizontalAlignment | The desired horizontal alignment of this parameter editor for it's parent container. | SNiagaraParameterEditor.h | |
| MaximumDesiredWidth | TOptional< float > | The maximum desired width of this parameter editor. | SNiagaraParameterEditor.h | |
| MinimumDesiredWidth | TOptional< float > | The minimum desired width of this parameter editor. | SNiagaraParameterEditor.h | |
| OnBeginValueChange | FOnValueChange | A delegate which is executed when a continuous change to the internal value begins. | SNiagaraParameterEditor.h | |
| OnEndValueChange | FOnValueChange | A delegate which is executed when a continuous change to the internal value ends. | SNiagaraParameterEditor.h | |
| OnValueChanged | FOnValueChange | A delegate which is executed when the internal value changes. | SNiagaraParameterEditor.h | |
| VerticalAlignment | EVerticalAlignment | Sets the desired horizontal alignment of this parameter editor for it's parent container. | SNiagaraParameterEditor.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanChangeContinuously() |
SNiagaraParameterEditor.h | ||
void Construct
(
const FArguments& InArgs |
SNiagaraParameterEditor.h | ||
EHorizontalAlignment GetHorizontalAlignment() |
Gets the desired horizontal alignment of this parameter editor for it's parent container. | SNiagaraParameterEditor.h | |
bool GetIsEditingExclusively () |
Gets whether this is currently the exclusive editor of this parameter, meaning that the corresponding details view should not be updated. | SNiagaraParameterEditor.h | |
const TOptional< float > & GetMaximumDesiredWidth() |
Gets an optional maximum desired width for this parameter editor. | SNiagaraParameterEditor.h | |
const TOptional< float > & GetMinimumDesiredWidth() |
Gets an optional minimum desired width for this parameter editor. | SNiagaraParameterEditor.h | |
EVerticalAlignment GetVerticalAlignment() |
Gets the desired horizontal alignment of this parameter editor for it's parent container. | SNiagaraParameterEditor.h | |
void SetMaximumDesiredWidth
(
TOptional< float > InMaximumDesiredWidth |
Sets the maximum desired width for this parameter editor. | SNiagaraParameterEditor.h | |
void SetMinimumDesiredWidth
(
TOptional< float > InMinimumDesiredWidth |
Sets the minimum desired width for this parameter editor. | SNiagaraParameterEditor.h | |
void SetOnBeginValueChange
(
FOnValueChange InOnBeginValueChange |
Sets the OnBeginValueChange delegate which is run when a continuous internal value change begins. | SNiagaraParameterEditor.h | |
void SetOnEndValueChange
(
FOnValueChange InOnEndValueChange |
Sets the OnBeginValueChange delegate which is run when a continuous internal value change ends. | SNiagaraParameterEditor.h | |
void SetOnValueChanged
(
FOnValueChange InOnValueChanged |
Sets the OnValueChanged delegate which is run when the internal value changes. | SNiagaraParameterEditor.h | |
void UpdateInternalValueFromStruct
(
TSharedRef< FStructOnScope > Struct |
Updates the internal value of the widget from a struct. | SNiagaraParameterEditor.h | |
void UpdateStructFromInternalValue
(
TSharedRef< FStructOnScope > Struct |
Updates a struct from the internal value of the widget. | SNiagaraParameterEditor.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FVector2D ComputeDesiredSize
(
float LayoutScaleMultiplier |
SNiagaraParameterEditor.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ExecuteOnBeginValueChange() |
Executes the OnBeginValueChange delegate | SNiagaraParameterEditor.h | |
void ExecuteOnEndValueChange() |
Executes the OnEndValueChange delegate. | SNiagaraParameterEditor.h | |
void ExecuteOnValueChanged() |
Executes the OnValueChanged delegate. | SNiagaraParameterEditor.h | |
void SetIsEditingExclusively
(
bool bInIsEditingExclusively |
Sets whether this is currently the exclusive editor of this parameter, meaning that the corresponding details view should not be updated. | SNiagaraParameterEditor.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedPtr< TNumericUnitTypeInterface< NumericType > > GetTypeInterface
(
EUnit TypeUnit |
SNiagaraParameterEditor.h |