1. Epic GamesDeveloper
  3. SSubobjectEditor

SSubobjectEditor

The base class viewer for subobject editing in Slate.

API > API/Editor > API/Editor/SubobjectEditor

Inheritance Hierarchy

References

   
Module SubobjectEditor
Header /Engine/Source/Editor/SubobjectEditor/Public/SSubobjectEditor.h
Include #include "SSubobjectEditor.h"

Syntax

class SSubobjectEditor : public SCompoundWidget

Remarks

The base class viewer for subobject editing in Slate. This displays all subobjects of a given actor or blueprint. A subobject can be a native component on an actor or inherited components from a native or blueprint parent.

Variables

  Type Name Description
Protected variable TAttribute< bool > AllowEditing Attribute to indicate whether or not editing is allowed.
Protected variable bool bAllowTreeUpdates Controls whether or not to allow calls to UpdateTree()
Protected variable bool bUpdatingSelection Gate to prevent changing the selection while selection change is being broadcast.
Protected variable TSharedPtr< SHorizontalBox > ButtonBox The tools buttons box
Protected variable FSubobjectDataHandle CachedRootHandle The handle to the current root context.
Protected variable TSharedPtr< FUICommandList > CommandList Command list for handling actions in the editor.
Protected variable TSharedPtr< SComponentClassCombo > ComponentClassCombo The add component button / type selector
Protected variable TAttribute< TSubclassOf< UActorComponent > > ComponentTypeFilter Attribute to limit visible nodes to a particular component type when filtering the tree view.
Protected variable TUniquePtr< FScopedTransaction > DeferredOngoingCreateTransaction Scope the creation of a component which ends when the initial component 'name' is given/accepted by the user, which can be several frames after the component was actually created.
Protected variable FSubobjectDataHandle DeferredRenameRequest Name of a node that has been requested to be renamed
Protected variable TSharedPtr< SExtensionPanel > ExtensionPanel SCSEditor UI extension
Protected variable TSharedPtr< SSearchBox > FilterBox The filter box that handles filtering for the tree.
Protected variable TAttribute< bool > HideComponentClassCombo Attribute to indicate whether or not the "Add Component" button is visible.
Protected variable TAttribute< UObject * > ObjectContext Attribute that provides access to the Object context for which we are viewing/editing.
Protected variable FOnItemDoubleClicked OnItemDoubleClicked Delegate to invoke when an item in the tree is double clicked.
Protected variable FOnSelectionUpdated OnSelectionUpdated Delegate to invoke on selection update.
Protected variable FDelegateHandle PostTickHandle Used to unregister from the post tick event.
Protected variable TArray< FSubobjectEditorTreeNodePtrType > RootNodes Root set of tree that represents all subobjects for the current context
Protected variable TSharedPtr< SSubobjectEditorDragDropTree > TreeWidget Tree widget
Protected variable TSharedPtr< ISCSEditorUICustomization > UICustomization SCSEditor UI customizations

Constructors

  Type Name Description
Protected function   Do not allow public construction of this widget!

Destructors

  Type Name Description
Protected function Virtual    

Functions

  Type Name Description
Protected function FSubobjectDataHandle

AddNewSubobject ( const FSubobjectDataHandle& ParentHandle,
UClass* NewClass,
UObject* AssetOverride,
FText& OutFailReason,
TUniquePtr< FScopedTransaction > InOngoingTransaction
)

 Add a new subobject to the given parent via the subobject data subsystem
Public function TSharedPtr< SWidget >

BuildSceneRootDropActionMenu ( FSubobjectEditorTreeNodePtrType DroppedOntoNodePtr,
FSubobjectEditorTreeNodePtrType DroppedNodePtr
)

 Builds a context menu popup for dropping a child node onto the scene root node
Protected function Const bool  
Protected function Const bool  
Public function Virtual Const bool Removes existing selected component nodes from the SCS
Protected function Const bool  
Public function Virtual Const bool

CanMakeNewRootOnDrag ( UBlueprint* DraggedFromBlueprint
)

  
Protected function Virtual Const bool Pastes previously copied node(s)
Protected function Const bool Checks to see if renaming is allowed on the selected component
Public function void Clears the current selection
Protected function Virtual Const bool If true, then the tree widget will clear selection on click.
Protected function Virtual void Constructs the slate drag/drop tree for this subobject editor
Protected function void  
Protected function Virtual void Creates a list of commands
Protected function TSharedPtr< SWidget > Called to display context menu when right clicking on the widget
Protected function Virtual FMenuBuilder  
Protected function void  
Protected function Const void

DepthFirstTraversal ( const FSubobjectEditorTreeNodePtrType& InNodePtr,
TSet< FSubobjectEditorTreeNodePtrType >& OutVisitedNodes,
const TFunctionRef< void(const FSubobjectEditorTreeNodePtrType&)> InFunction
)

 Recursively visits the given node + its children and invokes the given function for each.
Public function void Dumps out the tree view contents to the log (used to assist with debugging widget hierarchy issues)
Protected function Static FSubobjectEditorTreeNodePtrType

FindOrCreateSlateNodeForHandle ( const FSubobjectDataHandle& Handle,
TMap< FSubobjectDataHandle, FSubobjectEditorTreeNodePtrType >& ExistingNodes
)

 Attempt to find an existing slate node that matches the given handle.
Public function Const FSubobjectEditorTreeNodePtrType

FindSlateNodeForHandle ( const FSubobjectDataHandle& Handle,
FSubobjectEditorTreeNodePtrType InStartNodePtr
)

 Attempt to find an existing slate node that matches the given handle.
Public function Virtual Const FSubobjectEditorTreeNodePtrType

FindSlateNodeForObject ( const UObject* InObject,
bool bIncludeAttachmentComponents
)

 Attempt to find an existing slate node that matches the given handle.
Public function Const FSubobjectEditorTreeNodePtrType

FindSlateNodeForVariableName ( FName InVariableName
)

 Attempt to find an existing slate node that has a given variable name.
Public function Const UBlueprint * Provides access to the Blueprint context that's being edited
Protected function Const void

GetCollapsedNodes ( const FSubobjectEditorTreeNodePtrType& InNodePtr,
TSet< FSubobjectEditorTreeNodePtrType >& OutCollapsedNodes
)

 Returns the set of expandable nodes that are currently collapsed in the UI
Public function Virtual Const FSlateColor

GetColorTintForIcon ( FSubobjectEditorTreeNodePtrType Node
)

 Get the tint color that any subobject editor icons should use. The default is the foreground color.
Public function Const TSharedPtr< FUICommandList >  
Protected function Virtual Const EVisibility  
Protected function Const EVisibility  
Protected function Const EVisibility  
Protected function Const TSubclassOf< UActorComponent >  
Public function Const TSharedPtr< SSubobjectEditorDragDropTree >  
Protected function Virtual Const EVisibility  
Protected function Const FText Callback for the action trees to get the filter text
Public function Const int32 Returns the number of currently selected nodes in the tree
Public function Const UObject * Pointer to the current object that is represented by the subobject editor
Public function Const FSubobjectDataHandle SubobjectHandle of the current object that is represented by the subobject editor
Protected function Virtual Const EVisibility  
Public function Const const TArray< FSubobjectEditorTreeNodePtrType > & Return an array of the current slate node hierarchy in the tree
Public function Virtual Const FSubobjectEditorTreeNodePtrType  
Public function Const TArray< FSubobjectDataHandle > Get the currently selected handles from the tree sorted in order from parent to child
Public function Const void Fills the supplied array with the currently selected objects
Public function Const TArray< FSubobjectEditorTreeNodePtrType > Get the currently selected nodes from the tree sorted in order from parent to child
Public function Const TSharedPtr< SWidget > Return the button widgets that can add components or create/edit blueprints
Protected function void

HandleItemDoubleClicked ( FSubobjectEditorTreeNodePtrType InItem
)

 Callback when a component item is double clicked.
Public function Const bool

IsComponentSelected ( const UPrimitiveComponent* PrimComponent
)

 Returns true if the specified component is currently selected
Public function Virtual Const bool  
Protected function TSharedRef< ITableRow >

MakeTableRowWidget ( FSubobjectEditorTreeNodePtrType InNodePtr,
const TSharedRef< STableViewBase >& OwnerTable
)

 Widget Callbacks.
Public function void

OnAttachToDropAction ( FSubobjectEditorTreeNodePtrType DroppedOn,
FSubobjectEditorTreeNodePtrType DroppedNodePtr
)

 Drag/drop operations.
Public function void

OnAttachToDropAction ( FSubobjectEditorTreeNodePtrType DroppedOn,
const TArray< FSubobjectEditorTreeNodePtrType >& DroppedNodePtrs
)

  
Public function void  
Public function void

OnDetachFromDropAction ( const TArray< FSubobjectEditorTreeNodePtrType >& DroppedNodePtrs
)

  
Protected function void  
Protected function void

OnFilterTextChanged ( const FText& InFilterText
)

 Recursively updates the filtered state for each component item
Protected function void  
Protected function void

OnGetChildrenForTree ( FSubobjectEditorTreeNodePtrType InNodePtr,
TArray< FSubobjectEditorTreeNodePtrType >& OutChildren
)

 Used by tree control - get children for a specified subobject node
Protected function void

OnItemScrolledIntoView ( FSubobjectEditorTreeNodePtrType InItem,
const TSharedPtr< ITableRow >& InWidget
)

 Callback when a component item is scrolled into view
Public function void

OnMakeNewRootDropAction ( FSubobjectEditorTreeNodePtrType DroppedNodePtr
)

  
Protected function Const void

OnOpenBlueprintEditor ( bool bForceCodeEditing
)

 Opens the blueprint editor for the blueprint being viewed by the scseditor
Protected function void

OnPostTick ( float
)

 Called at the end of each frame.
Protected function FReply Called when the promote to blueprint button is clicked
Protected function void  
Protected function void

OnRenameComponent ( TUniquePtr< FScopedTransaction > InComponentCreateTransaction
)

  
Protected function void

OnTreeSelectionChanged ( FSubobjectEditorTreeNodePtrType InSelectedNodePtr,
ESelectInfo::Type SelectInfo
)

 Called when selection in the tree changes
Protected function void  
Protected function FSubobjectDataHandle

PerformComboAddClass ( TSubclassOf< UActorComponent > ComponentClass,
EComponentCreateAction::Type ComponentCreateAction,
UObject* AssetOverride
)

 Add a component from the selection in the combo box
Protected function void Populate context menu on the fly
Protected function void

PopulateContextMenuImpl ( UToolMenu* InMenu,
TArray< FSubobjectEditorTreeNodePtrType >& InSelectedItems,
bool bIsChildActorSubtreeNodeSelected
)

 Populate the context menu with implementation specific details
Public function void

PostDragDropAction ( bool bRegenerateTreeNodes
)

  
Protected function Const void Converts the current actor instance to a blueprint
Public function void Refresh the type list presented by the add component button when clicked
Protected function bool

RefreshFilteredState ( FSubobjectEditorTreeNodePtrType TreeNode,
bool bRecursive
)

 Compares the filter bar's text with the item's component name.
Public function void Forces the details panel to refresh on the same objects
Protected function void Registers context menu by name for later access
Protected function Virtual void

RestoreSelectionState ( TArray< FSubobjectEditorTreeNodePtrType >& SelectedTreeNodes,
bool bFallBackToVariableName
)

 Restore the previous selection state when updating the tree
Public function void

SelectNode ( FSubobjectEditorTreeNodePtrType InNodeToSelect,
bool bIsCntrlDown
)

 Select the given tree node
Public function void

SelectNodeFromHandle ( const FSubobjectDataHandle& InHandle,
bool bIsCntrlDown
)

 Select the given tree node if there is on that matches the given handle
Public function void Select the root of the tree
Protected function void

SetItemExpansionRecursive ( FSubobjectEditorTreeNodePtrType Model,
bool bInExpansionState
)

 Handler for recursively expanding/collapsing items
Protected function void

SetNodeExpansionState ( FSubobjectEditorTreeNodePtrType InNodeToChange,
const bool bIsExpanded
)

 Set the expansion state of a node
Public function Const void Assigns a selection override delegate to the specified component
Public function void Sets UI customizations of this SCSEditor.
Protected function Virtual Const bool If true, then the blueprint should be modified on TryHandleAssetDragDropOperation
Protected function Virtual Const bool Indicates whether or not the search bar and inline buttons are visible.
Protected function UClass * Spawns a new SWindow giving the user options for creating a new blueprint component class.
Protected function UClass * Spawns a new SWindow giving the user options for creating a new C++ component class.
Public function FReply Try to handle a drag-drop operation
Protected function void

UpdateSelectionFromNodes ( const TArray< FSubobjectEditorTreeNodePtrType >& SelectedNodes
)

 Update any associated selection (e.g. details view) from the passed in nodes
Public function void

UpdateTree ( bool bRegenerateTreeNodes
)

 Update the contents of the Subobject Tree based on the current context

Overridden from SWidget

  Type Name Description
Protected function Virtual FReply

OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

 SWidget interface

Classes

  Type Name Description
Protected struct Utils Utils.  

Typedefs

Name Description
FOnItemDoubleClicked  
FOnSelectionUpdated  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page