Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
UClickDragTool is a base tool that basically just implements IClickDragBehaviorTarget, and on setup registers a UClickDragInputBehavior. You can subclass this Tool to implement basic click-drag type Tools. If you want to do more advanced things, like handle modifier buttons/keys, you will need to implement IClickDragBehaviorTarget yourself
| Name | UClickDragTool |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseTools/ClickDragTool.h |
| Include Path | #include "BaseTools/ClickDragTool.h" |
Syntax
UCLASS (MinimalAPI)
class UClickDragTool :
public UInteractiveTool ,
public IClickDragBehaviorTarget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInteractiveTool → UClickDragTool
Implements Interfaces
Functions
Public
Overridden from UInteractiveTool
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Setup() |
Register default primary-button-click InputBehaviors | BaseTools/ClickDragTool.h |
Overridden from IClickDragBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit CanBeginClickDragSequence
(
const FInputDeviceRay& PressPos |
IClickBehaviorTarget implementation Test if target can begin click-drag interaction at this point | BaseTools/ClickDragTool.h | |
virtual void OnClickDrag
(
const FInputDeviceRay& DragPos |
Notify Target that input position has changed | BaseTools/ClickDragTool.h | |
virtual void OnClickPress
(
const FInputDeviceRay& PressPos |
Notify Target that click press ocurred | BaseTools/ClickDragTool.h | |
virtual void OnClickRelease
(
const FInputDeviceRay& ReleasePos |
Notify Target that click release occurred | BaseTools/ClickDragTool.h | |
virtual void OnTerminateDragSequence() |
Notify Target that click-drag sequence has been explicitly terminated (eg by escape key) | BaseTools/ClickDragTool.h |