Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > SceneOutliner > SSceneOutliner

Light Theme

Dark Theme

SSceneOutliner

Scene Outliner widget

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

ISceneOutliner

FEditorUndoClient

FGCObject

SSceneOutliner

References

Module	SceneOutliner
Header	/Engine/Source/Editor/SceneOutliner/Public/SSceneOutliner.h
Include	#include "SSceneOutliner.h"

Syntax

class SSceneOutliner :
    public ISceneOutliner,
    public FEditorUndoClient,
    public FGCObject

Remarks

Scene Outliner widget

Constructors

	Name	Description
	SSceneOutliner()	Default constructor - initializes data that is shared between all tree items

Destructors

	Name	Description
	~SSceneOutliner()	SSceneOutliner destructor

Functions

	Name	Description
void	AddFolderToSelection ( const FName& FolderName )	Add a folder to the selection of the scene outliner
void	AddMoveToFolderOutliner ( UToolMenu* Menu )
void	AddToSelection ( const TArray< FSceneOutlinerTreeIte..., ESelectInfo::Type SelectInfo )	Adds a set of items to the current selection
void	ClearSelection()	Deselect all selected items
void	CollapseAll()
void	Construct ( const FArguments& InArgs, const FSceneOutlinerInitializationO... )	Construct this widget. Called by the SNew()Slate macro.
void	CopyFoldersBegin()	Called by copy and duplicate
void	CopyFoldersEnd()	Called by copy and duplicate
void	CopyFoldersToClipboard ( const TArray< FName >& InFolders, const FString& InPrevClipboardCont... )	Copy specified folders to clipboard, keeping current clipboard contents if they differ from previous clipboard contents (meaning items were copied)
TSharedPtr< ...	CreateDragDropOperation ( const TArray< FSceneOutlinerTreeIte... )	Create a drag drop operation
void	CreateFolder()	Create a new folder under the specified parent name (NAME_None for root)
FSceneOutlin...	CreateItemFor ( const TreeItemData& Data, TFunctionRef< void bForce )	Test the filters using stack-allocated data to prevent unnecessary heap allocations.
void	CustomAddToToolbar ( TSharedPtr< class SHorizontalBox > ... )	Hook to add custom options to toolbar in a derived class
void	DeleteFoldersBegin()	Called by cut and delete
void	DeleteFoldersEnd()	Called by cut and delete
void	DuplicateFoldersHierarchy()	Duplicates current folder and all descendants
void	ExpandAll()
FString	ExportFolderList ( TArray< FName > InFolders )	Construct folders export string to be used in clipboard
void	FillFoldersSubMenu ( UToolMenu* Menu )
void	FillSelectionSubMenu ( UToolMenu* Menun )
FSceneOutlin...	FindParent ( const ISceneOutlinerTreeItem& InIt... )	Returns the parent tree item for a given item if it exists, nullptr otherwise.
TSharedRef< ...	GatherInvalidMoveToDestinations()
TArray< FNam...	GetClipboardPasteFolders()	Get an array of folders to paste
const TMap< ...	GetColumns()	Get the columns to be displayed in this outliner
SceneOutline...	GetDoubleClickEvent()	Event to react to a user double click on a item
TSharedPtr< ...	GetFilters()	Get the outliner filter collection
bool	GetIsReentrant()	Used to test if Outliner related selection changes have already been handled
SceneOutline...	GetOnItemSelectionChanged()	Allow the system that use the scene outliner to react when it's selection is changed
TArray< FSce...	GetSelectedItems()	Returns the list of currently selected tree items
FSceneOutlin...	GetSelection()	Returns the currently selected items.
FSceneOutlin...	GetTreeItem ( FSceneOutlinerTreeItemID, bool bIncludePending )	Retrieve an ISceneOutlinerTreeItem by its ID if it exists in the tree
const TShare...	GetTreeView()
bool	HasSelectorFocus ( FSceneOutlinerTreeItemPtr Item )
TArray< FNam...	ImportFolderList ( const FString& InStrBuffer )	Construct array of folders to be created based on input clipboard string
bool	IsItemExpanded ( const FSceneOutlinerTreeItemPtr& I... )
bool	IsTextFilterActive()
void	MoveSelectionTo ( const FFolder& NewParent )	Moves the current selection to the specified folder path
FReply	OnDragOverItem ( const FDragDropEvent& Event, const ISceneOutlinerTreeItem& Item )	Called when a payload is dragged over an item
void	OnDropPayload ( ISceneOutlinerTreeItem& DropTarget, const FSceneOutlinerDragDropPayload..., const FSceneOutlinerDragValidationI... )	Called when a payload is dropped onto a target
void	OnItemAdded ( const FSceneOutlinerTreeItemID& It..., uint8 ActionMask )	Instruct the outliner to perform an action on the specified item when it is created
void	OnItemLabelChanged ( FSceneOutlinerTreeItemPtr ChangedIt... )	Handler for when a property changes on any item. Called by the mode
TSharedPtr< ...	OnOpenContextMenu()	Open a context menu for this scene outliner
bool	ParseDragDrop ( FSceneOutlinerDragDropPayload& Out..., const FDragDropOperation& Operatio... )	Parse a drag drop operation into a payload
bool	PassesFilters ( const ISceneOutlinerTreeItem& Item )
bool	PassesTextFilter ( const FSceneOutlinerTreeItemPtr& I... )
void	PasteFoldersBegin ( TArray< FName > InFolders )	Called by paste and duplicate
void	PasteFoldersEnd()	Paste folders end logic
void	RefreshSelection()
void	RemoveFolderFromSelection ( const FName& FolderName )	Remove a folder from the selection of the scene outliner
void	RemoveFromSelection ( const TArray< FSceneOutlinerTreeIte..., ESelectInfo::Type SelectInfo )	Remove a set of items from the current selection
void	ScrollItemIntoView ( const FSceneOutlinerTreeItemPtr& I... )	Miscellaneous helper functions Scroll the specified item into view
void	SelectFoldersDescendants ( bool bSelectImmediateChildrenOnly )	Called to select descendants of the currently selected folders
void	SetColumnVisibility ( FName ColumnId, bool bIsVisible )
void	SetItemExpansion ( const FSceneOutlinerTreeItemPtr& I..., bool bIsExpanded )
void	SetItemSelection ( const TArray< FSceneOutlinerTreeIte..., bool bSelected, ESelectInfo::Type SelectInfo )	Set the selection status of a set of items in the scene outliner
void	SetItemSelection ( const FSceneOutlinerTreeItemPtr& I..., bool bSelected, ESelectInfo::Type SelectInfo )	Set the selection status of a single item in the scene outliner
void	SetPendingRenameItem ( const FSceneOutlinerTreeItemPtr& I... )	Sets the next item to rename
FSceneOutlin...	ValidateDrop ( const ISceneOutlinerTreeItem& Drop..., const FSceneOutlinerDragDropPayload... )	Validate a drag drop operation on a drop target

Overridden from ISceneOutliner

	Name	Description
void	AddColumn ( FName ColumId, const FSceneOutlinerColumnInfo& Co... )	Add or replace a column of the scene outliner
int32	AddFilter ( const TSharedRef< FSceneOutlinerFil... )	Add a filter to the scene outliner
int32	AddInteractiveFilter ( const TSharedRef< FSceneOutlinerFil... )	Add an interactive filter to the scene outliner
void	CacheIconForClass ( FName InClassName, const FSlateBrush* InSlateBrus... )	Sets the cached icon for this class name
bool	CanExecuteRenameRequest ( const ISceneOutlinerTreeItem& Item... )	Should the scene outliner accept a request to rename a object
bool	CanSupportDragAndDrop()	Can the scene outliner rows generated on drag event
bool	Copy_CanExecute()	Returns true if edit copy can be executed
bool	Cut_CanExecute()	Returns true if edit cut can be executed
bool	Delete_CanExecute()	Returns true if edit delete can be executed
void	FullRefresh()	Tells the scene outliner that it should do a full refresh, which will clear the entire tree and rebuild it from scratch.
const FSlate...	GetCachedIconForClass ( FName InClassName )	Gets the cached icon for this class name
TArray< FNam...	GetColumnIds()	Return the name/Id of the columns of the scene outliner
EColumnSortM...	GetColumnSortMode ( const FName ColumnId )	Return the sorting mode for the specified ColumnId
TSharedPtr< ...	GetFilterAtIndex ( int32 Index )	Retrieve the filter at the specified index
int32	GetFilterCount()	Get number of filters applied to the scene outliner
TAttribute< ...	GetFilterHighlightText()
const FShare...	GetSharedData()
const STreeV...	GetTree()	Get a const reference to the actual tree hierarchy
bool	Paste_CanExecute()	Returns true if edit paste can be executed
void	PinItem ( const FSceneOutlinerTreeItemPtr& I... )	Pins an item in the outliner.
void	PinSelectedItems()	Pin selected items
void	Refresh()	Sends a requests to the Scene Outliner to refresh itself the next chance it gets
void	RemoveColumn ( FName ColumId )	Remove a column of the scene outliner
bool	RemoveFilter ( const TSharedRef< FSceneOutlinerFil... )	Remove a filter from the scene outliner
bool	RemoveInteractiveFilter ( const TSharedRef< FSceneOutlinerFil... )	Remove an interactive filter from the scene outliner
bool	Rename_CanExecute()	Returns true if edit rename can be executed
void	Rename_Execute()	Executes rename.
void	RequestSort()	Request that the tree be sorted at a convenient time
void	SetKeyboardFocus()	Set the keyboard focus to the outliner
void	SetSelection ( const TFunctionRef< bool... )	Set the item selection of the outliner based on a selector function.
void	UnpinItem ( const FSceneOutlinerTreeItemPtr& I... )	Unpins an item in the outliner.
void	UnpinSelectedItems()	Unpins selected items

Overridden from SWidget

	Name	Description
FReply	OnKeyDown ( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent )	Called after a key is pressed when this widget has focus (this event bubbles if not handled)
bool	SupportsKeyboardFocus()	Checks to see if this widget supports keyboard focus. Override this in derived classes.
void	Tick ( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime )	SWidget interface

Overridden from FEditorUndoClient

		Name	Description
	void	PostRedo ( bool bSuccess )	Signal that client should run any PostRedo code
	void	PostUndo ( bool bSuccess )	Signal that client should run any PostUndo code

Classes

	Name	Description
	FArguments

Typedefs

Name	Description
FParentsExpansionState	Structure containing information relating to the expansion state of parent items in the tree