1. Epic GamesDeveloper
  3. UNiagaraStackEntry

UNiagaraStackEntry

API > API/Plugins > API/Plugins/NiagaraEditor

   
Name UNiagaraStackEntry
Type class
Header File /Engine/Plugins/FX/Niagara/Source/NiagaraEditor/Public/ViewModels/Stack/NiagaraStackEntry.h
Include Path #include "ViewModels/Stack/NiagaraStackEntry.h"

Syntax

UCLASS (MinimalAPI)  
class UNiagaraStackEntry : public UObject

Inheritance Hierarchy

Derived Classes

UNiagaraStackEntry derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UNiagaraStackEntry()

   ViewModels/Stack/NiagaraStackEntry.h  

Structs

Name Remarks
FCollectedIssueData  
FCollectedUsageData  
FDropRequest  
FDropRequestResponse  
FExecutionCategoryNames  
FExecutionSubcategoryNames  
FRequiredEntryData  
FStackIssue  
FStackIssueFix  
FStackSearchItem  

Enums

Public

Name Remarks
EDragOptions  
EDropOptions  
EIconMode  
EStackIssueFixStyle  
EStackRowStyle  

Typedefs

Name Type Remarks Include Path
FOnAlternateDisplayNameChanged TMulticastDelegate_NoParams< void >   ViewModels/Stack/NiagaraStackEntry.h
FOnDataObjectModified TMulticastDelegate_TwoParams< void, TArray< UObject * >, ENiagaraDataObjectChange >   ViewModels/Stack/NiagaraStackEntry.h
FOnExpansionChanged TMulticastDelegate_NoParams< void >   ViewModels/Stack/NiagaraStackEntry.h
FOnFilterChild TBaseDelegate_OneParam< bool, const UNiagaraStackEntry & >   ViewModels/Stack/NiagaraStackEntry.h
FOnRequestDrop TBaseDelegate_TwoParams< TOptional< FDropRequestResponse >, const UNiagaraStackEntry &, const FDropRequest & >   ViewModels/Stack/NiagaraStackEntry.h
FOnRequestFullRefresh TMulticastDelegate_NoParams< void >   ViewModels/Stack/NiagaraStackEntry.h
FOnRequestFullRefreshDeferred TMulticastDelegate_NoParams< void >   ViewModels/Stack/NiagaraStackEntry.h
FOnStructureChanged TMulticastDelegate_OneParam< void, ENiagaraStructureChangedFlags >   ViewModels/Stack/NiagaraStackEntry.h
FStackIssueFixDelegate TBaseDelegate_NoParams< void >   ViewModels/Stack/NiagaraStackEntry.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AlternateDisplayName TOptional< FText >   ViewModels/Stack/NiagaraStackEntry.h  
AlternateDisplayNameChangedDelegate FOnAlternateDisplayNameChanged   ViewModels/Stack/NiagaraStackEntry.h  
bFilterChildrenPending bool   ViewModels/Stack/NiagaraStackEntry.h  
bHasBaseEmitterCache TOptional< bool >   ViewModels/Stack/NiagaraStackEntry.h  
bIsExpandedCache TOptional< bool >   ViewModels/Stack/NiagaraStackEntry.h  
bIsExpandedInOverviewCache TOptional< bool >   ViewModels/Stack/NiagaraStackEntry.h  
bIsFinalized bool   ViewModels/Stack/NiagaraStackEntry.h  
bIsSearchResult bool   ViewModels/Stack/NiagaraStackEntry.h  
bOwnerIsEnabled bool   ViewModels/Stack/NiagaraStackEntry.h  
CachedCollectedIssueData TOptional< FCollectedIssueData >   ViewModels/Stack/NiagaraStackEntry.h  
ChildFilters TArray< FOnFilterChild >   ViewModels/Stack/NiagaraStackEntry.h  
Children TArray< TObjectPtr< UNiagaraStackEntry > >   ViewModels/Stack/NiagaraStackEntry.h  
DataObjectModifiedDelegate FOnDataObjectModified   ViewModels/Stack/NiagaraStackEntry.h  
EmitterViewModel TWeakPtr< FNiagaraEmitterViewModel >   ViewModels/Stack/NiagaraStackEntry.h  
ErrorChildren TArray< TObjectPtr< UNiagaraStackErrorItem > >   ViewModels/Stack/NiagaraStackEntry.h  
ExecutionCategoryName FName   ViewModels/Stack/NiagaraStackEntry.h  
ExecutionSubcategoryName FName   ViewModels/Stack/NiagaraStackEntry.h  
ExpansionChangedDelegate FOnExpansionChanged   ViewModels/Stack/NiagaraStackEntry.h  
ExpansionInOverviewChangedDelegate FOnExpansionChanged   ViewModels/Stack/NiagaraStackEntry.h  
ExternalStackIssues TArray< FStackIssue >   ViewModels/Stack/NiagaraStackEntry.h  
FilteredChildren TArray< UNiagaraStackEntry * >   ViewModels/Stack/NiagaraStackEntry.h  
IndentLevel int32   ViewModels/Stack/NiagaraStackEntry.h  
OnRequestCanDropDelegate FOnRequestDrop   ViewModels/Stack/NiagaraStackEntry.h  
OnRequestDropDelegate FOnRequestDrop   ViewModels/Stack/NiagaraStackEntry.h  
RequestFullRefreshDeferredDelegate FOnRequestFullRefresh   ViewModels/Stack/NiagaraStackEntry.h  
RequestFullRefreshDelegate FOnRequestFullRefresh   ViewModels/Stack/NiagaraStackEntry.h  
StackEditorData TObjectPtr< UNiagaraStackEditorData >   ViewModels/Stack/NiagaraStackEntry.h  
StackEditorDataKey FString   ViewModels/Stack/NiagaraStackEntry.h  
StackIssues TArray< FStackIssue >   ViewModels/Stack/NiagaraStackEntry.h  
StackNote TObjectPtr< UNiagaraStackNote >   ViewModels/Stack/NiagaraStackEntry.h  
StructureChangedDelegate FOnStructureChanged   ViewModels/Stack/NiagaraStackEntry.h  
SystemViewModel TWeakPtr< FNiagaraSystemViewModel >   ViewModels/Stack/NiagaraStackEntry.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FDelegateHandle AddChildFilter ( FOnFilterChild ChildFilter
)

   ViewModels/Stack/NiagaraStackEntry.h  

void AddExternalIssue ( EStackIssueSeverity Severity,
const FText& SummaryText,
const FText& Description,
bool bCanBeDismissed
)

   ViewModels/Stack/NiagaraStackEntry.h  

void AddStackNote()

   ViewModels/Stack/NiagaraStackEntry.h  

void AddValidationIssue ( EStackIssueSeverity Severity,
const FText& SummaryText,
const FText& Description,
bool bCanBeDismissed,
const TArray< FNiagaraValidationFix >& Fixes,
const TArray< FNiagaraValidationFix >& Links
)

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool CanDrag()

   ViewModels/Stack/NiagaraStackEntry.h  

TOptional< FDropRequestResponse > CanDrop ( const FDropRequest& DropRequest
)

   ViewModels/Stack/NiagaraStackEntry.h  

void ClearExternalIssues()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual void Copy ( UNiagaraClipboardContent* ClipboardContent
) const

   ViewModels/Stack/NiagaraStackEntry.h  

virtual void CopyForCut ( UNiagaraClipboardContent* ClipboardContent
) const

   ViewModels/Stack/NiagaraStackEntry.h  

void CopyStackNote()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual void Delete()

   ViewModels/Stack/NiagaraStackEntry.h  

void DeleteStackNoteData()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual FHierarchyElementIdentity DetermineSummaryIdentity()

   ViewModels/Stack/NiagaraStackEntry.h  

TOptional< FDropRequestResponse > Drop ( const FDropRequest& DropRequest
)

   ViewModels/Stack/NiagaraStackEntry.h  

bool ExistsInParentEmitterSummary()

   ViewModels/Stack/NiagaraStackEntry.h  

void Finalize()

   ViewModels/Stack/NiagaraStackEntry.h  

const TArray< UNiagaraStackEntry * > & GetAllChildrenWithIssues()

   ViewModels/Stack/NiagaraStackEntry.h  

TOptional< FText > GetAlternateDisplayName()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool GetCanExpand()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool GetCanExpandInOverview()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual const FCollectedUsageData & GetCollectedUsageData()

   ViewModels/Stack/NiagaraStackEntry.h  

void GetCustomFilteredChildren ( TArray< UNiagaraStackEntry* >& OutFilteredChildren,
const TArray< FOnFilterChild >& ChildFilters
) const

   ViewModels/Stack/NiagaraStackEntry.h  

void GetCustomFilteredChildrenOfType ( TArray< T* >& OutFilteredChildrenOfType,
const TArray< FOnFilterChild >& CustomChildFilters
) const

   ViewModels/Stack/NiagaraStackEntry.h  

virtual TSharedPtr< IToolTip > GetCustomTooltipWidget()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual FText GetCutTransactionText()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual FText GetDeleteTransactionText()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual UObject * GetDisplayedObject()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual FText GetDisplayName()

   ViewModels/Stack/NiagaraStackEntry.h  

TSharedPtr< FNiagaraEmitterViewModel > GetEmitterViewModel()

   ViewModels/Stack/NiagaraStackEntry.h  

FName GetExecutionCategoryName()

   ViewModels/Stack/NiagaraStackEntry.h  

FName GetExecutionSubcategoryName()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual UObject * GetExternalAsset()

   ViewModels/Stack/NiagaraStackEntry.h  

void GetFilteredChildren ( TArray< UNiagaraStackEntry* >& OutFilteredChildren
) const

   ViewModels/Stack/NiagaraStackEntry.h  

void GetFilteredChildrenOfType ( TArray< T* >& OutFilteredChildrenOfType,
bool bRecursive
) const

   ViewModels/Stack/NiagaraStackEntry.h  

void GetFilteredChildrenOfTypes ( TArray< UNiagaraStackEntry* >& OutFilteredChildren,
const TSet< UClass* >& AllowedClasses,
bool bRecursive
) const

   ViewModels/Stack/NiagaraStackEntry.h  

virtual const FSlateBrush * GetIconBrush()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual FText GetIconText()

   ViewModels/Stack/NiagaraStackEntry.h  

int32 GetIndentLevel()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual FText GetInheritanceMessage()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool GetIsEnabled()

   ViewModels/Stack/NiagaraStackEntry.h  

bool GetIsEnabledAndOwnerIsEnabled()

   ViewModels/Stack/NiagaraStackEntry.h  

bool GetIsExpanded()

   ViewModels/Stack/NiagaraStackEntry.h  

bool GetIsExpandedInOverview()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool GetIsInherited()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool GetIsRenamePending()

 Gets whether this entry has a rename pending. ViewModels/Stack/NiagaraStackEntry.h  

const bool GetIsSearchResult()

   ViewModels/Stack/NiagaraStackEntry.h  

const TArray< FStackIssue > & GetIssues()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual EStackIssueSeverity GetIssueSeverity()

   ViewModels/Stack/NiagaraStackEntry.h  

bool GetOwnerIsEnabled()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual FText GetPasteTransactionText ( const UNiagaraClipboardContent* ClipboardContent
) const

   ViewModels/Stack/NiagaraStackEntry.h  

void GetRecursiveUsages ( bool& bRead,
bool& bWrite
) const

   ViewModels/Stack/NiagaraStackEntry.h  

virtual void GetSearchItems ( TArray< FStackSearchItem >& SearchItems
) const

   ViewModels/Stack/NiagaraStackEntry.h  

virtual FGuid GetSelectionId()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool GetShouldShowInOverview()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool GetShouldShowInStack()

   ViewModels/Stack/NiagaraStackEntry.h  

UNiagaraStackEditorData & GetStackEditorData()

   ViewModels/Stack/NiagaraStackEntry.h  

FString GetStackEditorDataKey()

   ViewModels/Stack/NiagaraStackEntry.h  

UNiagaraStackNote * GetStackNote()

   ViewModels/Stack/NiagaraStackEntry.h  

FNiagaraStackNoteData GetStackNoteData()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual EStackRowStyle GetStackRowStyle()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual EIconMode GetSupportedIconMode()

   ViewModels/Stack/NiagaraStackEntry.h  

TSharedRef< FNiagaraSystemViewModel > GetSystemViewModel()

   ViewModels/Stack/NiagaraStackEntry.h  

TSharedPtr< FNiagaraSystemViewModel > GetSystemViewModelPtr()

 Same as GetSystemViewModel but can return a nullptr. ViewModels/Stack/NiagaraStackEntry.h  

virtual FText GetTooltipText()

   ViewModels/Stack/NiagaraStackEntry.h  

int32 GetTotalNumberOfErrorIssues()

   ViewModels/Stack/NiagaraStackEntry.h  

int32 GetTotalNumberOfInfoIssues()

   ViewModels/Stack/NiagaraStackEntry.h  

int32 GetTotalNumberOfWarningIssues()

   ViewModels/Stack/NiagaraStackEntry.h  

void GetUnfilteredChildren ( TArray< UNiagaraStackEntry* >& OutUnfilteredChildren
) const

   ViewModels/Stack/NiagaraStackEntry.h  

void GetUnfilteredChildrenOfType ( TArray< T* >& OutUnfilteredChildrenOfType,
bool bRecursive
) const

   ViewModels/Stack/NiagaraStackEntry.h  

bool HasBaseEmitter()

   ViewModels/Stack/NiagaraStackEntry.h  

bool HasIssuesOrAnyChildHasIssues()

   ViewModels/Stack/NiagaraStackEntry.h  

bool HasStackNoteData()

   ViewModels/Stack/NiagaraStackEntry.h  

bool HasUsagesOrAnyChildHasUsages()

   ViewModels/Stack/NiagaraStackEntry.h  

void Initialize ( FRequiredEntryData InRequiredEntryData,
FString InStackEditorDataKey
)

   ViewModels/Stack/NiagaraStackEntry.h  

virtual void InvalidateCollectedUsage()

   ViewModels/Stack/NiagaraStackEntry.h  

bool IsAnyChildInSummaryView ( bool bRecursive
) const

   ViewModels/Stack/NiagaraStackEntry.h  

bool IsAnyParentInSummaryView()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool IsExpandedByDefault()

   ViewModels/Stack/NiagaraStackEntry.h  

bool IsFinalized()

   ViewModels/Stack/NiagaraStackEntry.h  

bool IsInSummaryView()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool IsSemanticChild()

 Returns whether or not this entry should be treated as a child of a previous sibling for layout purposes. ViewModels/Stack/NiagaraStackEntry.h  

virtual bool KeepExpanderIndentation()

 By default, we hide the expander if an stack entry can't be expanded. ViewModels/Stack/NiagaraStackEntry.h  

FOnAlternateDisplayNameChanged & OnAlternateDisplayNameChanged()

   ViewModels/Stack/NiagaraStackEntry.h  

FOnDataObjectModified & OnDataObjectModified()

   ViewModels/Stack/NiagaraStackEntry.h  

FOnExpansionChanged & OnExpansionChanged()

   ViewModels/Stack/NiagaraStackEntry.h  

FOnExpansionChanged & OnExpansionInOverviewChanged()

   ViewModels/Stack/NiagaraStackEntry.h  

FSimpleDelegate & OnPulseRequested()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual void OnRenamed ( FText NewName
)

 Handler for when a rename is committed for this stack entry. ViewModels/Stack/NiagaraStackEntry.h  

FOnRequestFullRefresh & OnRequestFullRefresh()

   ViewModels/Stack/NiagaraStackEntry.h  

FOnRequestFullRefresh & OnRequestFullRefreshDeferred ()

   ViewModels/Stack/NiagaraStackEntry.h  

const FOnRequestFullRefresh & OnRequestFullRefreshDeferred ()

   ViewModels/Stack/NiagaraStackEntry.h  

FOnStructureChanged & OnStructureChanged()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual void Paste ( const UNiagaraClipboardContent* ClipboardContent,
FText& OutPasteWarning
)

   ViewModels/Stack/NiagaraStackEntry.h  

void PasteStackNote()

   ViewModels/Stack/NiagaraStackEntry.h  

void RefreshChildren ()

 Recursively refreshes the children for the current stack entry. ViewModels/Stack/NiagaraStackEntry.h  
Invalidates the cached filtered children so that the filters will be run the next time that GetFilteredChildren is called. ViewModels/Stack/NiagaraStackEntry.h  

void RemoveChildFilter ( FDelegateHandle FilterHandle
)

   ViewModels/Stack/NiagaraStackEntry.h  

virtual void RemoveForCut()

   ViewModels/Stack/NiagaraStackEntry.h  

void RequestPulse()

   ViewModels/Stack/NiagaraStackEntry.h  

void SetIsExpanded ( bool bInExpanded
)

   ViewModels/Stack/NiagaraStackEntry.h  

void SetIsExpanded_Recursive ( bool bInExpanded
)

   ViewModels/Stack/NiagaraStackEntry.h  

void SetIsExpandedInOverview ( bool bInExpanded
)

   ViewModels/Stack/NiagaraStackEntry.h  

virtual void SetIsRenamePending ( bool bIsRenamePending
)

 Sets whether this entry has a rename pending. ViewModels/Stack/NiagaraStackEntry.h  

void SetIsSearchResult ( bool bInIsSearchResult
)

   ViewModels/Stack/NiagaraStackEntry.h  

void SetOnRequestCanDrop ( FOnRequestDrop InOnRequestCanDrop
)

   ViewModels/Stack/NiagaraStackEntry.h  

void SetOnRequestDrop ( FOnRequestDrop InOnRequestCanDrop
)

   ViewModels/Stack/NiagaraStackEntry.h  

void SetStackNoteData ( FNiagaraStackNoteData InStackNoteData
)

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool SupportsCopy()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool SupportsCut()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool SupportsDelete()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool SupportsInheritance()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool SupportsPaste()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool SupportsRename()

 Returns whether or not this entry can be renamed. ViewModels/Stack/NiagaraStackEntry.h  

virtual bool SupportsStackNotes ()

 Generally, all stack items with a valid stack key would support the note feature. ViewModels/Stack/NiagaraStackEntry.h  

virtual bool SupportsSummaryView()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool TestCanCopyWithMessage ( FText& OutMessage
) const

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool TestCanCutWithMessage ( FText& OutMessage
) const

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool TestCanDeleteWithMessage ( FText& OutCanDeleteMessage
) const

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool TestCanPasteWithMessage ( const UNiagaraClipboardContent* ClipboardContent,
FText& OutMessage
) const

   ViewModels/Stack/NiagaraStackEntry.h  

void ToggleStackNoteInlineDisplay()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual bool UsesCustomTooltipWidget()

   ViewModels/Stack/NiagaraStackEntry.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual TOptional< FDropRequestResponse > CanDropInternal ( const FDropRequest& DropRequest
)

   ViewModels/Stack/NiagaraStackEntry.h  

virtual TOptional< FDropRequestResponse > ChildRequestCanDropInternal ( const UNiagaraStackEntry& TargetChild,
const FDropRequest& DropRequest
)

   ViewModels/Stack/NiagaraStackEntry.h  

virtual TOptional< FDropRequestResponse > ChildRequestDropInternal ( const UNiagaraStackEntry& TargetChild,
const FDropRequest& DropRequest
)

   ViewModels/Stack/NiagaraStackEntry.h  

virtual void ChildStructureChangedInternal()

   ViewModels/Stack/NiagaraStackEntry.h  

FRequiredEntryData CreateDefaultChildRequiredData()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual TOptional< FDropRequestResponse > DropInternal ( const FDropRequest& DropRequest
)

   ViewModels/Stack/NiagaraStackEntry.h  

virtual void FinalizeInternal()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual int32 GetChildIndentLevel()

   ViewModels/Stack/NiagaraStackEntry.h  

bool IsSystemViewModelValid()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual void PostRefreshChildrenInternal()

   ViewModels/Stack/NiagaraStackEntry.h  

virtual void RefreshChildrenInternal ( const TArray< UNiagaraStackEntry* >& CurrentChildren,
TArray< UNiagaraStackEntry* >& NewChildren,
TArray< FStackIssue >& NewIssues
)

   ViewModels/Stack/NiagaraStackEntry.h  

void SetIndentLevelOverride ( int32 IndentLevelOverride
)

   ViewModels/Stack/NiagaraStackEntry.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   ViewModels/Stack/NiagaraStackEntry.h  

Static

Name Remarks Include Path Unreal Specifiers

static ChildType * FindCurrentChildOfType ( const TArray< UNiagaraStackEntry* >& CurrentChildren
)

   ViewModels/Stack/NiagaraStackEntry.h  

static ChildType * FindCurrentChildOfTypeByPredicate ( const TArray< UNiagaraStackEntry* >& CurrentChildren,
PredicateType Predicate
)

   ViewModels/Stack/NiagaraStackEntry.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page