1. Epic GamesDeveloper
  3. INiagaraParameterPanelViewModel

INiagaraParameterPanelViewModel

Interface for view models to SiagaraParameterPanel.

API > API/Plugins > API/Plugins/NiagaraEditor > API/Plugins/NiagaraEditor/ViewModels

Inheritance Hierarchy

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

  Type Name Description
Protected variable int32 ActiveSectionIndex  
Protected variable bool bIsAddingParameter Re-entrancy guard for adding parameters.
Protected variable TArray< FNiagaraParameterPanelItem > CachedViewedItems Cached maps of parameters sent to SNiagaraParameterPanel, updated whenever GetViewedParameters is called.
Protected variable TWeakPtr< INiagaraParameterPanelViewModel > MainParameterPanelViewModel  
Protected variable FOnGetParametersWithNamespaceModifierRenamePending OnGetParametersWithNamespaceModifierRenamePendingDelegate  
Protected variable FOnInvalidateCachedDependencies OnInvalidateCachedDependenciesDelegate  
Protected variable FOnNotifyParameterPendingNamespaceModifierRename OnNotifyParameterPendingNamespaceModifierRenameDelegate  
Protected variable FOnNotifyParameterPendingRename OnNotifyParameterPendingRenameDelegate  
Protected variable FOnParameterPanelViewModelExternalSelectionChanged OnParameterPanelViewModelExternalSelectionChangedDelegate  
Protected variable FOnSelectParameterItemByName OnSelectParameterItemByNameDelegate  
Protected variable TSharedPtr< SEditableTextBox > ParameterMenuSearchBoxWidget  
Protected variable TSharedPtr< SWidget > ParameterMenuWidget SharedPtr to menu and searchbox widget retained to prevent the shared ref returned by GetParameterMenu from being invalidated.
Protected variable TArray< FSectionDesc > Sections  
Protected variable TMap< FNiagaraVariable, TObjectPtr< UNiagaraScriptVariable > > TransientParameterToScriptVarMap Transient UNiagaraScriptVariables used to pass to new FNiagaraParameterPanelItems when the source FNiagaraVariable is not associated with a UNiagaraScriptVariable in a graph.

Constructors

  Type Name Description
Public function   Parameter Panel View Model ///.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddParameter ( FNiagaraVariable NewVariable,
const FNiagaraParameterPanelCategory Category,
const bool bRequestRename,
const bool bMakeUniqueName
)

  
Public function Virtual bool  
Public function Virtual void  
Public function TSharedPtr< SWidget >  
Public function void

DeleteParameters ( const TArray< FNiagaraParameterPanelItem >& ItemsToDelete
)

  
Public function Virtual void  
Public function void  
Public function Const FText  
Public function Virtual Const bool  
Public function Const const TArray< UNiagaraParameterDefinitions * >

GetAvailableParameterDefinitions ( bool bSkipSubscribedParameterDefinitions
)

  
Public function Const const TArray< FNiagaraParameterPanelItem > &  
Public function Const bool  
Public function Virtual Const bool

GetCanChangeParameterType ( const TArray< FNiagaraParameterPanelItem >& ItemToChange,
FText& OutTooltip
)

  
Public function Const bool  
Public function Virtual Const bool

GetCanDeleteParameterAndToolTip ( const FNiagaraParameterPanelItem& ItemToDelete,
FText& OutCanDeleteParameterToolTip
)

  
Public function Virtual Const bool

GetCanDuplicateParameterAndToolTip ( const TArray< FNiagaraParameterPanelItem >& ItemsToDuplicate,
FText& OutCanDuplicateParameterToolTip
)

  
Public function Const bool  
Public function Virtual bool  
Public function Virtual Const bool

GetCanRenameParameterAndToolTip ( const FNiagaraParameterPanelItem& ItemToRename,
const FText& NewVariableNameText,
bool bCheckEmptyNameText,
FText& OutCanRenameParameterToolTip
)

  
Public function Const bool

GetCanSetParameterCustomNamespaceModifierAndToolTip ( const FNiagaraParameterPanelItem& ItemToModify,
bool bDuplicateParameter,
FText& OutCanSetParameterNamespaceModifierToolTip
)

  
Public function Const bool

GetCanSetParameterNamespaceAndToolTip ( const FNiagaraParameterPanelItem& ItemToModify,
const FName NewNamespace,
FText& OutCanSetParameterNamespaceToolTip
)

  
Public function Const bool

GetCanSetParameterNamespaceModifierAndToolTip ( const FNiagaraParameterPanelItem& ItemToModify,
const FName NamespaceModifier,
bool bDuplicateParameter,
FText& OutCanSetParameterNamespaceModifierToolTip
)

  
Public function Virtual Const bool

GetCanSubscribeParameterToLibraryAndToolTip ( const FNiagaraParameterPanelItem& ItemToModify,
const bool bSubscribing,
FText& OutCanSubscribeParameterToolTip
)

  
Public function Virtual void

GetChangeNamespaceModifierSubMenu ( FMenuBuilder& MenuBuilder,
bool bDuplicateParameter,
FNiagaraParameterPanelItem Item
)

  
Public function Virtual void

GetChangeNamespaceSubMenu ( FMenuBuilder& MenuBuilder,
bool bDuplicateParameter,
FNiagaraParameterPanelItem Item
)

  
Public function Virtual void  
Public function Const const TArray< FNiagaraParameterPanelCategory > &  
Public function Const TArray< FNiagaraVariable >  
Public function Virtual Const bool

GetNamespaceActive ( const FName& InNamespace
)

  
Public function FOnParameterPanelViewModelExternalSelectionChanged &  
Public function FOnInvalidateCachedDependencies &  
Public function FOnNotifyParameterPendingNamespaceModifierRename &  
Public function FOnNotifyParameterPendingRename &  
Public function FOnSelectParameterItemByName &  
Public function Const FNiagaraParameterUtilities::EParameterContext  
Public function FMenuAndSearchBoxWidgets  
Public function FOnGetParametersWithNamespaceModifierRenamePending &  
Public function Virtual Const bool

GetSectionEnabled ( FText Section
)

  
Public function Virtual Const const TArray< FSectionDesc > &  
Public function Virtual Const bool  
Public function Virtual Const FText

GetTooltipForSection ( FText& InSection
)

  
Public function Virtual TSharedPtr< FNiagaraObjectSelection >  
Public function Const TArray< FNiagaraParameterPanelItem >  
Public function FReply  
Protected function Virtual Const bool  
Protected function Const void  
Public function Virtual Const bool  
Protected function Virtual void  
Public function Virtual Const void  
Public function Virtual Const FReply

OnParameterItemsDragged ( const TArray< FNiagaraParameterPanelItem >& DraggedItems,
const FPointerEvent& MouseEvent
)

  
Public function Virtual Const void  
Public function Virtual void  
Public function void

RenameParameter ( const FNiagaraParameterPanelItem& ItemToRename,
const FName NewName
)

  
Public function void

SelectParameterItemByName ( const FName ParameterName,
const bool bRequestRename
)

  
Public function void

SetActiveSection ( FText& InSection
)

  
Public function Virtual void

SetActiveSection ( int32 InSection
)

  
Public function Virtual void  
Public function Virtual void

SetParameterCustomNamespaceModifier ( const FNiagaraParameterPanelItem ItemToModify,
bool bDuplicateParameter
)

  
Public function Virtual void

SetParameterNamespace ( const FNiagaraParameterPanelItem ItemToModify,
FNiagaraNamespaceMetadata NewNamespaceMetaData,
bool bDuplicateParameter
)

  
Public function Virtual void

SetParameterNamespaceModifier ( const FNiagaraParameterPanelItem ItemToModify,
const FName NewNamespaceModifier,
bool bDuplicateParameter
)

  

Overridden from INiagaraImmutableParameterPanelViewModel

  Type Name Description
Public function Const const TArray< UNiagaraGraph * > Returns a list of Graphs that are valid for operations to edit their variables and/or metadata.
Public function Const const TArray< UNiagaraScriptVariable * >

GetEditableScriptVariablesWithName ( const FName ParameterName
)

  
Public function Const const TArray< FNiagaraGraphParameterReference >  
Public function Virtual Const void

RefreshFull ( bool bDoCategoryExpansion
)

 RefreshFull allows for optional category tree expansion/collapse, which can be more expensive.

Classes

  Type Name Description
Public struct FSectionDesc Helper struct for storing information about a section in the parameter panel (if used)  

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.
FOnInvalidateCachedDependencies  
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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page