1. Epic GamesDeveloper
  3. ISceneOutliner

ISceneOutliner

The public interface for the Scene Outliner widget

API > API/Editor > API/Editor/SceneOutliner

Inheritance Hierarchy

References

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

Syntax

class ISceneOutliner : public SCompoundWidget

Remarks

The public interface for the Scene Outliner widget

Variables

  Type Name Description
Protected variable ISceneOutlinerMode * Mode  

Functions

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

CacheIconForClass ( FName InClassName,
const FSlateBrush* InSlateBrush
)

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

CanPinItems ( const TArray< FSceneOutlinerTreeItemPtr >& InItems
)

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

CanUnpinItems ( const TArray< FSceneOutlinerTreeItemPtr >& InItems
)

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

GetCachedIconForClass ( FName InClassName
)

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

GetColumnSortMode ( const FName ColumnId
)

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

GetFilterAtIndex ( int32 Index
)

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

GetItemSourceControl ( const FSceneOutlinerTreeItemPtr& InItem
)

 Get the associated source control object for the specified item.
Public function Const const ISceneOutlinerMode *

GetMode ()

 Get the active SceneOutlinerMode
Public function Const const FSharedSceneOutlinerData &  
Public function Const const STreeView< FSceneOutlinerTreeItemPtr > &

GetTree ()

 Get a const reference to the actual tree hierarchy
Public function Const uint32  
Public function 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 bool Returns true if edit paste can be executed
Public function void

PinItems ( const TArray< FSceneOutlinerTreeItemPtr >& InItems
)

 Pins an item list in the outliner.
Public function void Pin selected items
Public function void

Refresh ()

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

RemoveColumn ( FName ColumnId
)

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

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

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

UnpinItems ( const TArray< FSceneOutlinerTreeItemPtr >& InItems
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page