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 > API/Plugins/AvalancheOutliner/Item

Inheritance Hierarchy

References

   
Module AvalancheOutliner
Header /Engine/Plugins/Experimental/Avalanche/Source/AvalancheOutliner/Public/Item/IAvaOutlinerItem.h
Include #include "Item/IAvaOutlinerItem.h"

Syntax

class IAvaOutlinerItem :  
    public IAvaTypeCastable ,  
    public TSharedFromThis< IAvaOutlinerItem >

Remarks

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.

Functions

  Type Name Description
Public function FReply

AcceptDrop ( const FDragDropEvent& InDragDropEvent,
EItemDropZone InDropZone
)

 Processes the Drag and Drop Event for this Item
Public function bool

AddChild ( const FAvaOutlinerAddItemParams& InAddItemParams
)

 Adds another Child under this Item if such Item is supported.
Public function void  
Public function TOptional< EItemDropZone >

CanAcceptDrop ( const FDragDropEvent& InDragDropEvent,
EItemDropZone InDropZone
)

 Determines if and where the incoming Drag Drop Event can be processed by this item
Public function Const bool

CanAddChild ( const FAvaOutlinerItemPtr& InChild
)

 Determines whether the given Child is supported and can be added under this Item
Public function Const bool Whether the Item is able to expand when AutoExpand functionality is enabled
Public function Const bool 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.
Public function Const bool Whether this Item can be deleted or not
Public function Const bool

CanLock ()

 Whether an Item can be Locked in any kind. E.g. Actors can be location-locked
Public function Const bool Whether a change in Parent Visibility should also affect this Item's Visibility
Public function Const bool Whether this Item can be renamed or not
Public function bool

Delete ()

 The implementation to delete the item
Public function void

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

 Figures out the Children of this Item.
Public function Virtual Const TArray< FAvaOutlinerItemPtr >

FindPath ( const TArray< FAvaOutlinerItemPtr >& Items
)

 Tries to Find the First Path of Descendants (not including self) that lead to a given Item in the Set.
Public function void

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

  
Public function 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)
Public function Virtual Const FAvaOutlinerItemPtr

GetChildAt ( IndexType Index
)

 Gets the Child Item at the given Index.
Public function Virtual Const IndexType

GetChildIndex ( const FAvaOutlinerItemPtr& ChildItem
)

 Gets the Index that the given Child Item is at.
Public function Const const TArray< FAvaOutlinerItemPtr > & Gets the current Child Items of this Item
Public function TArray< FAvaOutlinerItemPtr > & Gets the current Child Items of this Item
Public function Const FText Gets the Class/Type of this Item (e.g. for Items that represent UObjects, it will be the UObject class)
Public function Const TOptional< FAvaOutlinerColorPair >

GetColor ( bool bRecurse
)

 Returns the Item's Color Name and Color (either inherited if bRecurse is true, or explicit if false)
Public function Const FText Gets the Display Name Text of the Item
Public function Const EAvaOutlinerItemFlags  
Public function Const FSlateIcon

GetIcon ()

  
Public function Const const FSlateBrush *  
Public function Const FText  
Public function Const FLinearColor Gets the Brush Color to use for the Item in the Outliner (e.g. Components should be grayed out a bit)
Public function Const FAvaOutlinerItemId Gets the Id of this Item
Public function 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)
Public function Const int32 Returns the item's height in tree, Root Item should return 0 as it has no Parent
Public function Const TSharedRef< IAvaOutliner > Gets the Outliner that owns this Item
Public function Const FAvaOutlinerItemPtr Gets the Parent of this Item.
Public function Const EAvaOutlinerItemViewMode

GetSupportedViewModes ( const FAvaOutlinerView& InOutlinerView
)

 Gets the View Modes that this Item Supports
Public function Virtual Const TArray< FName >

GetTags ()

 Gets the Tags found for this Item (e.g. for Actors, actor tags and for Components Component Tags)
Public function Const bool Whether this Item is currently visible or not for the Given Type
Public function Const bool  
Public function Const bool  
Public function Const bool Returns whether this Item (and what it represents) should be allowed to be registered in Outliner
Public function Const bool Whether Ignoring Pending Kill.
Public function Const bool Determines whether the Item properties are in a valid state
Public function Const bool Whether the Item is currently Locked
Public function Virtual Const bool Whether the Item can be selected in Outliner at all
Public function Virtual Const bool

IsSelected ( const FAvaOutlinerScopedSelection& InSelection
)

 Determines whether the given Item is selected in the given Scoped Selection
Public function Const bool Determines whether this item can be sorted by the Outliner or not.
Public function Virtual Const bool

IsViewModeSupported ( EAvaOutlinerItemViewMode InViewMode,
const FAvaOutlinerView& InOutlinerView
)

 Whether this Item should be visualized in the given View Mode, for the given Outliner View
Public function FOnExpansionChanged & Called when Expansion state (Expanded/Collapsed) has been changed
Public function Virtual void Called when the Item has been registered into the Outliner
Public function Virtual void

OnItemSelectionChanged ( bool bInIsSelected
)

 Called when the Item been selected/deselected from the Tree View
Public function Virtual void Called when the Item has been unregistered from the Outliner
Public function Virtual void

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

 Called when objects have been replaced on the Engine side.
Public function FOnRenameAction & Broadcasts whenever a rename action takes place from a given view (e.g. when pressing "F2" to rename, or committing the rename text)
Public function Virtual void

OnVisibilityChanged ( EAvaOutlinerVisibilityType VisibilityType,
bool bNewVisibility
)

 Called when the Visibility on Item has been changed on the Outliner side
Public function void Refreshes what the Parent and Children are of this Item. (not recursive!)
Public function bool

RemoveChild ( const FAvaOutlinerRemoveItemParams& InRemoveItemParams
)

 Removes the given child from this Item if it was ever indeed a child.
Public function void  
Public function bool

Rename ( const FString& InName
)

 The implementation to rename the item (e.g. for AActor it will be the Actor Label that is changed)
Public function Virtual void Resets both the Cached Visible Children and Children (before doing so, sets all child's parents to null)
Public function Virtual Const void Used to signal the Scoped Selection that this Item should be Selected
Public function void  
Public function void

SetLocked ( bool bInIsLocked
)

 Lock/Unlock the Item
Public function void Sets the Parent. Note that the Parent must've already have this instance as a child (check is done)
Public function Const bool Whether this Item supports Visibility for the Given Type
Public function    

Typedefs

Name Description
FOnExpansionChanged Delegate signature for when the Item Expansion Changes const TSharedPtr& - The Outliner View where this Expansion happened bool - Whether the Item is expanded
FOnRenameAction 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
IndexType  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page