1. Epic GamesDeveloper
  3. IAvaOutlinerItem

IAvaOutlinerItem

An Outliner Item is the class that represents a Single Element (i.e. Node) in the Outliner Tree.

API > API/Plugins > API/Plugins/AvalancheOutliner

An Outliner Item is the class that represents a Single Element (i.e. Node) in the Outliner Tree. This can be an Item that represents an Object (e.g. Actor,Component) or a Folder, or something else.

   
Name IAvaOutlinerItem
Type class
Header File /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheOutliner/Public/Item/IAvaOutlinerItem.h
Include Path #include "Item/IAvaOutlinerItem.h"

Syntax

class IAvaOutlinerItem :  
    public IAvaTypeCastable ,  
    public TSharedFromThis< IAvaOutlinerItem >

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Typedefs

Name Type Remarks Include Path
FAvaInherits TAvaInherits< IAvaOutlinerItem, IAvaTypeCastable >   Item/IAvaOutlinerItem.h
FOnExpansionChanged TMulticastDelegate< void(const TSharedPtr< FAvaOutlinerView > &, bool)> Delegate signature for when the Item Expansion Changes const TSharedPtr& - The Outliner View where this Expansion happened bool - Whether the Item is expanded Item/IAvaOutlinerItem.h
FOnRenameAction TMulticastDelegate< void(EAvaOutlinerRenameAction, const TSharedPtr< FAvaOutlinerView > &)> Delegate signature for relaying an Item Rename action EAvaOutlinerRenameAction the type of action being relayed (e.g. request a rename, or notify rename complete, etc) const TSharedPtr& - The Outliner View where the rename action is taking place Item/IAvaOutlinerItem.h
IndexType TArray< IAvaOutlinerItem >::SizeType   Item/IAvaOutlinerItem.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

FReply AcceptDrop ( const FDragDropEvent& InDragDropEvent,
EItemDropZone InDropZone
)

 Processes the Drag and Drop Event for this Item Item/IAvaOutlinerItem.h  

virtual bool AddChild ( const FAvaOutlinerAddItemParams& InAddItemParams
)

 Adds another Child under this Item if such Item is supported. Item/IAvaOutlinerItem.h  

TArray< FAvaOutlinerItemPtr > AddChildren ( const FAvaOutlinerAddItemParams& InAddItemParams
)

 Adds the items in the add items struct under this item if such items are supported. Item/IAvaOutlinerItem.h  

void AddFlags ( EAvaOutlinerItemFlags Flag
)

   Item/IAvaOutlinerItem.h  

TOptional< EItemDropZone > CanAcceptDrop ( const FDragDropEvent& InDragDropEvent,
EItemDropZone InDropZone
)

 Determines if and where the incoming Drag Drop Event can be processed by this item Item/IAvaOutlinerItem.h  

bool CanAddChild ( const FAvaOutlinerItemPtr& InChild
) const

 Determines whether the given Child is supported and can be added under this Item Item/IAvaOutlinerItem.h  

bool CanAutoExpand()

 Whether the Item is able to expand when AutoExpand functionality is enabled Item/IAvaOutlinerItem.h  

bool CanBeTopLevel ()

 Whether this Item can be at the Top Level just beneath the Root, or it needs to always be under some other Item E.g. Item/IAvaOutlinerItem.h  

bool CanDelete()

 Whether this Item can be deleted or not Item/IAvaOutlinerItem.h  

bool CanLock()

 Whether an Item can be Locked in any kind. E.g. Actors can be location-locked Item/IAvaOutlinerItem.h  

bool CanReceiveParentVisibilityPropagation()

 Whether a change in Parent Visibility should also affect this Item's Visibility Item/IAvaOutlinerItem.h  

bool CanRename()

 Whether this Item can be renamed or not Item/IAvaOutlinerItem.h  

bool Delete()

 The implementation to delete the item Item/IAvaOutlinerItem.h  

void FindChildren ( TArray< FAvaOutlinerItemPtr >& OutChildren,
bool bRecursive
)

 Figures out the Children of this Item. Item/IAvaOutlinerItem.h  

virtual TArray< FAvaOutlinerItemPtr > FindPath ( const TArray< FAvaOutlinerItemPtr >& Items
) const

 Tries to Find the First Path of Descendants (not including self) that lead to a given Item in the Set. Item/IAvaOutlinerItem.h  

void FindValidChildren ( TArray< FAvaOutlinerItemPtr >& OutChildren,
bool bRecursive
)

   Item/IAvaOutlinerItem.h  

TSharedRef< SWidget > GenerateLabelWidget ( const TSharedRef< SAvaOutlinerTreeRow >& InRow
)

 Function responsible of Generating the Label Widget for this Item (i.e. the column containing the Icon and the Name) Item/IAvaOutlinerItem.h  

virtual FAvaOutlinerItemPtr GetChildAt ( IndexType Index
) const

 Gets the Child Item at the given Index. Item/IAvaOutlinerItem.h  

virtual IndexType GetChildIndex ( const FAvaOutlinerItemPtr& ChildItem
) const

 Gets the Index that the given Child Item is at. Item/IAvaOutlinerItem.h  

const TArray< FAvaOutlinerItemPtr > & GetChildren()

 Gets the current Child Items of this Item Item/IAvaOutlinerItem.h  

TArray< FAvaOutlinerItemPtr > & GetChildrenMutable()

 Gets the current Child Items of this Item Item/IAvaOutlinerItem.h  

FText GetClassName()

 Gets the Class/Type of this Item (e.g. for Items that represent UObjects, it will be the UObject class) Item/IAvaOutlinerItem.h  

TOptional< FAvaOutlinerColorPair > GetColor ( bool bRecurse
) const

 Returns the Item's Color Name and Color (either inherited if bRecurse is true, or explicit if false) Item/IAvaOutlinerItem.h  

FText GetDisplayName()

 Gets the Display Name Text of the Item Item/IAvaOutlinerItem.h  
  Item/IAvaOutlinerItem.h  

FSlateIcon GetIcon()

   Item/IAvaOutlinerItem.h  

const FSlateBrush * GetIconBrush()

   Item/IAvaOutlinerItem.h  

FText GetIconTooltipText()

   Item/IAvaOutlinerItem.h  

FLinearColor GetItemColor()

 Gets the Brush Color to use for the Item in the Outliner (e.g. Components should be grayed out a bit) Item/IAvaOutlinerItem.h  

FAvaOutlinerItemId GetItemId()

 Gets the Id of this Item Item/IAvaOutlinerItem.h  

virtual void GetItemProxies ( TArray< TSharedPtr< FAvaOutlinerItemProxy > >& OutItemProxies
)

 Gets the Item Proxies for this Item (e.g. Component Item that represent Primitives add in a Material Proxy to display) Item/IAvaOutlinerItem.h  

int32 GetItemTreeHeight()

 Returns the item's height in tree, Root Item should return 0 as it has no Parent Item/IAvaOutlinerItem.h  

TSharedRef< IAvaOutliner > GetOwnerOutliner()

 Gets the Outliner that owns this Item Item/IAvaOutlinerItem.h  

FAvaOutlinerItemPtr GetParent ()

 Gets the Parent of this Item. Item/IAvaOutlinerItem.h  

EAvaOutlinerItemViewMode GetSupportedViewModes ( const FAvaOutlinerView& InOutlinerView
) const

 Gets the View Modes that this Item Supports Item/IAvaOutlinerItem.h  

virtual TArray< FName > GetTags()

 Gets the Tags found for this Item (e.g. for Actors, actor tags and for Components Component Tags) Item/IAvaOutlinerItem.h  

bool GetVisibility ( EAvaOutlinerVisibilityType VisibilityType
) const

 Whether this Item is currently visible or not for the Given Type Item/IAvaOutlinerItem.h  

bool HasAllFlags ( EAvaOutlinerItemFlags Flag
) const

   Item/IAvaOutlinerItem.h  

bool HasAnyFlags ( EAvaOutlinerItemFlags Flag
) const

   Item/IAvaOutlinerItem.h  

bool IsAllowedInOutliner()

 Returns whether this Item (and what it represents) should be allowed to be registered in Outliner Item/IAvaOutlinerItem.h  
Whether Ignoring Pending Kill. Item/IAvaOutlinerItem.h  

bool IsItemValid()

 Determines whether the Item properties are in a valid state Item/IAvaOutlinerItem.h  

bool IsLocked()

 Whether the Item is currently Locked Item/IAvaOutlinerItem.h  

virtual bool IsSelectable()

 Whether the Item can be selected in Outliner at all Item/IAvaOutlinerItem.h  

virtual bool IsSelected ( const FAvaOutlinerScopedSelection& InSelection
) const

 Determines whether the given Item is selected in the given Scoped Selection Item/IAvaOutlinerItem.h  

bool IsSortable ()

 Determines whether this item can be sorted by the Outliner or not. Item/IAvaOutlinerItem.h  

virtual bool IsViewModeSupported ( EAvaOutlinerItemViewMode InViewMode,
const FAvaOutlinerView& InOutlinerView
) const

 Whether this Item should be visualized in the given View Mode, for the given Outliner View Item/IAvaOutlinerItem.h  

virtual void OnChildrenAdded ( TConstArrayView< FAvaOutlinerItemPtr > InAddedChildren,
const FAvaOutlinerAddItemParams& InAddItemParams
)

 Called when children have been added to this item Item/IAvaOutlinerItem.h  

FOnExpansionChanged & OnExpansionChanged()

 Called when Expansion state (Expanded/Collapsed) has been changed Item/IAvaOutlinerItem.h  

virtual void OnItemRegistered()

 Called when the Item has been registered into the Outliner Item/IAvaOutlinerItem.h  

virtual void OnItemSelectionChanged ( bool bInIsSelected
)

 Called when the Item been selected/deselected from the Tree View Item/IAvaOutlinerItem.h  

virtual void OnItemUnregistered()

 Called when the Item has been unregistered from the Outliner Item/IAvaOutlinerItem.h  

virtual void OnObjectsReplaced ( const TMap< UObject*, UObject* >& InReplacementMap,
bool bRecursive
)

 Called when objects have been replaced on the Engine side. Item/IAvaOutlinerItem.h  

FOnRenameAction & OnRenameAction()

 Broadcasts whenever a rename action takes place from a given view (e.g. when pressing "F2" to rename, or committing the rename text) Item/IAvaOutlinerItem.h  

virtual void OnVisibilityChanged ( EAvaOutlinerVisibilityType VisibilityType,
bool bNewVisibility
)

 Called when the Visibility on Item has been changed on the Outliner side Item/IAvaOutlinerItem.h  

void RefreshChildren()

 Refreshes what the Parent and Children are of this Item. (not recursive!) Item/IAvaOutlinerItem.h  

bool RemoveChild ( const FAvaOutlinerRemoveItemParams& InRemoveItemParams
)

 Removes the given child from this Item if it was ever indeed a child. Item/IAvaOutlinerItem.h  

void RemoveFlags ( EAvaOutlinerItemFlags Flag
)

   Item/IAvaOutlinerItem.h  

bool Rename ( const FString& InName
)

 The implementation to rename the item (e.g. for AActor it will be the Actor Label that is changed) Item/IAvaOutlinerItem.h  

virtual void ResetChildren()

 Resets both the Cached Visible Children and Children (before doing so, sets all child's parents to null) Item/IAvaOutlinerItem.h  

virtual void Select ( FAvaOutlinerScopedSelection& InSelection
) const

 Used to signal the Scoped Selection that this Item should be Selected Item/IAvaOutlinerItem.h  

void SetFlags ( EAvaOutlinerItemFlags InFlags
)

   Item/IAvaOutlinerItem.h  

void SetLocked ( bool bInIsLocked
)

 Lock/Unlock the Item Item/IAvaOutlinerItem.h  

void SetParent ( FAvaOutlinerItemPtr InParent
)

 Sets the Parent. Note that the Parent must've already have this instance as a child (check is done) Item/IAvaOutlinerItem.h  

bool ShowVisibility ( EAvaOutlinerVisibilityType VisibilityType
) const

 Whether this Item supports Visibility for the Given Type Item/IAvaOutlinerItem.h  

Overridden from IAvaTypeCastable

Name Remarks Include Path Unreal Specifiers

virtual const void * CastTo_Impl ( FAvaTypeId InCastToType
) const

   Item/IAvaOutlinerItem.h  

virtual FAvaTypeId GetTypeId()

   Item/IAvaOutlinerItem.h  

Static

Name Remarks Include Path Unreal Specifiers

static FAvaTypeId GetStaticTypeId()

   Item/IAvaOutlinerItem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page