1. Epic GamesDeveloper
  3. ISceneOutlinerMode

ISceneOutlinerMode

API > API/Editor > API/Editor/SceneOutliner

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

Syntax

class ISceneOutlinerMode

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  ISceneOutlinerMode.h  

ISceneOutlinerMode ( SSceneOutliner* InSceneOutliner
)

   ISceneOutlinerMode.h  
  ISceneOutlinerMode.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~ISceneOutlinerMode()

   ISceneOutlinerMode.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void BindCommands ( const TSharedRef< FUICommandList >& OutCommandList
)

 Bind commands for this mode to the given CommandList ISceneOutlinerMode.h  

virtual bool CanCopy()

 Can the current selection be copied ISceneOutlinerMode.h  

virtual bool CanCustomizeToolbar()

 Whether the toolbar can be customized. ISceneOutlinerMode.h  

virtual bool CanCut()

 Can the current selection be cut ISceneOutlinerMode.h  

virtual bool CanDelete()

 Can the current selection be deleted ISceneOutlinerMode.h  

virtual bool CanInteract ( const ISceneOutlinerTreeItem& Item
) const

 Check if an item is interactive ISceneOutlinerMode.h  

virtual bool CanPaste()

 Can the current selection be pasted ISceneOutlinerMode.h  

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

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

virtual bool CanPopulate()

 Check if we are allowed to repopulate ISceneOutlinerMode.h  

virtual bool CanRename()

 Can the current selection be renamed ISceneOutlinerMode.h  

virtual bool CanRenameItem ( const ISceneOutlinerTreeItem& Item
) const

 Check if an item can be renamed ISceneOutlinerMode.h  

virtual bool CanSupportDragAndDrop()

 Does the mode support drag and drop ISceneOutlinerMode.h  

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

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

virtual bool CompareItemWithClassName ( SceneOutliner::FilterBarType InItem,
const TSet< FTopLevelAssetPath >&
) const

 Function called by the Outliner Filter Bar to compare an item with Type Filters ISceneOutlinerMode.h  

virtual TSharedPtr< SWidget > CreateContextMenu()

 Returns a context menu widget based on the current selection ISceneOutlinerMode.h  

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

 Construct a new Drag and drop operation ISceneOutlinerMode.h  

virtual bool CreateFolder ( const FFolder& NewFolder
)

 Create a folder under a specific parent with a given leaf name ISceneOutlinerMode.h  

virtual FCreateSceneOutlinerMode CreateFolderPickerMode ( const FFolder::FRootObject& InRootObject
) const

 Returns a factory to create a Folder Picker mode which matches this mode ISceneOutlinerMode.h  

FSceneOutlinerTreeItemPtr CreateItemFor ( const TreeItemData& Data,
bool bForce
)

 Attempt to create a tree item for a given data type. ISceneOutlinerMode.h  

virtual FFolder CreateNewFolder()

 Creates a new folder item at the root with a valid name ISceneOutlinerMode.h  

virtual void CreateViewContent ( FMenuBuilder& MenuBuilder
)

 Fill the view button menu with content ISceneOutlinerMode.h  

virtual FText GetErrorsText()

 Return the errors text ISceneOutlinerMode.h  

TMap< FName, FSceneOutlinerFilterInfo > & GetFilterInfos()

   ISceneOutlinerMode.h  

virtual FFolder GetFolder ( const FFolder& ParentPath,
const FName& LeafName
)

 Returns a unique folder path for a specific parent with a given leaf name (without creating it) ISceneOutlinerMode.h  

ISceneOutlinerHierarchy * GetHierarchy()

   ISceneOutlinerMode.h  

virtual FFolder::FRootObject GetPasteTargetRootObject()

 Returns the target root object for a paste operation ISceneOutlinerMode.h  

virtual FFolder::FRootObject GetRootObject()

 Returns the root object of this outliner mode ISceneOutlinerMode.h  

virtual ESelectionMode::Type GetSelectionMode()

 Get the current selection mode ISceneOutlinerMode.h  

virtual FText GetStatusText()

 Get the current status text ISceneOutlinerMode.h  

virtual FSlateColor GetStatusTextColor()

 Get the color of the status text ISceneOutlinerMode.h  

virtual int32 GetTypeSortPriority ( const ISceneOutlinerTreeItem& Item
) const

 Get the sort priority of an item ISceneOutlinerMode.h  

virtual bool HasCustomFolderDoubleClick()

 Returns true if this mode overrides the default folder double click behavior (expanding the subtree) ISceneOutlinerMode.h  

virtual bool HasErrors()

 Does the mode reports errors ISceneOutlinerMode.h  

virtual void InitializeViewMenuExtender ( TSharedPtr< FExtender > Extender
)

 Allows extending SceneOutliner View Button MenuBuilder (allows using ExtensionHooks which isn't possible with CreateViewContent override) ISceneOutlinerMode.h  

virtual bool IsInteractive()

 Is the mode interactive ISceneOutlinerMode.h  

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

 Called when a payload is dragged over an item ISceneOutlinerMode.h  

virtual void OnDrop ( ISceneOutlinerTreeItem& DropTarget,
const FSceneOutlinerDragDropPayload& Payload,
const FSceneOutlinerDragValidationInfo& ValidationInfo
) const

 Called when a payload is dropped onto a target ISceneOutlinerMode.h  

virtual void OnDuplicateSelected()

 Trigger a duplication of selected items ISceneOutlinerMode.h  

virtual void OnFilterTextChanged ( const FText& InFilterText
)

 Called by the outliner when search box text is changed ISceneOutlinerMode.h  

virtual void OnFilterTextCommited ( FSceneOutlinerItemSelection& Selection,
ETextCommit::Type CommitType
)

 Called by the outliner when search box text is committed (by pressing enter) ISceneOutlinerMode.h  

virtual void OnItemAdded ( FSceneOutlinerTreeItemPtr Item
)

 Called by the outliner when a new item is added to the outliner tree ISceneOutlinerMode.h  

virtual void OnItemClicked ( FSceneOutlinerTreeItemPtr Item
)

 Called by the outliner when a tree item is single-clicked ISceneOutlinerMode.h  

virtual void OnItemDoubleClick ( FSceneOutlinerTreeItemPtr Item
)

 Called by the outliner when a tree item is double clicked ISceneOutlinerMode.h  

virtual void OnItemPassesFilters ( const ISceneOutlinerTreeItem& Item
)

 Called by the outliner when an item passes filters but isn't yet added to the tree ISceneOutlinerMode.h  

virtual void OnItemRemoved ( FSceneOutlinerTreeItemPtr Item
)

 Called by the outliner when an item is removed from the outliner tree ISceneOutlinerMode.h  

virtual void OnItemSelectionChanged ( FSceneOutlinerTreeItemPtr Item,
ESelectInfo::Type SelectionType,
const FSceneOutlinerItemSelection& Selection
)

 Called by the outliner when an item is selected in the tree. ISceneOutlinerMode.h  

virtual FReply OnKeyDown ( const FKeyEvent& InKeyEvent
)

 Called by the outliner when a key is pressed ISceneOutlinerMode.h  

virtual bool ParseDragDrop ( FSceneOutlinerDragDropPayload& OutPayload,
const FDragDropOperation& Operation
) const

 Populates a drag/drop operation if the mode supports that type of operation. ISceneOutlinerMode.h  

virtual void PinItems ( const TArray< FSceneOutlinerTreeItemPtr >& InItems
)

 Pins an item list in the outliner ISceneOutlinerMode.h  

void Rebuild()

 Rebuild all mode data ISceneOutlinerMode.h  

virtual void RepairErrors()

 Repair errors ISceneOutlinerMode.h  

virtual bool ReparentItemToFolder ( const FFolder& FolderPath,
const FSceneOutlinerTreeItemPtr& Item
)

 Reparent an item to a given folder path. Returns true if the operation is sucessful ISceneOutlinerMode.h  

virtual void SelectFoldersDescendants ( const TArray< FFolderTreeItem* >& FolderItems,
bool bSelectImmediateChildrenOnly
)

 Select all descendants of a folder. Optionally select only immediate descendants. ISceneOutlinerMode.h  

virtual bool ShouldShowFolders()

 Should folders be shown in the outliner ISceneOutlinerMode.h  

virtual bool ShowFilterOptions()

 Does the mode allow the user to enable and disable filters through a menu ISceneOutlinerMode.h  

virtual bool ShowStatusBar()

 Does the mode want to display a status bar ISceneOutlinerMode.h  

virtual bool ShowViewButton()

 Does the mode want to display a view button ISceneOutlinerMode.h  

virtual bool SupportsCreateNewFolder()

 Should the new folder button be displayed by the outliner ISceneOutlinerMode.h  

virtual bool SupportsKeyboardFocus()

 Does the mode support keyboard focus ISceneOutlinerMode.h  

virtual void SynchronizeSelection()

 Synchronize the mode specific selection with the tree view ISceneOutlinerMode.h  

virtual void Tick()

 Function called at the start of the Outliner's tick to allow the mode to perform operations ISceneOutlinerMode.h  

virtual void UnpinItems ( const TArray< FSceneOutlinerTreeItemPtr >& InItems
)

 Unpins an item list in the outliner ISceneOutlinerMode.h  

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

 Test whether the specified payload can be dropped onto this tree item ISceneOutlinerMode.h  

Protected

Name Remarks Include Path Unreal Specifiers

TUniquePtr< ISceneOutlinerHierarchy > CreateHierarchy()

   ISceneOutlinerMode.h  

Operators

Name Remarks Include Path Unreal Specifiers

ISceneOutlinerMode & operator= ( const ISceneOutliner&
)

   ISceneOutlinerMode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page