Navigation
API > API/Editor > API/Editor/EditorInteractiveToolsFramework
Hosts Drag Tools and needed behaviors. Handles an Input Behavior Set, and keeps track of currently active Drag tool.
| Name | UDragToolsBehaviorSource |
| Type | class |
| Header File | /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/Public/EditorDragTools/DragToolsBehaviourSource.h |
| Include Path | #include "EditorDragTools/DragToolsBehaviourSource.h" |
Syntax
UCLASS (Transient, MinimalAPI)
class UDragToolsBehaviorSource :
public UObject ,
public IInputBehaviorSource
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UDragToolsBehaviorSource
Implements Interfaces
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnOnViewportChangeToolToggleDelegate | TMulticastDelegate_NoParams< void > | EditorDragTools/DragToolsBehaviourSource.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveToolType | int | Which type of Drag tool is currently active | EditorDragTools/DragToolsBehaviourSource.h | |
| BehaviorSet | TObjectPtr< UInputBehaviorSet > | Hosting drag tools behaviors | EditorDragTools/DragToolsBehaviourSource.h |
|
| DragTools | TMap< EDragTool::Type, TSharedPtr< FEditorDragToolBehaviorTarget > > | Available Drag Tools, access by using their type (EDragTool::Type) | EditorDragTools/DragToolsBehaviourSource.h | |
| DuplicateDragSelection | TSharedPtr< FEditorDuplicateDragSelection > | Duplicate dragged selection tool | EditorDragTools/DragToolsBehaviourSource.h | |
| EditorInteractiveToolsContextWeak | TWeakObjectPtr< const UEditorInteractiveToolsContext > | EditorDragTools/DragToolsBehaviourSource.h | ||
| MoveCameraWithObject | TSharedPtr< FEditorMoveCameraWithObject > | Move camera together with dragged selection | EditorDragTools/DragToolsBehaviourSource.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DeregisterSource() |
Deregister this Input Behavior Source from the InputRouter | EditorDragTools/DragToolsBehaviourSource.h | |
void Initialize
(
const UEditorInteractiveToolsContext* InInteractiveToolsContext |
Creates and stores the drag tools. | EditorDragTools/DragToolsBehaviourSource.h | |
void RegisterSource() |
Register this Input Behavior Source to the InputRouter | EditorDragTools/DragToolsBehaviourSource.h | |
void RenderTools
(
FViewportClient* InViewportClient, |
Renders the active tool on the specified View/Canvas | EditorDragTools/DragToolsBehaviourSource.h |
Overridden from IInputBehaviorSource
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const UInputBehaviorSet * GetInputBehaviors() |
EditorDragTools/DragToolsBehaviourSource.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool IsViewportChangeToolEnabled() |
EditorDragTools/DragToolsBehaviourSource.h | ||
static FOnOnViewportChangeToolToggleDelegate & OnViewportChangeToolActivated() |
EditorDragTools/DragToolsBehaviourSource.h | ||
static FOnOnViewportChangeToolToggleDelegate & OnViewportChangeToolDeactivated() |
EditorDragTools/DragToolsBehaviourSource.h |