Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > NiagaraEditor > ViewModels > INiagaraParameterPanelViewModel

Light Theme

Dark Theme

INiagaraParameterPanelViewModel

Interface for view models to SiagaraParameterPanel.

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

FSelfRegisteringEditorUndoClient

INiagaraImmutableParameterPanelViewModel

INiagaraParameterPanelViewModel

	FNiagaraParameterDefinitionsToolkitParameterPanelViewModel
	FNiagaraScriptToolkitParameterPanelViewModel
	FNiagaraSystemToolkitParameterPanelViewModel

References

Module	NiagaraEditor
Header	/Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/ViewModels/NiagaraParameterPanelViewModel.h
Include	#include "ViewModels/NiagaraParameterPanelViewModel.h"

Syntax

class INiagaraParameterPanelViewModel : public INiagaraImmutableParameterPanelViewModel

Remarks

Interface for view models to SiagaraParameterPanel.

Variables

	Name	Description
bool	bIsAddingParameter	Re-entrancy guard for adding parameters.
TArray< FNiagar...	CachedViewedItems	Cached maps of parameters sent to SNiagaraParameterPanel, updated whenever GetViewedParameters is called.
FOnGetParameter...	OnGetParametersWithNamespaceModifierRenamePendingDelegate
FOnNotifyParame...	OnNotifyParameterPendingNamespaceModifierRenameDelegate
FOnNotifyParame...	OnNotifyParameterPendingRenameDelegate
FOnParameterPan...	OnParameterPanelViewModelExternalSelectionChangedDelegate
FOnSelectParame...	OnSelectParameterItemByNameDelegate
TSharedPtr< SEd...	ParameterMenuSearchBoxWidget
TSharedPtr< SWi...	ParameterMenuWidget	SharedPtr to menu and searchbox widget retained to prevent the shared ref returned by GetParameterMenu from being invalidated.
TMap< FNiagaraV...	TransientParameterToScriptVarMap	Transient UNiagaraScriptVariables used to pass to new FNiagaraParameterPanelItems when the source FNiagaraVariable is not associated with a UNiagaraScriptVariable in a graph.

Destructors

	Name	Description
	~INiagaraParameterPanelViewModel()	Parameter Panel View Model ///.

Functions

		Name	Description
	void	AddParameter ( FNiagaraVariable NewVariable, const FNiagaraParameterPanelCategor..., const bool bRequestRename )
	bool	CanMakeNewParameterOfType ( const FNiagaraTypeDefinition& InTy... )
	TSharedPtr< ...	CreateContextMenuForItems ( const TArray< FNiagaraParameterPane..., const TSharedPtr< FUICommandList > ... )
	void	DeleteParameter ( const FNiagaraParameterPanelItem& ... )
	void	DuplicateParameter ( const FNiagaraParameterPanelItem It... )
	const TArray...	GetAvailableParameterDefinitions ( bool bSkipSubscribedParameterDefini... )
	const TArray...	GetCachedViewedParameterItems()
	bool	GetCanAddParametersToCategory ( FNiagaraParameterPanelCategory Cate... )
	bool	GetCanDeleteParameterAndToolTip ( const FNiagaraParameterPanelItem& ..., FText& OutCanDeleteParameterToolTi... )
	bool	GetCanDuplicateParameterAndToolTip ( const FNiagaraParameterPanelItem& ..., FText& OutCanDuplicateParameterToo... )
	bool	GetCanHandleDragDropOperation ( TSharedPtr< FDragDropOperation > Dr... )
	bool	GetCanPasteParameterMetaDataAndToolTip ( FText& OutCanPasteToolTip )
	bool	GetCanRenameParameterAndToolTip ( const FNiagaraParameterPanelItem& ..., const FText& NewVariableNameText, bool bCheckEmptyNameText, FText& OutCanRenameParameterToolTi... )
	bool	GetCanSetParameterCustomNamespaceModifierAndToolTip ( const FNiagaraParameterPanelItem& ..., bool bDuplicateParameter, FText& OutCanSetParameterNamespace... )
	bool	GetCanSetParameterNamespaceAndToolTip ( const FNiagaraParameterPanelItem& ..., const FName NewNamespace, FText& OutCanSetParameterNamespace... )
	bool	GetCanSetParameterNamespaceModifierAndToolTip ( const FNiagaraParameterPanelItem& ..., const FName NamespaceModifier, bool bDuplicateParameter, FText& OutCanSetParameterNamespace... )
	bool	GetCanSubscribeParameterToLibraryAndToolTip ( const FNiagaraParameterPanelItem& ..., const bool bSubscribing, FText& OutCanSubscribeParameterToo... )
	void	GetChangeNamespaceModifierSubMenu ( FMenuBuilder& MenuBuilder, bool bDuplicateParameter, FNiagaraParameterPanelItem Item )
	void	GetChangeNamespaceSubMenu ( FMenuBuilder& MenuBuilder, bool bDuplicateParameter, FNiagaraParameterPanelItem Item )
	const TArray...	GetDefaultCategories()
	TArray< FNia...	GetEditableStaticSwitchParameters()
	FOnParameter...	GetOnExternalSelectionChangedDelegate()
	FOnNotifyPar...	GetOnNotifyParameterPendingNamespaceModifierRenameDelegate()
	FOnNotifyPar...	GetOnNotifyParameterPendingRenameDelegate()
	FOnSelectPar...	GetOnSelectParameterItemByNameDelegate()
	FNiagaraPara...	GetParameterContext()
	FMenuAndSear...	GetParameterMenu ( FNiagaraParameterPanelCategory Cate... )
	FOnGetParame...	GetParametersWithNamespaceModifierRenamePendingDelegate()
	TArray< FNia...	GetViewedParameterItems()
	FReply	HandleDragDropOperation ( TSharedPtr< FDragDropOperation > Dr... )
	void	OnParameterItemActivated ( const FNiagaraParameterPanelItem& ... )
	FReply	OnParameterItemsDragged ( const TArray< FNiagaraParameterPane..., const FPointerEvent& MouseEvent )
	void	OnParameterItemSelected ( const FNiagaraParameterPanelItem& ..., ESelectInfo::Type SelectInfo )
	void	PasteParameterMetaData ( const TArray< FNiagaraParameterPane... )
	void	RenameParameter ( const FNiagaraParameterPanelItem& ..., const FName NewName )
	void	SelectParameterItemByName ( const FName ParameterName, const bool bRequestRename )
	void	SetParameterCustomNamespaceModifier ( const FNiagaraParameterPanelItem It..., bool bDuplicateParameter )
	void	SetParameterIsSubscribedToLibrary ( const FNiagaraParameterPanelItem It..., const bool bSubscribed )
	void	SetParameterNamespace ( const FNiagaraParameterPanelItem It..., FNiagaraNamespaceMetadata NewNamesp..., bool bDuplicateParameter )
	void	SetParameterNamespaceModifier ( const FNiagaraParameterPanelItem It..., const FName NewNamespaceModifier, bool bDuplicateParameter )

Overridden from INiagaraImmutableParameterPanelViewModel

	Name	Description
const TArray...	GetEditableGraphsConst()	Returns a list of Graphs that are valid for operations to edit their variables and/or metadata.
const TArray...	GetEditableScriptVariablesWithName ( const FName ParameterName )
const TArray...	GetGraphParameterReferencesForItem ( const FNiagaraParameterPanelItemBas... )

Typedefs

Name	Description
FOnGetParametersWithNamespaceModifierRenamePending	Delegate to get the name array representing parameters pending namespace modification.
FOnGetSelectedParameterNames	Delegate to get the names of all selected parameter items.
FOnNotifyParameterPendingNamespaceModifierRename
FOnNotifyParameterPendingRename	Delegate to signal the ParameterPanel to trigger pending parameter renames.
FOnParameterPanelViewModelExternalSelectionChanged	Delegate to handle responses to external selection changes (e.g. TNiagaraSelection changes.)
FOnSelectParameterItemByName	Delegate to signal the ParameterPanel to select a parameter Item by name.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss