1. Epic GamesDeveloper
  3. FActorBrowsingMode

FActorBrowsingMode

API > API/Editor > API/Editor/SceneOutliner

Inheritance Hierarchy

References

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

Syntax

class FActorBrowsingMode : public FActorModeInteractive

Constructors

  Type Name Description
Public function  

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

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void Called when an actor desc is removed
Public function void End ISceneOutlinerMode Interface Called by the engine when a component is updated
Public function void Called by engine when edit delete actors begins
Public function void Called by engine when edit delete actors ends
Public function void Called by engine when edit duplicate actors begins
Public function void Called by engine when edit duplicate actors ends
Public function void Called by engine when edit copy actors begins
Public function void Called by engine when edit copy actors ends
Public function void Called by engine when edit cut actors begins
Public function void Called by engine when edit cut actors ends
Public function void Called by engine when edit paste actors begins
Public function void Called by engine when edit paste actors ends
Public function void Called by the engine when an actor is deleted
Public function void

OnSelectUnloadedActors ( const TArray< FGuid >& ActorGuids
)

 Called by the editor to allow selection of unloaded actors

Overridden from ISceneOutlinerMode

  Type Name Description
Public function Virtual Const bool

CanCopy ()

 Can the current selection be copied
Public function Virtual Const bool

CanCut ()

 Can the current selection be cut
Public function Virtual Const bool Can the current selection be deleted
Public function Virtual Const bool Can the current selection be pasted
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 Can the current selection be renamed
Public function Virtual Const bool Check if an item can be renamed
Public function Virtual Const bool Does the mode support drag and drop
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 Function called by the Outliner Filter Bar to compare an item with Type Filters
Public function Virtual TSharedPtr< SWidget > Returns a context menu widget based on the current selection
Public function Virtual Const TSharedPtr< FDragDropOperation >

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

 Construct a new Drag and drop operation
Public function Virtual bool

CreateFolder ( const FFolder& NewFolder
)

 Create a folder under a specific parent with a given leaf name
Public function Virtual Const FCreateSceneOutlinerMode Returns a factory to create a Folder Picker mode which matches this mode
Public function Virtual FFolder Creates a new folder item at the root with a valid name
Public function Virtual void

CreateViewContent ( FMenuBuilder& MenuBuilder
)

 Fill the view button menu with content
Public function Virtual Const FText Return the errors text
Public function 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)
Public function Virtual Const ESelectionMode::Type Get the current selection mode
Public function Virtual Const FText Get the current status text
Public function Virtual Const FSlateColor Get the color of the status text
Public function Virtual Const bool Does the mode reports errors
Public function Virtual Const void

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

 Called when a payload is dropped onto a target
Public function Virtual void Trigger a duplication of selected items
Public function Virtual void Called by the outliner when search box text is committed (by pressing enter)
Public function Virtual void

OnItemAdded ( FSceneOutlinerTreeItemPtr Item
)

 Called by the outliner when a new item is added to the outliner tree
Public function Virtual void

OnItemDoubleClick ( FSceneOutlinerTreeItemPtr Item
)

 Called by the outliner when a tree item is double clicked
Public function Virtual void Called by the outliner when an item passes filters but isn't yet added to the tree
Public function Virtual void

OnItemRemoved ( FSceneOutlinerTreeItemPtr Item
)

 Called by the outliner when an item is removed from the outliner tree
Public function Virtual void

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

 Called by the outliner when an item is selected in the tree.
Public function Virtual FReply

OnKeyDown ( const FKeyEvent& InKeyEvent
)

 Called by the outliner when a key is pressed
Public function Virtual Const bool Populates a drag/drop operation if the mode supports that type of operation.
Public function Virtual void

PinItems ( const TArray< FSceneOutlinerTreeItemPtr >& InItems
)

 Pins an item list in the outliner
Public function Virtual void

Rebuild ()

 Begin ISceneOutlinerMode Interface
Public function Virtual Const void Repair errors
Public function Virtual bool

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

 Reparent an item to a given folder path. Returns true if the operation is sucessful
Public function Virtual void

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

 Select all descendants of a folder. Optionally select only immediate descendants.
Public function Virtual Const bool Should folders be shown in the outliner
Public function Virtual Const bool Does the mode allow the user to enable and disable filters through a menu
Public function Virtual Const bool Does the mode want to display a status bar
Public function Virtual Const bool Does the mode want to display a view button
Public function Virtual Const bool Should the new folder button be displayed by the outliner
Public function Virtual Const bool Does the mode support keyboard focus
Public function Virtual void Synchronize the mode specific selection with the tree view
Public function Virtual void

UnpinItems ( const TArray< FSceneOutlinerTreeItemPtr >& InItems
)

 Unpins an item list in the outliner
Public function Virtual Const FSceneOutlinerDragValidationInfo

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

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page