1. Epic GamesDeveloper
  3. FNiagaraHierarchyItemViewModelBase

FNiagaraHierarchyItemViewModelBase

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

Inheritance Hierarchy

References

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

Syntax

struct FNiagaraHierarchyItemViewModelBase :  
    public TSharedFromThis< FNiagaraHierarchyItemViewModelBase >,  
    public FTickableEditorObject

Variables

  Type Name Description
Protected variable bool bIsForHierarchy  
Protected variable bool bRenamePending  
Protected variable TArray< FOnFilterChild > ChildFilters  
Protected variable TArray< TSharedPtr< FNiagaraHierarchyItemViewModelBase > > Children  
Protected variable TArray< TSharedPtr< FNiagaraHierarchyItemViewModelBase > > FilteredChildren  
Protected variable TWeakObjectPtr< UNiagaraHierarchyViewModelBase > HierarchyViewModel  
Protected variable UNiagaraHierarchyItemBase *const ItemBase  
Protected variable FOnChildRequestedDeletion OnChildRequestedDeletionDelegate  
Protected variable FSimpleDelegate OnRequestRenameDelegate  
Protected variable FOnSynced OnSyncedDelegate  
Protected variable TWeakPtr< FNiagaraHierarchyItemViewModelBase > Parent Parent should be valid for all instances of this struct except for root objects

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void  
Public function UNiagaraHierarchyItemBase *  
Public function void

AddChildFilter ( FOnFilterChild InFilterChild
)

  
Public function TSharedPtr< FNiagaraHierarchyItemViewModelBase >  
Public function bool Returns true if deletable
Protected function Virtual bool Should return true if deletable.
Public function FCanPerformActionResults

CanDrag ()

 Should return true if an item should be draggable.
Protected function Virtual FCanPerformActionResults Should return true if draggable.
Public function FCanPerformActionResults

CanDropOn ( TSharedPtr< FNiagaraHierarchyItemViewModelBase > DraggedItem,
EItemDropZone ItemDropZone
)

 Returns true if the given item can be dropped on the given target area.
Protected function Virtual FCanPerformActionResults Should return true if the given drag drop operation is allowed to succeed.
Public function Virtual Const bool Needs to be true in order to allow drag & drop operations to parent items to this item
Public function bool Returns true if renamable
Protected function Virtual bool Should return true if renamable
Public function TSharedRef< class FNiagaraHierarchyDragDropOp > Used to create customized drag drop ops.
Public function void

Delete ()

 Deleting will ask the parent to delete its child
Public function void Deleting will ask the parent to delete its child
Public function Virtual Const bool This function determines whether a hierarchy item that represents that external data should be maintained during data refresh Needs to be implemented if RepresentsExternalData return true.
Public function TSharedRef< FNiagaraHierarchyItemViewModelBase >

DuplicateToThis ( TSharedPtr< FNiagaraHierarchyItemViewModelBase > ItemToDuplicate,
int32 InsertIndex
)

  
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function Const TSharedPtr< FNiagaraHierarchyItemViewModelBase >

FindViewModelForChild ( FNiagaraHierarchyIdentity ChildIdentity,
bool bSearchRecursively
)

  
Public function Const TSharedPtr< FNiagaraHierarchyItemViewModelBase >

FindViewModelForChild ( UNiagaraHierarchyItemBase* Child,
bool bSearchRecursively
)

  
Public function Const const TArray< TSharedPtr< FNiagaraHierarchyItemViewModelBase > > &  
Public function TArray< TSharedPtr< FNiagaraHierarchyItemViewModelBase > > &  
Public function void

GetChildrenViewModelsForType ( TArray< TSharedPtr< ViewModelClass >>& OutChildren,
bool bRecursive
)

  
Public function void

GetChildrenViewModelsForType ( TArray< TSharedPtr< ViewModelChildClass >>& OutChildren,
bool bRecursive
)

  
Public function Const const T *

GetData ()

  
Public function Const const UNiagaraHierarchyItemBase *

GetData ()

  
Public function Virtual UObject * The UObject we display in the details panel when this item is selected.
Public function Const UNiagaraHierarchyItemBase *  
Public function Const T *  
Public function Const const TArray< TSharedPtr< FNiagaraHierarchyItemViewModelBase > > &  
Public function Const int32 Returns the hierarchy depth via number of parents above.
Public function Const TWeakObjectPtr< UNiagaraHierarchyViewModelBase >  
Public function FSimpleDelegate &  
Public function FOnSynced &  
Public function TWeakPtr< FNiagaraHierarchyItemViewModelBase >  
Public function Virtual Const TArray< FString >  
Public function Const const UNiagaraHierarchySection * Determines the section this item belongs to.
Protected function Virtual Const const UNiagaraHierarchySection * Can be overridden to support custom sections.
Public function bool

HasParent ( TSharedPtr< FNiagaraHierarchyItemViewModelBase > ParentCandidate,
bool bRecursive
)

  
Public function Virtual void Can be implemented for additional logic that the constructor isn't valid for.
Public function Virtual FCanPerformActionResults Should return true if properties are supposed to be editable & needs to be true if typical operations should work on it (renaming, dragging, deleting etc.)
Public function Const bool  
Public function TOptional< EItemDropZone >

OnCanRowAcceptDrop ( const FDragDropEvent& DragDropEvent,
EItemDropZone ItemDropZone,
TSharedPtr< FNiagaraHierarchyItemViewModelBase > Item
)

 Returns a set result if the item can accept a drop either above/onto/below the item.
Public function FOnChildRequestedDeletion &  
Public function FReply

OnDragDetected ( const FGeometry& Geometry,
const FPointerEvent& PointerEvent,
bool bIsSource
)

  
Public function void

OnDroppedOn ( TSharedPtr< FNiagaraHierarchyItemViewModelBase > DroppedItem,
EItemDropZone ItemDropZone
)

 Gets executed when an item was dropped on this.
Protected function Virtual void Override this to handle drop-on logic.
Public function Virtual FReply

OnDroppedOnRow ( const FDragDropEvent& DragDropEvent,
EItemDropZone ItemDropZone,
TSharedPtr< FNiagaraHierarchyItemViewModelBase > Item
)

  
Public function void

OnRowDragLeave ( const FDragDropEvent& DragDropEvent
)

  
Public function Virtual void Override this to register dynamic context menu entries when right clicking a hierarchy item
Public function void  
Public function void

Rename ( FName NewName
)

  
Protected function Virtual void

RenameInternal ( FName NewName
)

  
Public function TSharedRef< FNiagaraHierarchyItemViewModelBase >

ReparentToThis ( TSharedPtr< FNiagaraHierarchyItemViewModelBase > ItemToMove,
int32 InsertIndex
)

  
Public function Virtual Const bool For data cleanup that represents external data, this needs to return true in order for live cleanup to work.
Public function void  
Public function void  
Public function void  
Public function Virtual Const FString  
Public function Const FText  

Overridden from FTickableObjectBase

  Type Name Description
Public function Virtual Const TStatId Return the stat id to use for this tickable
Public function Virtual void

Tick ( float DeltaTime
)

 Pure virtual that must be overloaded by the inheriting class.

Classes

  Type Name Description
Public struct FCanPerformActionResults    

Typedefs

Name Description
FOnChildRequestedDeletion  
FOnFilterChild  
FOnSynced  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page