Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

> Unreal Engine API Reference > Editor > SceneOutliner > SSceneOutliner

Light Theme

Dark Theme

SSceneOutliner

Scene Outliner widget

Windows

MacOS

Linux

Inheritance Hierarchy

ICustomSceneOutliner

FEditorUndoClient

FGCObject

SSceneOutliner

References

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

Syntax

class SSceneOutliner :
    public ICustomSceneOutliner,
    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
bool	CanPasteFoldersOnlyFromClipboard()	Returns true if clipboard contains folders only
bool	CanSupportDragAndDrop()	Can the scene outliner rows generated on drag event
void	Construct ( const FArguments& InArgs, const FInitializationOptions& Init... )	Construct this widget. Called by the SNew()Slate macro.
void	ConstructItemFor ( const DataType& Data )	Adds a new item for the specified type and refreshes the tree, provided it matches the filter terms
void	DuplicateFoldersHierarchy()	Duplicates current folder and all descendants
const TMap< ...	GetColumns()	Get the columns to be displayed in this outliner
const TUniqu...	GetOnDragEnterItem()
const TUniqu...	GetOnDragLeaveItem()
const TUniqu...	GetOnDragOverItem()
const TUniqu...	GetOnDropOnItem()
const TUniqu...	GetOnItemDragDetected()
void	OnItemAdded ( const FTreeItemID& ItemID, uint8 ActionMask )	Instruct the outliner to perform an action on the specified item when it is created
void	ScrollItemIntoView ( FTreeItemPtr Item )	Miscellaneous helper functions Scroll the specified item into view

Overridden from ICustomSceneOutliner

	Name	Description
void	AddFolderToSelection ( const FName& FolderName )	Add a folder to the selection of the scene outliner
void	AddObjectToSelection ( const UObject* Object )	Add a object to the selection of the scene outliner
void	AddToSelection ( const SceneOutliner::TTreeItemGette... )	Add some items to selection of the scene outliner The items that return true will be the ones added to the selection
void	ClearSelection()	Deselect all selected items
FTreeItemPtr...	GetDoubleClickEvent()	Event to react to a user double click on a item
FOnItemSelec...	GetOnItemSelectionChanged()	Allow the system that use the scene outliner to react when it's selection is changed
bool	IsUsingSharedSceneOutlinerSettings()	Is the scene outliner using the shared settings? (The same as the world outliner)
void	RemoveFolderFromSelection ( const FName& FolderName )	Remove a folder from the selection of the scene outliner
void	RemoveFromSelection ( const SceneOutliner::TTreeItemGette... )	Remove some items from selection of the scene outliner The items that return true will be the ones removed from the selection
void	RemoveObjectFromSelection ( const UObject* Object )	Remove a object from the selection of the scene outliner
ICustomScene...	SetCanRenameItem ( TUniquePtr< TTreeItemGetter< bool >... )	Tell the scene outliner to use this visitor before accepting a rename request from a actor or from the prebuild column Item Label
ICustomScene...	SetHideTemporaryActors ( bool bHideTemporaryActors )	Set the hide temporary actors filter
ICustomScene...	SetOnDragEnterItem ( TUniqueFunction< void... )	Set the behavior for when a drag and drop enter the zone of a item
ICustomScene...	SetOnDragLeaveItem ( TUniqueFunction< void... )	Set the behavior for when a drag and drop leave the zone of a item
ICustomScene...	SetOnDragOverItem ( TUniqueFunction< FReply... )	Set the behavior for when a drag pass over a Item of the scene outliner
ICustomScene...	SetOnDropOnItem ( TUniqueFunction< FReply... )	Set the behavior for when a drag and drop is dropped on the scene outliner
ICustomScene...	SetOnItemDragDetected ( TUniqueFunction< FReply... )	Set the behavior for when a item is dragged
void	SetSelection ( const SceneOutliner::TTreeItemGette... )	Set the selection of the scene outliner The items that return true will be the ones selected
ICustomScene...	SetSelectionMode ( ESelectionMode::Type InSelectionMod... )	Methods for the custom scene outliner interface Set the selection mode of the scene outliner.
ICustomScene...	SetShouldSelectItemWhenAdded ( TUniquePtr< TTreeItemGetter< bool >... )	Tell the scene outliner to use this visitor to dertimine if a newly added item should be selected
ICustomScene...	SetShowActorComponents ( bool bShowActorComponents )	Set the show actor components setting
ICustomScene...	SetShownOnlySelected ( bool bShownOnlySelected )	Set the show only selected setting
ICustomScene...	SetShowOnlyCurrentLevel ( bool bShowOnlyCurrentLevel )	Set the show only in current level setting
ICustomScene...	SetUseSharedSceneOutlinerSettings ( bool bUseSharedSettings )	Tell this scene outliner to use the shared setting or not.

Overridden from ISceneOutliner

	Name	Description
void	AddColumn ( FName ColumId, const SceneOutliner::FColumnInfo& ... )	Add or replace a column of the scene outliner
int32	AddFilter ( const TSharedRef< SceneOutliner::FO... )	Add a filter to the scene outliner
void	CacheIconForClass ( FName InClassName, const FSlateBrush* InSlateBrus... )	Sets the cached icon for this class name
bool	CanExecuteRenameRequest ( const FTreeItemPtr& ItemPtr )	Should the scene outliner accept a request to rename a object
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	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< SceneOutliner::FO... )	Remove a 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

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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss