1. Epic GamesDeveloper
  3. ISceneOutliner

ISceneOutliner

The public interface for the Scene Outliner widget

API > API/Editor > API/Editor/SceneOutliner

The public interface for the Scene Outliner widget

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

Syntax

class ISceneOutliner : public SCompoundWidget

Inheritance Hierarchy

Derived Classes

Functions

Public

Name Remarks Include Path Unreal Specifiers

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 ISceneOutliner.h  

int32 AddFilter ( const TSharedRef< FSceneOutlinerFilter >& Filter
)

 Add a filter to the scene outliner ISceneOutliner.h  

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

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

int32 AddInteractiveFilter ( const TSharedRef< FSceneOutlinerFilter >& Filter
)

 Add an interactive filter to the scene outliner ISceneOutliner.h  

void CacheIconForClass ( FName InClassName,
const FSlateBrush* InSlateBrush
)

 Sets the cached icon for this class name ISceneOutliner.h  

bool CanExecuteRenameRequest ( const ISceneOutlinerTreeItem& ItemPtr
) const

 Should the scene outliner accept a request to rename a item of the tree ISceneOutliner.h  

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

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

bool CanPinSelectedItems()

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

bool CanSupportDragAndDrop()

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

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

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

bool CanUnpinSelectedItems()

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

bool Copy_CanExecute()

 Returns true if edit copy can be executed ISceneOutliner.h  

bool Cut_CanExecute()

 Returns true if edit cut can be executed ISceneOutliner.h  

bool Delete_CanExecute()

 Returns true if edit delete can be executed ISceneOutliner.h  

void DisableAllFilterBarFilters ( bool bRemove
)

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

void FrameItem ( const FSceneOutlinerTreeItemID& Item
)

 Scrolls the outliner to the specified item if it's found. No action is done otherwise. ISceneOutliner.h  
Scrolls the outliner to the selected item(s). ISceneOutliner.h  

void FullRefresh()

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

const FSlateBrush * GetCachedIconForClass ( FName InClassName
) const

 Gets the cached icon for this class name ISceneOutliner.h  

TArray< FName > GetColumnIds()

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

EColumnSortMode::Type GetColumnSortMode ( const FName ColumnId
) const

 Return the sorting mode for the specified ColumnId ISceneOutliner.h  

TSharedPtr< FSceneOutlinerFilter > GetFilterAtIndex ( int32 Index
)

 Retrieve the filter at the specified index ISceneOutliner.h  

int32 GetFilterCount()

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

TAttribute< FText > GetFilterHighlightText()

   ISceneOutliner.h  

TSharedPtr< FSceneOutlinerTreeItemSCC > GetItemSourceControl ( const FSceneOutlinerTreeItemPtr& InItem
)

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

const ISceneOutlinerMode * GetMode()

 Get the active SceneOutlinerMode ISceneOutliner.h  

const FSharedSceneOutlinerData & GetSharedData()

   ISceneOutliner.h  

const STreeView< FSceneOutlinerTreeItemPtr > & GetTree()

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

FSceneOutlinerTreeItemPtr GetTreeItem ( FSceneOutlinerTreeItemID,
bool bIncludePending
)

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

uint32 GetTypeSortPriority ( const ISceneOutlinerTreeItem& Item
) const

   ISceneOutliner.h  

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). ISceneOutliner.h  

bool Paste_CanExecute()

 Returns true if edit paste can be executed ISceneOutliner.h  

void PinItems ( const TArray< FSceneOutlinerTreeItemPtr >& InItems
)

 Pins an item list in the outliner. ISceneOutliner.h  

void PinSelectedItems()

 Pin selected items ISceneOutliner.h  

void Refresh()

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

void RemoveColumn ( FName ColumnId
)

 Remove a column of the scene outliner ISceneOutliner.h  

bool RemoveFilter ( const TSharedRef< FSceneOutlinerFilter >& Filter
)

 Remove a filter from the scene outliner ISceneOutliner.h  

bool RemoveInteractiveFilter ( const TSharedRef< FSceneOutlinerFilter >& Filter
)

 Remove an interactive filter from the scene outliner ISceneOutliner.h  

bool Rename_CanExecute()

 Returns true if edit rename can be executed ISceneOutliner.h  

void Rename_Execute()

 Executes rename. ISceneOutliner.h  

void RequestSort()

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

void SetKeyboardFocus()

 Set the keyboard focus to the outliner ISceneOutliner.h  

void SetNextUIRefreshDelay ( float InDelay
)

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

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

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

void UnpinItems ( const TArray< FSceneOutlinerTreeItemPtr >& InItems
)

 Unpins an item list in the outliner. ISceneOutliner.h  

void UnpinSelectedItems()

 Unpins selected items ISceneOutliner.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page