1. Epic GamesDeveloper
  3. SSceneOutliner

SSceneOutliner

Scene Outliner widget

API > API/Editor > API/Editor/SceneOutliner

Inheritance Hierarchy

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

  Type Name Description
Public function   Default constructor - initializes data that is shared between all tree items

Destructors

  Type Name Description
Public function Virtual   SSceneOutliner destructor

Functions

  Type Name Description
Public function void

AddFolderToSelection ( const FName& FolderName
)

 Add a folder to the selection of the scene outliner
Public function Const void  
Public function void  
Public function void

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

 Adds a set of items to the current selection
Public function void Deselect all selected items
Public function void  
Public function void

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

 Construct this widget. Called by the SNew()Slate macro.
Public function void Called by copy and duplicate
Public function void Called by copy and duplicate
Public function 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)
Public function Const TSharedPtr< FDragDropOperation >

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

 Create a drag drop operation
Public function void Create a new folder under the specified parent name (NAME_None for root)
Public function FSceneOutlinerTreeItemPtr

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

 Test the filters using stack-allocated data to prevent unnecessary heap allocations.
Public function Virtual void Hook to add custom options to toolbar in a derived class
Public function void Called by cut and delete
Public function void Called by cut and delete
Public function void Duplicates current folder and all descendants
Public function void  
Public function Const FString

ExportFolderList ( TArray< FName > InFolders
)

 Construct folders export string to be used in clipboard
Public function Const void  
Public function Const void  
Public function Const FSceneOutlinerTreeItemPtr Returns the parent tree item for a given item if it exists, nullptr otherwise.
Public function Const TSharedRef< TSet< FFolder > >  
Public function Const TArray< FName > Get an array of folders to paste
Public function Const const TMap< FName, TSharedPtr< ISceneOutlinerColumn > > & Get the columns to be displayed in this outliner
Public function SceneOutliner::FTreeItemPtrEvent & Event to react to a user double click on a item
Public function TSharedPtr< FSceneOutlinerFilters > & Get the outliner filter collection
Public function Const bool Used to test if Outliner related selection changes have already been handled
Public function SceneOutliner::FOnItemSelectionChanged & 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 Const FName Get the unique identifier associated with this outliner
Public function Virtual Const TArray< FSceneOutlinerTreeItemPtr > Returns the list of currently selected tree items
Public function Virtual Const FSceneOutlinerItemSelection Returns the currently selected items.
Public function Const void

GetSortedColumnIDs ( TArray< FName >& OutColumnIDs
)

  
Public function FSceneOutlinerTreeItemPtr

GetTreeItem ( FSceneOutlinerTreeItemID,
bool bIncludePending
)

 Retrieve an ISceneOutlinerTreeItem by its ID if it exists in the tree
Public function Virtual Const const TSharedPtr< SSceneOutlinerTreeView > &  
Public function Const bool

HasSelectorFocus ( FSceneOutlinerTreeItemPtr Item
)

  
Public function Const TArray< FName >

ImportFolderList ( const FString& InStrBuffer
)

 Construct array of folders to be created based on input clipboard string
Public function Const bool

IsItemExpanded ( const FSceneOutlinerTreeItemPtr& Item
)

  
Public function Const bool  
Public function void

MoveSelectionTo ( const FFolder& NewParent
)

 Moves the current selection to the specified folder path
Public function Const FReply

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

 Called when a payload is dragged over an item
Public function Const void Called when a payload is dropped onto a target
Public function void

OnItemAdded ( const FSceneOutlinerTreeItemID& ItemID,
uint8 ActionMask
)

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

OnItemLabelChanged ( FSceneOutlinerTreeItemPtr ChangedItem
)

 Handler for when a property changes on any item. Called by the mode
Public function TSharedPtr< SWidget > Open a context menu for this scene outliner
Public function Const bool Parse a drag drop operation into a payload
Public function Const bool

PassesAllFilters ( const FSceneOutlinerTreeItemPtr& Item
)

  
Public function Const bool  
Public function Const bool

PassesTextFilter ( const FSceneOutlinerTreeItemPtr& Item
)

  
Public function void

PasteFoldersBegin ( TArray< FName > InFolders
)

 Called by paste and duplicate
Public function void Paste folders end logic
Public function void  
Public function void

RemoveFolderFromSelection ( const FName& FolderName
)

 Remove a folder from the selection of the scene outliner
Public function void

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

 Remove a set of items from the current selection
Public function void

ScrollItemIntoView ( const FSceneOutlinerTreeItemPtr& Item
)

 Miscellaneous helper functions Scroll the specified item into view
Public function void

SelectFoldersDescendants ( bool bSelectImmediateChildrenOnly
)

 Called to select descendants of the currently selected folders
Public function void

SetColumnVisibility ( FName ColumnId,
bool bIsVisible
)

  
Public function void

SetItemExpansion ( const FSceneOutlinerTreeItemPtr& Item,
bool bIsExpanded
)

  
Public function void

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

 Set the selection status of a set of items in the scene outliner
Public function void

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

 Set the selection status of a single item in the scene outliner
Public function void

SetPendingRenameItem ( const FSceneOutlinerTreeItemPtr& InItem
)

 Sets the next item to rename
Public function Const FSceneOutlinerDragValidationInfo

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

 Validate a drag drop operation on a drop target

Overridden from ISceneOutliner

  Type Name Description
Public function Virtual void

AddColumn ( FName ColumnId,
const FSceneOutlinerColumnInfo& ColumInfo
)

 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 Add a filter to the scene outliner
Public function Virtual int32 Add an interactive filter to the scene outliner
Public function Virtual void

CacheIconForClass ( FName InClassName,
const FSlateBrush* InSlateBrush
)

 Sets the cached icon for this class name
Public function Virtual Const bool Should the scene outliner accept a request to rename a object
Public function Virtual Const bool

CanPinItems ( const TArray< FSceneOutlinerTreeItemPtr >& InItems
)

 Returns true if any of the items can be pinned.
Public function Virtual Const bool Returns true if any of the selected items can be pinned
Public function Virtual Const bool Can the scene outliner rows generated on drag event
Public function Virtual Const bool

CanUnpinItems ( const TArray< FSceneOutlinerTreeItemPtr >& InItems
)

 Returns true if any of the items can be unpinned.
Public function Virtual Const bool Returns true if any of the selected items can be unpinned
Public function Virtual bool Returns true if edit copy can be executed
Public function Virtual bool Returns true if edit cut can be executed
Public function Virtual bool Returns true if edit delete can be executed
Public function Virtual void 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 FSlateBrush *

GetCachedIconForClass ( FName InClassName
)

 Gets the cached icon for this class name
Public function Virtual Const TArray< FName > Return the name/Id of the columns of the scene outliner
Public function Virtual Const EColumnSortMode::Type

GetColumnSortMode ( const FName ColumnId
)

 Return the sorting mode for the specified ColumnId
Public function Virtual TSharedPtr< FSceneOutlinerFilter >

GetFilterAtIndex ( int32 Index
)

 Retrieve the filter at the specified index
Public function Virtual Const int32 Get number of filters applied to the scene outliner
Public function Virtual Const TAttribute< FText >  
Public function Virtual TSharedPtr< FSceneOutlinerTreeItemSCC >

GetItemSourceControl ( const FSceneOutlinerTreeItemPtr& InItem
)

 Get the associated source control object for the specified item.
Public function Virtual Const const FSharedSceneOutlinerData &  
Public function Virtual Const const STreeView< FSceneOutlinerTreeItemPtr > &

GetTree ()

 Get a const reference to the actual tree hierarchy
Public function Virtual Const bool

IsFilterActive ( const FString& FilterName
)

 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).
Public function Virtual bool Returns true if edit paste can be executed
Public function Virtual void

PinItems ( const TArray< FSceneOutlinerTreeItemPtr >& InItems
)

 Pins an item list in the outliner.
Public function Virtual void Pin selected items
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 ColumnId
)

 Remove a column of the scene outliner
Public function Virtual bool Remove a filter from the scene outliner
Public function Virtual bool Remove an interactive filter from the scene outliner
Public function Virtual bool Returns true if edit rename can be executed
Public function Virtual void Executes rename.
Public function Virtual void Request that the tree be sorted at a convenient time
Public function Virtual void Set the keyboard focus to the outliner
Public function Virtual void

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

 Set the item selection of the outliner based on a selector function.
Public function Virtual void

UnpinItems ( const TArray< FSceneOutlinerTreeItemPtr >& InItems
)

 Unpins an item list in the outliner.
Public function Virtual void Unpins selected items

Overridden from SWidget

  Type 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 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

  Type 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

  Type Name Description
Public struct FArguments    

Typedefs

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page