SNiagaraParameterEditor

Base class for inline parameter editors.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

NiagaraEditor

Header

/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/SNiagaraParameterEditor.h

Include

#include "SNiagaraParameterEditor.h"

Syntax

class SNiagaraParameterEditor : public SCompoundWidget

Remarks

Base class for inline parameter editors. These editors are expected to maintain an internal value which is populated from a parameter struct.

Functions

Name Description

Public function Virtual Const

bool

 

CanChangeContinuously()

Public function

void

 

Construct

(
    const FArguments& InArgs
)

Protected function

void

 

ExecuteOnBeginValueChange()

Executes the OnBeginValueChange delegate

Protected function

void

 

ExecuteOnEndValueChange()

Executes the OnEndValueChange delegate.

Protected function

void

 

ExecuteOnValueChanged()

Executes the OnValueChanged delegate.

Public function Const

EHorizontalA...

 

GetHorizontalAlignment()

Gets the desired horizontal alignment of this parameter editor for it's parent container.

Public function

bool

 

GetIsEditingExclusively()

Gets whether this is currently the exclusive editor of this parameter, meaning that the corresponding details view should not be updated.

Public function Const

const TOptio...

 

GetMaximumDesiredWidth()

Gets an optional maximum desired width for this parameter editor.

Public function Const

const TOptio...

 

GetMinimumDesiredWidth()

Gets an optional minimum desired width for this parameter editor.

Public function Const

EVerticalAli...

 

GetVerticalAlignment()

Gets the desired horizontal alignment of this parameter editor for it's parent container.

Protected function

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.

Public function

void

 

SetOnBeginValueChange

(
    FOnValueChange InOnBeginValueChange
)

Sets the OnBeginValueChange delegate which is run when a continuous internal value change begins.

Public function

void

 

SetOnEndValueChange

(
    FOnValueChange InOnEndValueChange
)

Sets the OnBeginValueChange delegate which is run when a continuous internal value change ends.

Public function

void

 

SetOnValueChanged

(
    FOnValueChange InOnValueChanged
)

Sets the OnValueChanged delegate which is run when the internal value changes.

Public function

void

 

UpdateInternalValueFromStruct

(
    TSharedRef< FStructOnScope > Struct
)

Updates the internal value of the widget from a struct.

Public function

void

 

UpdateStructFromInternalValue

(
    TSharedRef< FStructOnScope > Struct
)

Updates a struct from the internal value of the widget.

Overridden from SWidget

Name Description

Public function Virtual Const

FVector2D

 

ComputeDesiredSize

(
    float LayoutScaleMultiplier
)

Compute the ideal size necessary to display this widget.

Classes

Name

Description

Public struct

FArguments

Typedefs

Name

Description

FOnValueChange

Constants

Name

Description

DefaultInputSize