SSceneOutliner

Scene Outliner widget

Windows
MacOS
Linux

Inheritance Hierarchy

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

Public function

SSceneOutliner()

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

Destructors

Name Description

Public function

~SSceneOutliner()

SSceneOutliner destructor

Functions

Name Description

Public function

bool

 

CanPasteFoldersOnlyFromClipboard()

Returns true if clipboard contains folders only

Public function Const

bool

 

CanSupportDragAndDrop()

Can the scene outliner rows generated on drag event

Public function

void

 

Construct

(
    const FArguments & InArgs,
    const FInitializationOptions & Init...
)

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

Public function

void

 

ConstructItemFor

(
    const DataType& Data
)

Adds a new item for the specified type and refreshes the tree, provided it matches the filter terms

Public function

void

 

DuplicateFoldersHierarchy()

Duplicates current folder and all descendants

Public function Const

const TMap < ...

 

GetColumns()

Get the columns to be displayed in this outliner

Public function Const

const TUniqu ...

 

GetOnDragEnterItem()

Public function Const

const TUniqu ...

 

GetOnDragLeaveItem()

Public function Const

const TUniqu ...

 

GetOnDragOverItem()

Public function Const

const TUniqu ...

 

GetOnDropOnItem()

Public function Const

const TUniqu ...

 

GetOnItemDragDetected()

Public function

void

 

OnItemAdded

(
    const FTreeItemID & ItemID,
    uint8 ActionMask
)

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

Public function

void

 

ScrollItemIntoView

(
    FTreeItemPtr Item
)

Miscellaneous helper functions Scroll the specified item into view

Overridden from ICustomSceneOutliner

Name Description

Public function Virtual

void

 

AddFolderToSelection

(
    const FName & FolderName
)

Add a folder to the selection of the scene outliner

Public function Virtual

void

 

AddObjectToSelection

(
    const UObject * Object
)

Add a object to the selection of the scene outliner

Public function Virtual

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

Public function Virtual

void

 

ClearSelection()

Deselect all selected items

Public function Virtual

FTreeItemPtr ...

 

GetDoubleClickEvent()

Event to react to a user double click on a item

Public function Virtual

FOnItemSelec ...

 

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.

Public function Virtual Const

bool

 

IsUsingSharedSceneOutlinerSettings()

Is the scene outliner using the shared settings? (The same as the world outliner)

Public function Virtual

void

 

RemoveFolderFromSelection

(
    const FName & FolderName
)

Remove a folder from the selection of the scene outliner

Public function Virtual

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

Public function Virtual

void

 

RemoveObjectFromSelection

(
    const UObject * Object
)

Remove a object from the selection of the scene outliner

Public function Virtual

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

Public function Virtual

ICustomScene ...

 

SetHideTemporaryActors

(
    bool bHideTemporaryActors
)

Set the hide temporary actors filter

Public function Virtual

ICustomScene ...

 

SetOnDragEnterItem

(
    TUniqueFunction < void ...
)

Set the behavior for when a drag and drop enter the zone of a item

Public function Virtual

ICustomScene ...

 

SetOnDragLeaveItem

(
    TUniqueFunction < void ...
)

Set the behavior for when a drag and drop leave the zone of a item

Public function Virtual

ICustomScene ...

 

SetOnDragOverItem

(
    TUniqueFunction < FReply ...
)

Set the behavior for when a drag pass over a Item of the scene outliner

Public function Virtual

ICustomScene ...

 

SetOnDropOnItem

(
    TUniqueFunction < FReply ...
)

Set the behavior for when a drag and drop is dropped on the scene outliner

Public function Virtual

ICustomScene ...

 

SetOnItemDragDetected

(
    TUniqueFunction < FReply ...
)

Set the behavior for when a item is dragged Note: to avoid having to different user experience from the world outliner.

Public function Virtual

void

 

SetSelection

(
    const SceneOutliner::TTreeItemGette ...
)

Set the selection of the scene outliner The items that return true will be the ones selected

Public function Virtual

ICustomScene ...

 

SetSelectionMode

(
    ESelectionMode::Type InSelectionMod...
)

Methods for the custom scene outliner interface Set the selection mode of the scene outliner.

Public function Virtual

ICustomScene ...

 

SetShouldSelectItemWhenAdded

(
    TUniquePtr < TTreeItemGetter < bool >...
)

Tell the scene outliner to use this visitor to dertimine if a newly added item should be selected

Public function Virtual

ICustomScene ...

 

SetShowActorComponents

(
    bool bShowActorComponents
)

Set the show actor components setting

Public function Virtual

ICustomScene ...

 

SetShownOnlySelected

(
    bool bShownOnlySelected
)

Set the show only selected setting

Public function Virtual

ICustomScene ...

 

SetShowOnlyCurrentLevel

(
    bool bShowOnlyCurrentLevel
)

Set the show only in current level setting

Public function Virtual

ICustomScene ...

 

SetUseSharedSceneOutlinerSettings

(
    bool bUseSharedSettings
)

Tell this scene outliner to use the shared setting or not.

Overridden from ISceneOutliner

Name Description

Public function Virtual

void

 

AddColumn

(
    FName ColumId,
    const SceneOutliner::FColumnInfo & ...
)

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

Public function Virtual

int32

 

AddFilter

(
    const TSharedRef < SceneOutliner::FO ...
)

Add a filter to the scene outliner

Public function Virtual

void

 

CacheIconForClass

(
    FName InClassName,
    const FSlateBrush * InSlateBrus...
)

Sets the cached icon for this class name

Public function Virtual Const

bool

 

CanExecuteRenameRequest

(
    const FTreeItemPtr & ItemPtr
)

Should the scene outliner accept a request to rename a object

Public function Virtual

bool

 

Copy_CanExecute()

Returns true if edit copy can be executed

Public function Virtual

bool

 

Cut_CanExecute()

Returns true if edit cut can be executed

Public function Virtual

bool

 

Delete_CanExecute()

Returns true if edit delete can be executed

Public function 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.

Public function Virtual Const

const FSlate ...

 

GetCachedIconForClass

(
    FName InClassName
)

Gets the cached icon for this class name

Public function Virtual Const

TArray < FNam ...

 

GetColumnIds()

Return the name/Id of the columns of the scene outliner

Public function Virtual Const

EColumnSortM ...

 

GetColumnSortMode

(
    const FName ColumnId
)

Return the sorting mode for the specified ColumnId

Public function Virtual

TSharedPtr < ...

 

GetFilterAtIndex

(
    int32 Index
)

Retrieve the filter at the specified index

Public function Virtual Const

int32

 

GetFilterCount()

Get number of filters applied to the scene outliner

Public function Virtual Const

TAttribute < ...

 

GetFilterHighlightText()

Public function Virtual Const

const FShare ...

 

GetSharedData()

Public function Virtual Const

const STreeV ...

 

GetTree()

Get a const reference to the actual tree hierarchy

Public function Virtual

bool

 

Paste_CanExecute()

Returns true if edit paste can be executed

Public function Virtual

void

 

Refresh()

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

Public function Virtual

void

 

RemoveColumn

(
    FName ColumId
)

Remove a column of the scene outliner

Public function Virtual

bool

 

RemoveFilter

(
    const TSharedRef < SceneOutliner::FO ...
)

Remove a filter from the scene outliner

Public function Virtual

bool

 

Rename_CanExecute()

Returns true if edit rename can be executed

Public function Virtual

void

 

Rename_Execute()

Executes rename.

Public function Virtual

void

 

RequestSort()

Request that the tree be sorted at a convenient time

Public function Virtual

void

 

SetKeyboardFocus()

Set the keyboard focus to the outliner

Overridden from SWidget

Name Description

Public function Virtual

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)

Public function Virtual Const

bool

 

SupportsKeyboardFocus()

Checks to see if this widget supports keyboard focus. Override this in derived classes.

Public function Virtual

void

 

Tick

(
    const FGeometry & AllottedGeometry,
    const double InCurrentTime,
    const float InDeltaTime
)

SWidget interface

Overridden from FEditorUndoClient

Name Description

Public function Virtual

void

 

PostRedo

(
    bool bSuccess
)

Signal that client should run any PostRedo code

Public function Virtual

void

 

PostUndo

(
    bool bSuccess
)

Signal that client should run any PostUndo code

Classes

Name

Description

Public struct

FArguments

Typedefs

Name

Description

FParentsExpansionState

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

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback