1. Epic GamesDeveloper
  3. UScriptableClickDragTool

UScriptableClickDragTool

[UScriptableClickDragTool](API\Plugins\ScriptableToolsFramework\UScriptableClickDragTool) is an extension of [UScriptableInteractiveTool](API\Plugins\ScriptableToolsFramework\UScriptableInteractiveTool) that supports a "click-drag" interaction, ie capture the input device on press-down and collect any device movement events until release.

API > API/Plugins > API/Plugins/ScriptableToolsFramework

UScriptableClickDragTool is an extension of UScriptableInteractiveTool that supports a "click-drag" interaction, ie capture the input device on press-down and collect any device movement events until release. Hover is also supported.

Note: Currently these interactions are only supported for mouse devices, or devices remapped to be a mouse by the UInputRouter. Also currently only the left-mouse-button is supported.

   
Name UScriptableClickDragTool
Type class
Header File /Engine/Plugins/Runtime/ScriptableToolsFramework/Source/ScriptableToolsFramework/Public/BaseTools/ScriptableClickDragTool.h
Include Path #include "BaseTools/ScriptableClickDragTool.h"

Syntax

UCLASS (MinimalAPI)  
class UScriptableClickDragTool :  
    public UScriptableInteractiveTool ,  
    public IClickDragBehaviorTarget ,  
    public IHoverBehaviorTarget

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAltModifier bool   BaseTools/ScriptableClickDragTool.h  
bCtrlModifier bool   BaseTools/ScriptableClickDragTool.h  
bInClickDrag bool   BaseTools/ScriptableClickDragTool.h  
bInHover bool   BaseTools/ScriptableClickDragTool.h  
bShiftModifier bool   BaseTools/ScriptableClickDragTool.h  
bUpdateModifiersDuringDrag bool Allow Modifiers states to be updated during ClickDrag sequence. BaseTools/ScriptableClickDragTool.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="SingleClick Tool Settings"
bWantMouseHover bool Enable Hover support API functions OnHoverHitTest / OnHoverBegin / OnHoverUpdate / OnHoverEnd for Mouse devices. BaseTools/ScriptableClickDragTool.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category="SingleClick Tool Settings"
ClickDragBehavior TObjectPtr< UClickDragInputBehavior >   BaseTools/ScriptableClickDragTool.h
  • Transient
  • DuplicateTransient
  • NonTransactional
  • SkipSerialization
MouseHoverBehavior TObjectPtr< UMouseHoverBehavior >   BaseTools/ScriptableClickDragTool.h
  • Transient
  • DuplicateTransient
  • NonTransactional
  • SkipSerialization

Functions

Public

Name Remarks Include Path Unreal Specifiers

FScriptableToolModifierStates GetActiveModifiers()

   BaseTools/ScriptableClickDragTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"

bool InActiveClickDrag()

   BaseTools/ScriptableClickDragTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"

bool InActiveHover()

   BaseTools/ScriptableClickDragTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"

bool IsAltDown()

   BaseTools/ScriptableClickDragTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"

bool IsCtrlDown()

   BaseTools/ScriptableClickDragTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"

bool IsShiftDown()

 Modifer Buttons Support API BaseTools/ScriptableClickDragTool.h
  • BlueprintCallable
  • Category="ScriptableTool|Input"

void OnDragBegin ( FInputDeviceRay StartPosition,
const FScriptableToolModifierStates& Modifiers
)

   BaseTools/ScriptableClickDragTool.h
  • BlueprintNativeEvent
  • Category="ClickDrag Events"

virtual void OnDragBegin_Implementation ( FInputDeviceRay StartPosition,
const FScriptableToolModifierStates& Modifiers
)

   BaseTools/ScriptableClickDragTool.h  

void OnDragEnd ( FInputDeviceRay EndPosition,
const FScriptableToolModifierStates& Modifiers
)

   BaseTools/ScriptableClickDragTool.h
  • BlueprintNativeEvent
  • Category="ClickDrag Events"

virtual void OnDragEnd_Implementation ( FInputDeviceRay EndPosition,
const FScriptableToolModifierStates& Modifiers
)

   BaseTools/ScriptableClickDragTool.h  

void OnDragSequenceCancelled()

   BaseTools/ScriptableClickDragTool.h
  • BlueprintNativeEvent
  • Category="ClickDrag Events"

virtual void OnDragSequenceCancelled_Implementation()

   BaseTools/ScriptableClickDragTool.h  

void OnDragUpdatePosition ( FInputDeviceRay NewPosition,
const FScriptableToolModifierStates& Modifiers
)

   BaseTools/ScriptableClickDragTool.h
  • BlueprintNativeEvent
  • Category="ClickDrag Events"

virtual void OnDragUpdatePosition_Implementation ( FInputDeviceRay NewPosition,
const FScriptableToolModifierStates& Modifiers
)

   BaseTools/ScriptableClickDragTool.h  

void OnHoverBegin ( FInputDeviceRay HoverPos,
const FScriptableToolModifierStates& Modifiers
)

 Begin a sequence of Hover input events BaseTools/ScriptableClickDragTool.h
  • BlueprintNativeEvent
  • Category="Hover Events"

virtual void OnHoverBegin_Implementation ( FInputDeviceRay HoverPos,
const FScriptableToolModifierStates& Modifiers
)

   BaseTools/ScriptableClickDragTool.h  

void OnHoverEnd ( const FScriptableToolModifierStates& Modifiers
)

 Indicate that an active captured Hover sequence has ended. BaseTools/ScriptableClickDragTool.h
  • BlueprintNativeEvent
  • Category="Hover Events"

virtual void OnHoverEnd_Implementation ( const FScriptableToolModifierStates& Modifiers
)

   BaseTools/ScriptableClickDragTool.h  
Hover Support API OnHoverHitTest is called to allow the Tool to indicate if it would like to start consuing "hover" input at HoverPos. BaseTools/ScriptableClickDragTool.h
  • BlueprintNativeEvent
  • Category="Hover Events"

virtual FInputRayHit OnHoverHitTest_Implementation ( FInputDeviceRay HoverPos,
const FScriptableToolModifierStates& Modifiers
)

   BaseTools/ScriptableClickDragTool.h  

bool OnHoverUpdate ( FInputDeviceRay HoverPos,
const FScriptableToolModifierStates& Modifiers
)

 Update an active Hover sequence. BaseTools/ScriptableClickDragTool.h
  • BlueprintNativeEvent
  • Category="Hover Events"

virtual bool OnHoverUpdate_Implementation ( FInputDeviceRay HoverPos,
const FScriptableToolModifierStates& Modifiers
)

   BaseTools/ScriptableClickDragTool.h  

FInputRayHit TestIfCanBeginClickDrag ( FInputDeviceRay ClickPos,
const FScriptableToolModifierStates& Modifiers
)

 Click Support API BaseTools/ScriptableClickDragTool.h
  • BlueprintNativeEvent
  • Category="ClickDrag Events"

virtual FInputRayHit TestIfCanBeginClickDrag_Implementation ( FInputDeviceRay ClickPos,
const FScriptableToolModifierStates& Modifiers
)

   BaseTools/ScriptableClickDragTool.h  

Overridden from UInteractiveTool

Name Remarks Include Path Unreal Specifiers

virtual void Setup()

   BaseTools/ScriptableClickDragTool.h  

Overridden from IClickDragBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual FInputRayHit CanBeginClickDragSequence ( const FInputDeviceRay& PressPos
)

 IClickDragBehaviorTarget API. BaseTools/ScriptableClickDragTool.h  

virtual void OnClickDrag ( const FInputDeviceRay& DragPos
)

   BaseTools/ScriptableClickDragTool.h  

virtual void OnClickPress ( const FInputDeviceRay& PressPos
)

   BaseTools/ScriptableClickDragTool.h  

virtual void OnClickRelease ( const FInputDeviceRay& ReleasePos
)

   BaseTools/ScriptableClickDragTool.h  

virtual void OnTerminateDragSequence()

   BaseTools/ScriptableClickDragTool.h  

Overridden from IModifierToggleBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual void OnUpdateModifierState ( int ModifierID,
bool bIsOn
)

   BaseTools/ScriptableClickDragTool.h  

Overridden from IHoverBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual FInputRayHit BeginHoverSequenceHitTest ( const FInputDeviceRay& PressPos
)

 IHoverBehaviorTarget API. BaseTools/ScriptableClickDragTool.h  

virtual void OnBeginHover ( const FInputDeviceRay& DevicePos
)

   BaseTools/ScriptableClickDragTool.h  

virtual void OnEndHover()

   BaseTools/ScriptableClickDragTool.h  

virtual bool OnUpdateHover ( const FInputDeviceRay& DevicePos
)

   BaseTools/ScriptableClickDragTool.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page