1. Epic GamesDeveloper
  3. SSCSEditor

SSCSEditor

API > API/Editor > API/Editor/Kismet

Inheritance Hierarchy

References

   
Module Kismet
Header /Engine/Source/Editor/Kismet/Public/SSCSEditor.h
Include #include "SSCSEditor.h"

Syntax

class SSCSEditor : public SCompoundWidget

Variables

  Type Name Description
Public variable TAttribute< class AActor * > ActorContext Attribute that provides access to the Actor context for which we are viewing/editing the SCS.
Public variable TAttribute< bool > AllowEditing Attribute to indicate whether or not editing is allowed.
Public variable TSharedPtr< FUICommandList > CommandList Command list for handling actions in the SSCSEditor
Public variable TAttribute< TSubclassOf< UActorComponent > > ComponentTypeFilter Attribute to limit visible nodes to a particular component type when filtering the tree view.
Public 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.
Public variable FName DeferredRenameRequest Name of a node that has been requested to be renamed
Public variable TAttribute< bool > HideComponentClassCombo Attribute to indicate whether or not the "Add Component" button is visible.
Public variable FOnHighlightPropertyInDetailsView OnHighlightPropertyInDetailsView Delegate to invoke when the given property should be highlighted in the details view (e.g. diff).
Public variable FOnItemDoubleClicked OnItemDoubleClicked Delegate to invoke when an item in the tree is double clicked.
Public variable FSimpleDelegate OnObjectReplaced Delegate to invoke when objects within the SCS tree are replaced (eg, via re-instancing from a BP compile)
Public variable FOnSelectionUpdated OnSelectionUpdated Delegate to invoke on selection update.
Public variable FDelegateHandle PostTickHandle Used to unregister from the post tick event.
Public variable TAttribute< class AActor * > PreviewActor Attribute that provides access to a "preview" Actor context (may not be same as the Actor context that's being edited.
Public variable TSharedPtr< SSCSTreeType > SCSTreeWidget Tree widget

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UActorComponent *

AddNewComponent ( UClass* NewComponentClass,
UObject* Asset,
const FAddNewComponentParams Params
)

 Adds a component to the SCS Table
Public function void

AddNewNode ( FAddedNodeDetails& OutNodeDetails,
TUniquePtr< FScopedTransaction > OngoingCreateTransaction,
USCS_Node* NewNode,
UObject* Asset,
bool bMarkBlueprintModified,
bool bSetFocusToNewItem
)

 Adds a new SCS Node to the component Table
Public function UActorComponent *

AddNewNode ( TUniquePtr< FScopedTransaction > OngoingCreateTransaction,
USCS_Node* NewNode,
UObject* Asset,
bool bMarkBlueprintModified,
bool bSetFocusToNewItem
)

 Adds a new SCS Node to the component Table
Public function void

AddNewNodeForInstancedComponent ( TUniquePtr< FScopedTransaction > OngoingCreateTransaction,
UActorComponent* NewInstanceComponent,
FSCSEditorTreeNodePtrType InParentNodePtr,
UObject* Asset,
bool bSetFocusToNewItem
)

 Adds a new component instance node to the component Table
Protected function FSCSEditorTreeNodePtrType

AddTreeNode ( USCS_Node* InSCSNode,
FSCSEditorTreeNodePtrType InParentNodePtr,
const bool bIsInheritedSCS
)

 Helper method to add a tree node for the given SCS node
Protected function FSCSEditorTreeNodePtrType

AddTreeNodeFromChildActor ( FSCSEditorTreeNodePtrType InNodePtr
)

 Helper method to add a tree node for the given node's child actor node, if present
Protected function FSCSEditorTreeNodePtrType

AddTreeNodeFromComponent ( UActorComponent* InSceneComponent,
FSCSEditorTreeNodePtrType InParentTreeNode
)

 Helper method to add a tree node for the given actor component
Public function Static void

BuildMenuEventsSection ( FMenuBuilder& Menu,
UBlueprint* Blueprint,
UClass* SelectedClass,
FCanExecuteAction CanExecuteActionDelegate,
FGetSelectedObjectsDelegate GetSelectedObjectsDelegate
)

 Fills out an events section in ui.
Protected function void

BuildSubTreeForActorNode ( FSCSEditorActorNodePtrType InActorNode
)

 Helper method to construct the subtree for the given actor (root) node.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool Callbacks to duplicate the selected component
Public function 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
Public function void

Construct ( const FArguments& InArgs
)

  
Protected function Static void

ConstructEvent ( UBlueprint* Blueprint,
const FName EventName,
const FComponentEventConstructionData EventData
)

 Function to construct an event for a node
Public function void Copy selected node(s)
Protected function TSharedPtr< SWidget > Called to display context menu when right clicking on the widget
Protected function Static void

CreateEventsForSelection ( UBlueprint* Blueprint,
FName EventName,
FGetSelectedObjectsDelegate GetSelectedObjectsDelegate
)

 Function to create events for the current selection
Protected function UClass * Creates a new Blueprint component from the specified class type The user will be prompted to pick a new subclass name and a blueprint asset will be created
Protected function UClass * Creates a new C++ component from the specified class type The user will be prompted to pick a new subclass name and code will be recompiled
Public function void Cut selected node(s)
Protected function Const void

DepthFirstTraversal ( const FSCSEditorTreeNodePtrType& InNodePtr,
TSet< FSCSEditorTreeNodePtrType >& OutVisitedNodes,
const TFunctionRef< void(const FSCSEditorTreeNodePtrType&)> 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 FSCSEditorTreeNodePtrType

FindOrCreateParentForExistingComponent ( UActorComponent* InActorComponent,
FSCSEditorActorNodePtrType ActorRootNode
)

  
Protected function Const FSCSEditorTreeNodePtrType  
Protected function Const FSCSEditorTreeNodePtrType  
Protected function Const FSCSEditorTreeNodePtrType

FindTreeNode ( const USCS_Node* InSCSNode,
FSCSEditorTreeNodePtrType InStartNodePtr
)

 Helper method to recursively find a tree node for the given SCS node starting at the given tree node
Protected function Const FSCSEditorTreeNodePtrType

FindTreeNode ( const UActorComponent* InComponent,
FSCSEditorTreeNodePtrType InStartNodePtr
)

 Helper method to recursively find a tree node for the given scene component starting at the given tree node
Protected function Const FSCSEditorTreeNodePtrType

FindTreeNode ( const FName& InVariableOrInstanceName,
FSCSEditorTreeNodePtrType InStartNodePtr
)

 Helper method to recursively find a tree node for the given variable or instance name starting at the given tree node
Public function Const AActor * Returns the Actor context for which we are viewing/editing the SCS.
Public function Const FSCSEditorActorNodePtrType Gets the actor root
Public function Const UBlueprint * Provides access to the Blueprint context that's being edited
Protected function Const void

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

 Returns the set of expandable nodes that are currently collapsed in the UI
Protected function Const EVisibility  
Protected function Const EVisibility  
Protected function Const EVisibility  
Protected function Const TSubclassOf< UActorComponent >  
Protected function Const EVisibility  
Public function Const EComponentEditorMode::Type  
Public function Const FText Callback for the action trees to get the filter text
Public function Const FSCSEditorTreeNodePtrType

GetNodeFromActorComponent ( const UActorComponent* ActorComponent,
bool bIncludeAttachedComponents
)

 Given an actor component, attempts to find an associated tree node.
Public function Const int32 Get the number of currently selected tree nodes
Protected function Const EVisibility  
Protected function Const const TArray< FSCSEditorTreeNodePtrType > & Gets a root nodes of the tree
Public function Const FSCSEditorTreeNodePtrType Get the root scene node
Public function Const TArray< UObject * >  
Public function Const void Fills the supplied array with the currently selected objects
Public function Const TArray< FSCSEditorTreeNodePtrType > Get the currently selected tree nodes
Public function TSharedPtr< SWidget > Return the button widgets that can add components or create/edit blueprints
Protected function void

HandleItemDoubleClicked ( FSCSEditorTreeNodePtrType InItem
)

 Callback when a component item is double clicked.
Public function void

HighlightTreeNode ( const USCS_Node* Node,
FName Property
)

 Highlight a tree node and, optionally, a property with in it
Public function void

HighlightTreeNode ( FName TreeNodeName,
const FPropertyPath& Property
)

 Highlight a tree node and, optionally, a property with in it
Public function Const bool

IsComponentSelected ( const UPrimitiveComponent* PrimComponent
)

 Returns true if the specified component is currently selected
Public function Const bool Returns true if editing is allowed
Public function Const bool Is this node still used by the Simple Construction Script
Public function TSharedRef< ITableRow >

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

 Used by tree control - make a widget for a table row from a node
Public function void

OnActorSelected ( const ECheckBoxState NewCheckedState
)

 Called when the Actor is selected.
Protected function Const void Propagates instance changes to the blueprint
Public function void Removes existing selected component nodes from the SCS
Public function void  
Protected function void

OnFilterTextChanged ( const FText& InFilterText
)

 Recursively updates the filtered state for each component item
Public function void Callbacks to find references of the selected component
Protected function Const FText  
Public function void

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

 Used by tree control - get children for a specified node
Protected function Const FText  
Public function Const ECheckBoxState Called to determine if actor is selected.
Protected function void

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

 Callback when a component item is scrolled into view
Protected function void Called when the level editor requests a component to be renamed.
Protected function void

OnObjectsReplaced ( const TMap< UObject*, UObject* >& OldToNewInstanceMap
)

 Called when component objects are replaced following construction script execution
Protected function Const void

OnOpenBlueprintEditor ( bool bForceCodeEditing
)

 Opens the blueprint editor for the blueprint being viewed by the scseditor
Public 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

OnRenameComponent ( TUniquePtr< FScopedTransaction > OngoingCreateTransaction
)

 Requests a rename on the selected component just after creation so that the user can provide the initial component name (overwriting the default generated one), which is considered part of the creation process.
Protected function void Requests a rename on the selected component.
Protected function void Resets instance changes to the blueprint default
Public function void

OnTreeSelectionChanged ( FSCSEditorTreeNodePtrType InSelectedNodePtr,
ESelectInfo::Type SelectInfo
)

 Called when selection in the tree changes
Public function void Pastes previously copied node(s)
Protected function UActorComponent *

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 Const void Converts the current actor instance to a blueprint
Protected function bool

RefreshFilteredState ( FSCSEditorTreeNodePtrType 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
Public function void

RemoveComponentNode ( FSCSEditorTreeNodePtrType InNodePtr
)

 Removes an existing component node from the tree
Protected function void

ReplaceComponentReferencesInTree ( FSCSEditorActorNodePtrType InActorNode,
const TMap< UObject*, UObject* >& OldToNewInstanceMap,
bool& OutHasChanges
)

 Helper method to update component pointers held by the given actor node's subtree
Protected function void

ReplaceComponentReferencesInTree ( const TArray< FSCSEditorTreeNodePtrType >& Nodes,
const TMap< UObject*, UObject* >& OldToNewInstanceMap,
bool& OutHasChanges
)

 Update component pointers held by tree nodes if components have been replaced following construction script execution
Public function Static void Function to save current state of SimpleConstructionScript and nodes associated with it.
Public function Static void Function to save the current state of SCS_Node and its children
Public function void

SelectNode ( FSCSEditorTreeNodePtrType InNodeToSelect,
bool IsCntrlDown
)

 Select the given tree node
Public function void Select the root of the tree
Public function void

SetItemExpansionRecursive ( FSCSEditorTreeNodePtrType Model,
bool bInExpansionState
)

 Handler for recursively expanding/collapsing items
Public function void

SetNodeExpansionState ( FSCSEditorTreeNodePtrType InNodeToChange,
const bool bIsExpanded
)

 Set the expansion state of a node
Public function void

SetSceneRootNode ( FSCSEditorTreeNodePtrType NewSceneRootNode
)

  
Public function Const void Assigns a selection override delegate to the specified component
Public function void Sets UI customizations of this SCSEditor.
Public function FReply Try to handle a drag-drop operation
Public function void

UpdateSelectionFromNodes ( const TArray< FSCSEditorTreeNodePtrType >& SelectedNodes
)

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

UpdateTree ( bool bRegenerateTreeNodes
)

 Refresh the tree control to reflect changes in the SCS
Protected function Static void

ViewEvent ( UBlueprint* Blueprint,
const FName EventName,
const FComponentEventConstructionData EventData
)

 Function to view an event for a node

Overridden from SWidget

  Type Name Description
Public function Virtual FReply

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

 SWidget interface

Classes

  Type Name Description
Public struct FAddedNodeDetails    
Public struct FAddNewComponentParams Adds a component to the SCS tree  
Public struct FArguments    

Typedefs

Name Description
FOnAddExistingComponent  
FOnAddNewComponent  
FOnHighlightPropertyInDetailsView  
FOnItemDoubleClicked  
FOnSelectionUpdated  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page