Navigation
API > API/Editor > API/Editor/EditorInteractiveToolsFramework
The base class that all drag tools inherit from. The drag tools implement special behaviors for the user clicking and dragging in a viewport.
| Name | UDragToolInteraction |
| Type | class |
| Header File | /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/Public/EditorDragTools/DragToolInteraction.h |
| Include Path | #include "EditorDragTools/DragToolInteraction.h" |
Syntax
UCLASS (MinimalAPI, Transient)
class UDragToolInteraction :
public UViewportInteraction ,
public IViewportClickDragBehaviorTarget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UViewportInteraction → UDragToolInteraction
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDragToolInteraction() |
EditorDragTools/DragToolInteraction.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnToolStateChange | TMulticastDelegate_NoParams< void > | EditorDragTools/DragToolInteraction.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bConvertDelta | bool | Does this drag tool need to have the mouse movement converted to the viewport orientation? | EditorDragTools/DragToolInteraction.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool IsDragging() |
EditorDragTools/DragToolInteraction.h | ||
FOnToolStateChange & OnActivateTool() |
EditorDragTools/DragToolInteraction.h | ||
FOnToolStateChange & OnDeactivateTool() |
EditorDragTools/DragToolInteraction.h |
Public Virtual
Overridden from UViewportInteraction
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Initialize
(
UViewportInteractionsBehaviorSource*const InViewportInteractionsBehaviorSource |
Initialization code which can be expanded by derived classes | EditorDragTools/DragToolInteraction.h |
Overridden from IViewportClickDragBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit CanBeginClickDragSequence
(
const FInputDeviceRay& PressPos |
Test if target can begin click-drag interaction at this point | EditorDragTools/DragToolInteraction.h | |
virtual void OnDrag
(
const FDragArgs& InDrag |
Notify Target that input position has changed | EditorDragTools/DragToolInteraction.h | |
virtual void OnDragEnd
(
const FInputDeviceRay& InDragEndPos |
Notify Target that drag has ended | EditorDragTools/DragToolInteraction.h | |
virtual void OnDragStart
(
const FInputDeviceRay& InDragStartPos |
Notify Target that drag has started | EditorDragTools/DragToolInteraction.h | |
virtual void OnEndCapture
(
EEndCaptureReason InReason |
Notify Target that capture has ended. | EditorDragTools/DragToolInteraction.h | |
virtual void OnStateUpdated
(
const FInputDeviceState& InInputDeviceState |
Notify Target button state has changed | EditorDragTools/DragToolInteraction.h |
Protected Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool ShouldDraw
(
const EViewInteractionState InInteractionState |
EditorDragTools/DragToolInteraction.h |