1. Epic GamesDeveloper
  3. SSceneOutliner

SSceneOutliner

Scene Outliner widget

API > API/Editor > API/Editor/SceneOutliner

Scene Outliner widget

   
Name SSceneOutliner
Type class
Header File /Engine/Source/Editor/SceneOutliner/Public/SSceneOutliner.h
Include Path #include "SSceneOutliner.h"

Syntax

class SSceneOutliner :  
    public ISceneOutliner ,  
    public FEditorUndoClient,  
    public FGCObject

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

SSceneOutliner()

 Default constructor - initializes data that is shared between all tree items SSceneOutliner.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~SSceneOutliner()

 SSceneOutliner destructor SSceneOutliner.h  

Structs

Name Remarks
FArguments  

Typedefs

Name Type Remarks Include Path
FParentsExpansionState TMap< FSceneOutlinerTreeItemID, bool > Structure containing information relating to the expansion state of parent items in the tree SSceneOutliner.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bDisableIntermediateSorting uint8 True if the Scene Outliner is currently responding to a level visibility change SSceneOutliner.h  
bForceParentItemsExpanded uint8 True if we are forcing the underlying tree view to automatically expand all parents when searching SSceneOutliner.h  
bFullRefresh uint8 True if the Scene Outliner should do a full refresh. SSceneOutliner.h  
bIsReentrant bool Reentrancy guard SSceneOutliner.h  
bNeedsColumRefresh uint8   SSceneOutliner.h  
bNeedsRefresh uint8 True if the outliner needs to be repopulated at the next appropriate opportunity, usually because our item set has changed in some way. SSceneOutliner.h  
bPendingFocusNextFrame bool True if the search box will take keyboard focus next frame SSceneOutliner.h  
bProcessingFullRefresh uint8 Processing a full refresh until pending items are processed SSceneOutliner.h  
bSelectionDirty uint8 True if the Scene Outliner should refresh selection SSceneOutliner.h  
bShouldCacheColumnVisibility uint8 True if the outliner should cache changes to column visibility into the config SSceneOutliner.h  
bShouldStackHierarchyHeaders bool True if the hierarchy of items is pinned at the top of the outliner SSceneOutliner.h  
bSortDirty bool True if the outliner currently needs to be sorted SSceneOutliner.h  
CacheClipboardContents FString Cache clipboard contents for cut/copy SSceneOutliner.h  
CachedExpansionStateInfo FParentsExpansionState Cached expansion state info SSceneOutliner.h  
CachedIcons TMap< FName, const FSlateBrush * >   SSceneOutliner.h  
CacheFolderMap TMap< FName, FName > Cache folders mapping (old to new) for cut/copy/paste/duplicate SSceneOutliner.h  
CacheFoldersDelete TArray< FFolderTreeItem * > Cache selected folders during edit delete SSceneOutliner.h  
CacheFoldersEdit TArray< FName > Cache folders for cut/copy/paste/duplicate SSceneOutliner.h  
CacheFoldersEditRootObject FFolder::FRootObject CacheFoldersEdit target root object SSceneOutliner.h  
CacheHiddenColumns TSet< FName > Cache which columns are hidden to know what changed SSceneOutliner.h  
CachePasteFolderExistingChildrenMap TMap< FFolder, TArray< FSceneOutlinerTreeItemID > > Maps pre-existing children during paste or duplicate SSceneOutliner.h  
Columns TMap< FName, TSharedPtr< ISceneOutlinerColumn > > Map of columns that are shown on this outliner. SSceneOutliner.h  
CommandList TSharedPtr< FUICommandList > Command list to be processed during the OnKeyDown, extended by derived Mode through BindCommands SSceneOutliner.h  
FilterBar TSharedPtr< SFilterBar< SceneOutliner::FilterBarType > > The FilterBar attached to this outliner to filter down assets further SSceneOutliner.h  
FilterCollection TSharedPtr< TFilterCollection< SceneOutliner::FilterBarType > > The FilterCollection belonging to the Filter Bar SSceneOutliner.h  
Filters TSharedPtr< FSceneOutlinerFilters > A collection of filters used to filter the displayed items and folders in the scene outliner SSceneOutliner.h  
FilterTextBoxWidget TSharedPtr< SFilterSearchBox > Widget containing the filtering text box SSceneOutliner.h  
HeaderRowWidget TSharedPtr< SHeaderRow > The header row of the scene outliner SSceneOutliner.h  
InteractiveFilters TSharedPtr< FSceneOutlinerFilters > A collection of extra filters applied on top of existing Filters to determine if items are interactive or not in the scene outliner SSceneOutliner.h  
NewItemActions TMap< FSceneOutlinerTreeItemID, uint8 > Map of actions to apply to new tree items SSceneOutliner.h  
OnContextMenuOpening FOnContextMenuOpening Context menu opening delegate provided by the client SSceneOutliner.h  
OnDoubleClickOnTreeEvent SceneOutliner::FTreeItemPtrEvent   SSceneOutliner.h  
OnItemSelectionChanged SceneOutliner::FOnItemSelectionChanged   SSceneOutliner.h  
OutlinerIdentifier FName Identifier for this outliner (Set through FSceneOutlinerInitializationOptions) SSceneOutliner.h  
OutlinerTreeView TSharedPtr< SSceneOutlinerTreeView > Our tree view SSceneOutliner.h  
PendingFoldersSelect TArray< FFolder > Folders pending selection SSceneOutliner.h  
PendingOperations TArray< SceneOutliner::FPendingTreeOperation > List of pending operations to be applied to the tree SSceneOutliner.h  
PendingRenameItem TWeakPtr< ISceneOutlinerTreeItem > The tree item that is currently pending a rename SSceneOutliner.h  
PendingTreeItemMap FSceneOutlinerTreeItemMap Pending tree items that are yet to be added the tree SSceneOutliner.h  
PendingTreeItemMap_Removal FSceneOutlinerTreeItemMap Pending tree items that are yet to be removed from the tree SSceneOutliner.h  
PrimaryColumnName FName The primary column for this outliner, used to determine initial sorting and where the hierarchy arrows appear SSceneOutliner.h  
RootTreeItems TArray< FSceneOutlinerTreeItemPtr > Root level tree items SSceneOutliner.h  
SearchBoxFilter TSharedPtr< SceneOutliner::TreeItemTextFilter > The TextFilter attached to the SearchBox widget of the Scene Outliner SSceneOutliner.h  
SharedData TSharedPtr< FSharedSceneOutlinerData >   SSceneOutliner.h  
SortByColumn FName Specify which column to sort with SSceneOutliner.h  
SortMode EColumnSortMode::Type Currently selected sorting mode SSceneOutliner.h  
SortOutlinerTimer float Functions relating to sorting Timer for PIE/SIE mode to sort the outliner. SSceneOutliner.h  
SourceControlHandler TSharedPtr< FSceneOutlinerSCCHandler >   SSceneOutliner.h  
TreeItemMap FSceneOutlinerTreeItemMap A map of all items we have in the tree SSceneOutliner.h  
UIRefreshDelay float The delay (in seconds) before a UI sort and refresh is executed after being requested. SSceneOutliner.h  
ViewOptionsComboButton TSharedPtr< SComboButton > The button that displays view options SSceneOutliner.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddFolderToSelection ( const FName& FolderName
)

 Add a folder to the selection of the scene outliner SSceneOutliner.h  

void AddMoveToFolderOutliner ( UToolMenu* Menu
) const

   SSceneOutliner.h  

void AddSourceControlMenuOptions ( UToolMenu* Menu
)

   SSceneOutliner.h  

void AddToSelection ( const FSceneOutlinerTreeItemPtr& InItem,
ESelectInfo::Type SelectInfo
)

 Adds a single item to the current selection SSceneOutliner.h  

void AddToSelection ( const TArray< FSceneOutlinerTreeItemPtr >& InItems,
ESelectInfo::Type SelectInfo
)

 Adds a set of items to the current selection SSceneOutliner.h  

void ClearSelection()

 Deselect all selected items SSceneOutliner.h  

void CollapseAll()

   SSceneOutliner.h  

void Construct ( const FArguments& InArgs,
const FSceneOutlinerInitializationOptions& InitOptions
)

 Construct this widget. Called by the SNew() Slate macro. SSceneOutliner.h  

void CopyFoldersBegin()

 Called by copy and duplicate SSceneOutliner.h  

void CopyFoldersEnd()

 Called by copy and duplicate SSceneOutliner.h  

void CopyFoldersToClipboard ( const TArray< FName >& InFolders,
const FString& InPrevClipboardContents
)

 Copy specified folders to clipboard, keeping current clipboard contents if they differ from previous clipboard contents (meaning items were copied) SSceneOutliner.h  

void CreateCustomTextFilter ( const FCustomTextFilterData& InFilterData,
bool bApplyFilter
)

   SSceneOutliner.h  

TSharedPtr< FDragDropOperation > CreateDragDropOperation ( const FPointerEvent& MouseEvent,
const TArray< FSceneOutlinerTreeItemPtr >& InTreeItems
) const

 Create a drag drop operation SSceneOutliner.h  

void CreateFolder()

 Create a new folder under the specified parent name (NAME_None for root) SSceneOutliner.h  

FSceneOutlinerTreeItemPtr CreateItemFor ( const TreeItemData& Data,
TFunctionRef< void(const TreeItemType&)> OnItemPassesFilters,
bool bForce
)

 Test the filters using stack-allocated data to prevent unnecessary heap allocations. SSceneOutliner.h  

virtual void CustomAddToToolbar ( TSharedPtr< class SHorizontalBox > Toolbar
)

 Hook to add custom options to toolbar in a derived class SSceneOutliner.h  

void DeleteCustomTextFilter ( const TSharedPtr< ICustomTextFilter< SceneOutliner::FilterBarType > >& InFilter
)

   SSceneOutliner.h  

void DeleteFoldersBegin()

 Called by cut and delete SSceneOutliner.h  

void DeleteFoldersEnd()

 Called by cut and delete SSceneOutliner.h  

void DuplicateFoldersHierarchy()

 Duplicates current folder and all descendants SSceneOutliner.h  

void ExpandAll()

   SSceneOutliner.h  

FString ExportFolderList ( TArray< FName > InFolders
) const

 Construct folders export string to be used in clipboard SSceneOutliner.h  

void FillFoldersSubMenu ( UToolMenu* Menu
) const

   SSceneOutliner.h  

void FillSelectionSubMenu ( UToolMenu* Menun
) const

   SSceneOutliner.h  

void FilterByType ( TSharedPtr< FCustomClassFilterData > CustomClassFilterData
)

   SSceneOutliner.h  

void FilterByTypeCategory ( TSharedPtr< FFilterCategory > TypeCategory,
TArray< TSharedPtr< FCustomClassFilterData > > Classes
)

   SSceneOutliner.h  

FSceneOutlinerTreeItemPtr FindParent ( const ISceneOutlinerTreeItem& InItem
) const

 Returns the parent tree item for a given item if it exists, nullptr otherwise. SSceneOutliner.h  

TSharedRef< TSet< FFolder > > GatherInvalidMoveToDestinations()

   SSceneOutliner.h  

TArray< FName > GetClipboardPasteFolders()

 Get an array of folders to paste SSceneOutliner.h  

const TMap< FName, TSharedPtr< ISceneOutlinerColumn > > & GetColumns()

 Get the columns to be displayed in this outliner SSceneOutliner.h  

SceneOutliner::FTreeItemPtrEvent & GetDoubleClickEvent()

 Event to react to a user double click on a item SSceneOutliner.h  

TSharedPtr< FSceneOutlinerFilters > & GetFilters()

 Get the outliner filter collection SSceneOutliner.h  

bool GetIsReentrant()

 Used to test if Outliner related selection changes have already been handled SSceneOutliner.h  

SceneOutliner::FOnItemSelectionChanged & GetOnItemSelectionChanged()

 Allow the system that use the scene outliner to react when it's selection is changed Note: This event will only be broadcast on a user input. SSceneOutliner.h  

FName GetPrimaryColumnName()

   SSceneOutliner.h  

virtual TArray< FSceneOutlinerTreeItemPtr > GetSelectedItems()

 Returns the list of currently selected tree items SSceneOutliner.h  

virtual FSceneOutlinerItemSelection GetSelection()

 Returns the currently selected items. SSceneOutliner.h  

void GetSortedColumnIDs ( TArray< FName >& OutColumnIDs
) const

   SSceneOutliner.h  

virtual const TSharedPtr< SSceneOutlinerTreeView > & GetTreeView()

   SSceneOutliner.h  

bool HasSelectorFocus ( FSceneOutlinerTreeItemPtr Item
) const

   SSceneOutliner.h  

TArray< FName > ImportFolderList ( const FString& InStrBuffer
) const

 Construct array of folders to be created based on input clipboard string SSceneOutliner.h  

bool IsItemExpanded ( const FSceneOutlinerTreeItemPtr& Item
) const

   SSceneOutliner.h  

bool IsTextFilterActive()

   SSceneOutliner.h  

void ModifyCustomTextFilter ( const FCustomTextFilterData& InFilterData,
const TSharedPtr< ICustomTextFilter< SceneOutliner::FilterBarType > >& InFilter
)

   SSceneOutliner.h  

void MoveSelectionTo ( const FFolder& NewParent
)

 Moves the current selection to the specified folder path SSceneOutliner.h  

bool NeedsRefresh()

   SSceneOutliner.h  

FReply OnDragOverItem ( const FDragDropEvent& Event,
const ISceneOutlinerTreeItem& Item
) const

 Called when a payload is dragged over an item SSceneOutliner.h  

void OnDropPayload ( ISceneOutlinerTreeItem& DropTarget,
const FSceneOutlinerDragDropPayload& Payload,
const FSceneOutlinerDragValidationInfo& ValidationInfo
) const

 Called when a payload is dropped onto a target SSceneOutliner.h  

void OnItemAdded ( const FSceneOutlinerTreeItemID& ItemID,
uint8 ActionMask
)

 Instruct the outliner to perform an action on the specified item when it is created SSceneOutliner.h  

void OnItemLabelChanged ( FSceneOutlinerTreeItemPtr ChangedItem,
bool bFlashHighlight
)

 Handler for when a property changes on any item. Called by the mode SSceneOutliner.h  

virtual FReply OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   SSceneOutliner.h  

TSharedPtr< SWidget > OnOpenContextMenu()

 Open a context menu for this scene outliner SSceneOutliner.h  

bool ParseDragDrop ( FSceneOutlinerDragDropPayload& OutPayload,
const FDragDropOperation& Operation
) const

 Parse a drag drop operation into a payload SSceneOutliner.h  

bool PassesAllFilters ( const FSceneOutlinerTreeItemPtr& Item
) const

   SSceneOutliner.h  

bool PassesFilters ( const ISceneOutlinerTreeItem& Item
) const

   SSceneOutliner.h  

bool PassesTextFilter ( const FSceneOutlinerTreeItemPtr& Item
) const

   SSceneOutliner.h  

void PasteFoldersBegin ( TArray< FName > InFolders
)

 Called by paste and duplicate SSceneOutliner.h  

void PasteFoldersEnd()

 Paste folders end logic SSceneOutliner.h  

virtual void PostRedo ( bool bSuccess
)

   SSceneOutliner.h  

virtual void PostUndo ( bool bSuccess
)

   SSceneOutliner.h  

void RefreshSelection()

   SSceneOutliner.h  

void RemoveFolderFromSelection ( const FName& FolderName
)

 Remove a folder from the selection of the scene outliner SSceneOutliner.h  

void RemoveFromSelection ( const TArray< FSceneOutlinerTreeItemPtr >& InItems,
ESelectInfo::Type SelectInfo
)

 Remove a set of items from the current selection SSceneOutliner.h  

void ScrollItemIntoView ( const FSceneOutlinerTreeItemPtr& Item
)

 Miscellaneous helper functions Scroll the specified item into view SSceneOutliner.h  

void SelectFoldersDescendants ( bool bSelectImmediateChildrenOnly
)

 Called to select descendants of the currently selected folders SSceneOutliner.h  

void SetColumnVisibility ( FName ColumnId,
bool bIsVisible
)

   SSceneOutliner.h  

void SetItemExpansion ( const FSceneOutlinerTreeItemPtr& Item,
bool bIsExpanded
)

   SSceneOutliner.h  

void SetItemSelection ( const FSceneOutlinerTreeItemPtr& InItem,
bool bSelected,
ESelectInfo::Type SelectInfo
)

 Set the selection status of a single item in the scene outliner SSceneOutliner.h  

void SetItemSelection ( const TArray< FSceneOutlinerTreeItemPtr >& InItems,
bool bSelected,
ESelectInfo::Type SelectInfo
)

 Set the selection status of a set of items in the scene outliner SSceneOutliner.h  

void SetPendingRenameItem ( const FSceneOutlinerTreeItemPtr& InItem
)

 Sets the next item to rename SSceneOutliner.h  

void SetShowTransient ( bool bInShowTransient
)

 Toggle if SceneOutliner should show Transient objects SSceneOutliner.h  

virtual bool SupportsKeyboardFocus()

   SSceneOutliner.h  

virtual void Tick ( const FGeometry& AllottedGeometry,
const double InCurrentTime,
const float InDeltaTime
)

 SWidget interface SSceneOutliner.h  

FSceneOutlinerDragValidationInfo ValidateDrop ( const ISceneOutlinerTreeItem& DropTarget,
const FSceneOutlinerDragDropPayload& Payload
) const

 Validate a drag drop operation on a drop target SSceneOutliner.h  

Overridden from ISceneOutliner

Name Remarks Include Path Unreal Specifiers

virtual void AddColumn ( FName ColumnId,
const FSceneOutlinerColumnInfo& ColumnInfo
)

 Add or replace a column of the scene outliner Note: The column id must match the id of the column returned by the factory SSceneOutliner.h  

virtual int32 AddFilter ( const TSharedRef< FSceneOutlinerFilter >& Filter
)

 Add a filter to the scene outliner SSceneOutliner.h  

virtual void AddFilterToFilterBar ( const TSharedRef< FFilterBase< SceneOutliner::FilterBarType > >& InFilter
)

 Add a filter to the scene outliner's filter bar SSceneOutliner.h  

virtual int32 AddInteractiveFilter ( const TSharedRef< FSceneOutlinerFilter >& Filter
)

 Add an interactive filter to the scene outliner SSceneOutliner.h  

virtual void CacheIconForClass ( FName InClassName,
const FSlateBrush* InSlateBrush
)

 Sets the cached icon for this class name SSceneOutliner.h  

virtual bool CanExecuteRenameRequest ( const ISceneOutlinerTreeItem& ItemPtr
) const

 Should the scene outliner accept a request to rename a object SSceneOutliner.h  

virtual bool CanPinItems ( const TArray< FSceneOutlinerTreeItemPtr >& InItems
) const

 Returns true if any of the items can be pinned. SSceneOutliner.h  

virtual bool CanPinSelectedItems()

 Returns true if any of the selected items can be pinned SSceneOutliner.h  

virtual bool CanSupportDragAndDrop()

 Can the scene outliner rows generated on drag event SSceneOutliner.h  

virtual bool CanUnpinItems ( const TArray< FSceneOutlinerTreeItemPtr >& InItems
) const

 Returns true if any of the items can be unpinned. SSceneOutliner.h  

virtual bool CanUnpinSelectedItems()

 Returns true if any of the selected items can be unpinned SSceneOutliner.h  

virtual bool Copy_CanExecute()

 Returns true if edit copy can be executed SSceneOutliner.h  

virtual bool Cut_CanExecute()

 Returns true if edit cut can be executed SSceneOutliner.h  

virtual bool Delete_CanExecute()

 Returns true if edit delete can be executed SSceneOutliner.h  

virtual void DisableAllFilterBarFilters ( bool bRemove
)

 Disable all filters currently active in the filter bar SSceneOutliner.h  

virtual void FrameItem ( const FSceneOutlinerTreeItemID& Item
)

 Scrolls the outliner to the specified item if it's found. No action is done otherwise. SSceneOutliner.h  

virtual void FrameSelectedItems ()

 Scrolls the outliner to the selected item(s). SSceneOutliner.h  

virtual void FullRefresh()

 Tells the scene outliner that it should do a full refresh, which will clear the entire tree and rebuild it from scratch. SSceneOutliner.h  

virtual const FSlateBrush * GetCachedIconForClass ( FName InClassName
) const

 Gets the cached icon for this class name SSceneOutliner.h  

virtual TArray< FName > GetColumnIds()

 Return the name/Id of the columns of the scene outliner SSceneOutliner.h  

virtual EColumnSortMode::Type GetColumnSortMode ( const FName ColumnId
) const

   SSceneOutliner.h  

virtual TSharedPtr< FSceneOutlinerFilter > GetFilterAtIndex ( int32 Index
)

 Retrieve the filter at the specified index SSceneOutliner.h  

virtual int32 GetFilterCount()

 Get number of filters applied to the scene outliner SSceneOutliner.h  

virtual TAttribute< FText > GetFilterHighlightText()

   SSceneOutliner.h  

virtual TSharedPtr< FSceneOutlinerTreeItemSCC > GetItemSourceControl ( const FSceneOutlinerTreeItemPtr& InItem
)

 Get the associated source control object for the specified item. SSceneOutliner.h  

virtual FName GetOutlinerIdentifier()

 Get the unique identifier associated with this outliner SSceneOutliner.h  

virtual const FSharedSceneOutlinerData & GetSharedData()

   SSceneOutliner.h  

virtual const STreeView< FSceneOutlinerTreeItemPtr > & GetTree()

 Get a const reference to the actual tree hierarchy SSceneOutliner.h  

virtual FSceneOutlinerTreeItemPtr GetTreeItem ( FSceneOutlinerTreeItemID,
bool bIncludePending
)

 Retrieve an ISceneOutlinerTreeItem by its ID if it exists in the tree SSceneOutliner.h  

virtual bool IsFilterActive ( const FString& FilterName
) const

 Check if a filter with the given name exists and is active in the filter bar for this Outliner (if this Outliner has a filter bar). SSceneOutliner.h  

virtual bool Paste_CanExecute()

 Returns true if edit paste can be executed SSceneOutliner.h  

virtual void PinItems ( const TArray< FSceneOutlinerTreeItemPtr >& InItems
)

 Pins an item list in the outliner. SSceneOutliner.h  

virtual void PinSelectedItems()

 Pin selected items SSceneOutliner.h  

virtual void Refresh()

 Sends a requests to the Scene Outliner to refresh itself the next chance it gets SSceneOutliner.h  

virtual void RemoveColumn ( FName ColumnId
)

 Remove a column of the scene outliner SSceneOutliner.h  

virtual bool RemoveFilter ( const TSharedRef< FSceneOutlinerFilter >& Filter
)

 Remove a filter from the scene outliner SSceneOutliner.h  

virtual bool RemoveInteractiveFilter ( const TSharedRef< FSceneOutlinerFilter >& Filter
)

 Remove an interactive filter from the scene outliner SSceneOutliner.h  

virtual bool Rename_CanExecute()

 Returns true if edit rename can be executed SSceneOutliner.h  

virtual void Rename_Execute()

 Executes rename. SSceneOutliner.h  

virtual void RequestSort()

 Request that the tree be sorted at a convenient time SSceneOutliner.h  

virtual void SetKeyboardFocus()

 Set the keyboard focus to the outliner SSceneOutliner.h  

virtual void SetNextUIRefreshDelay ( float InDelay
)

 Set a delay (in seconds) before the the next requested UI refresh executes. SSceneOutliner.h  

virtual void SetSelection ( const TFunctionRef< bool(ISceneOutlinerTreeItem&)> Selector
)

 Set the item selection of the outliner based on a selector function. SSceneOutliner.h  

virtual void UnpinItems ( const TArray< FSceneOutlinerTreeItemPtr >& InItems
)

 Unpins an item list in the outliner. SSceneOutliner.h  

virtual void UnpinSelectedItems()

 Unpins selected items SSceneOutliner.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page