1. Epic GamesDeveloper
  3. FActorBrowsingMode

FActorBrowsingMode

API > API/Editor > API/Editor/SceneOutliner

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

Syntax

class FActorBrowsingMode : public FActorModeInteractive

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

FActorBrowsingMode ( SSceneOutliner* InSceneOutliner,
TWeakObjectPtr< UWorld > InSpecifiedWorldToDisplay
)

   ActorBrowsingMode.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FActorBrowsingMode()

   ActorBrowsingMode.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ApplicableActors TSet< TWeakObjectPtr< AActor > > List of actors which passed the regular filters and may or may not have passed the search filter ActorBrowsingMode.h  
ApplicableUnloadedActors TSet< FWorldPartitionHandle > List of unloaded actors which passed through the regular filters and may or may not have passed the search filter ActorBrowsingMode.h  
bRepresentingWorldGameWorld bool   ActorBrowsingMode.h  
bRepresentingWorldPartitionedWorld bool   ActorBrowsingMode.h  
FilteredActorCount uint32 Number of actors (including unloaded) which have passed through the filters ActorBrowsingMode.h  
FilteredUnloadedActorCount uint32 Number of unloaded actors which have passed through all the filters ActorBrowsingMode.h  
WorldPartitionEditorModule IWorldPartitionEditorModule *   ActorBrowsingMode.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool CanExecuteRename()

 Check whether the Rename can be executed ActorBrowsingMode.h  

void OnActorDescInstanceRemoved ( FWorldPartitionActorDescInstance* InActorDescInstance
)

 Called when an actor desc instance is removed ActorBrowsingMode.h  

void OnActorDescRemoved ( FWorldPartitionActorDesc* InActorDesc
)

 Called when an actor desc is removed ActorBrowsingMode.h  

void OnComponentsUpdated()

 End ISceneOutlinerMode Interface Called by the engine when a component is updated ActorBrowsingMode.h  

void OnDeleteActorsBegin()

 Called by engine when edit delete actors begins ActorBrowsingMode.h  

void OnDeleteActorsEnd()

 Called by engine when edit delete actors ends ActorBrowsingMode.h  

virtual void OnDuplicateActorsBegin()

 Called by engine when edit duplicate actors begins ActorBrowsingMode.h  

virtual void OnDuplicateActorsEnd()

 Called by engine when edit duplicate actors ends ActorBrowsingMode.h  

void OnEditCopyActorsBegin()

 Called by engine when edit copy actors begins ActorBrowsingMode.h  

void OnEditCopyActorsEnd()

 Called by engine when edit copy actors ends ActorBrowsingMode.h  

void OnEditCutActorsBegin()

 Called by engine when edit cut actors begins ActorBrowsingMode.h  

void OnEditCutActorsEnd()

 Called by engine when edit cut actors ends ActorBrowsingMode.h  

virtual void OnEditPasteActorsBegin()

 Called by engine when edit paste actors begins ActorBrowsingMode.h  

virtual void OnEditPasteActorsEnd()

 Called by engine when edit paste actors ends ActorBrowsingMode.h  

void OnLevelActorDeleted ( AActor* Actor
)

 Called by the engine when an actor is deleted ActorBrowsingMode.h  

void OnSelectUnloadedActors ( const TArray< FGuid >& ActorGuids
)

 Called by the editor to allow selection of unloaded actors ActorBrowsingMode.h  

Overridden from ISceneOutlinerMode

Name Remarks Include Path Unreal Specifiers

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

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

virtual bool CanCopy()

 Can the current selection be copied ActorBrowsingMode.h  

virtual bool CanCut()

 Can the current selection be cut ActorBrowsingMode.h  

virtual bool CanDelete()

 Can the current selection be deleted ActorBrowsingMode.h  

virtual bool CanPaste()

 Can the current selection be pasted ActorBrowsingMode.h  

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

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

virtual bool CanRename()

 Can the current selection be renamed ActorBrowsingMode.h  

virtual bool CanRenameItem ( const ISceneOutlinerTreeItem& Item
) const

 Check if an item can be renamed ActorBrowsingMode.h  

virtual bool CanSupportDragAndDrop()

 Does the mode support drag and drop ActorBrowsingMode.h  

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

 Returns true if any of the items can be unpinned. ActorBrowsingMode.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 ActorBrowsingMode.h  

virtual TSharedPtr< SWidget > CreateContextMenu()

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

virtual bool CreateFolder ( const FFolder& NewFolder
)

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

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

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

virtual FFolder CreateNewFolder()

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

virtual FText GetErrorsText()

 Return the errors text ActorBrowsingMode.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) ActorBrowsingMode.h  

virtual ESelectionMode::Type GetSelectionMode()

 Get the current selection mode ActorBrowsingMode.h  

virtual FText GetStatusText()

 Get the current status text ActorBrowsingMode.h  

virtual FSlateColor GetStatusTextColor()

 Get the color of the status text ActorBrowsingMode.h  

virtual bool HasCustomFolderDoubleClick()

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

virtual bool HasErrors()

 Does the mode reports errors ActorBrowsingMode.h  

virtual void InitializeViewMenuExtender ( TSharedPtr< FExtender > Extender
)

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

virtual void OnDuplicateSelected()

 Trigger a duplication of selected items ActorBrowsingMode.h  

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

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

virtual void OnItemAdded ( FSceneOutlinerTreeItemPtr Item
)

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

virtual void OnItemDoubleClick ( FSceneOutlinerTreeItemPtr Item
)

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

virtual void OnItemPassesFilters ( const ISceneOutlinerTreeItem& Item
)

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

virtual void OnItemRemoved ( FSceneOutlinerTreeItemPtr Item
)

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

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

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

virtual FReply OnKeyDown ( const FKeyEvent& InKeyEvent
)

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

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

 Pins an item list in the outliner ActorBrowsingMode.h  

virtual void Rebuild()

 Begin ISceneOutlinerMode Interface ActorBrowsingMode.h  

virtual void RepairErrors()

 Repair errors ActorBrowsingMode.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 ActorBrowsingMode.h  

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

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

virtual bool ShouldShowFolders()

 Should folders be shown in the outliner ActorBrowsingMode.h  

virtual bool ShowFilterOptions()

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

virtual bool ShowStatusBar()

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

virtual bool ShowViewButton()

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

virtual bool SupportsCreateNewFolder()

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

virtual bool SupportsKeyboardFocus()

 Does the mode support keyboard focus ActorBrowsingMode.h  

virtual void SynchronizeSelection()

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

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

 Unpins an item list in the outliner ActorBrowsingMode.h  

Static

Name Remarks Include Path Unreal Specifiers

static TSharedRef< FSceneOutlinerFilter > CreateHideComponentsFilter()

   ActorBrowsingMode.h  

static TSharedRef< FSceneOutlinerFilter > CreateHideEmptyFoldersFilter()

   ActorBrowsingMode.h  

static TSharedRef< FSceneOutlinerFilter > CreateHideUnloadedActorsFilter()

   ActorBrowsingMode.h  

static TSharedRef< FSceneOutlinerFilter > CreateIsInCurrentDataLayersFilter()

   ActorBrowsingMode.h  

static TSharedRef< FSceneOutlinerFilter > CreateIsInCurrentLevelFilter()

   ActorBrowsingMode.h  

static TSharedRef< FSceneOutlinerFilter > CreateShowOnlySelectedActorsFilter()

 Filter factories ActorBrowsingMode.h  

static void FillDefaultContextBaseMenu ( UToolMenu* InMenu
)

   ActorBrowsingMode.h  

static void RegisterContextMenu()

 Register the context menu with the engine ActorBrowsingMode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page