1. Epic GamesDeveloper
  3. UScriptableClickDragTool

UScriptableClickDragTool

[UScriptableClickDragTool](API\Plugins\ScriptableToolsFramework\BaseTools\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 > API/Plugins/ScriptableToolsFramework/BaseTools

Inheritance Hierarchy

References

   
Module ScriptableToolsFramework
Header /Engine/Plugins/Runtime/ScriptableToolsFramework/Source/ScriptableToolsFramework/Public/BaseTools/ScriptableClickDragTool.h
Include #include "BaseTools/ScriptableClickDragTool.h"

Syntax

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

Remarks

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.

Variables

  Type Name Description
Public variable bool bAltModifier  
Public variable bool bCtrlModifier  
Public variable bool bInClickDrag  
Public variable bool bInHover  
Public variable bool bShiftModifier  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bUpdateModifiersDuringDrag Allow Modifiers states to be updated during ClickDrag sequence.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bWantMouseHover Enable Hover support API functions OnHoverHitTest / OnHoverBegin / OnHoverUpdate / OnHoverEnd for Mouse devices.
Public variable UProperty Transient duplicatetransient, nontransactional, skipserialization TObjectPtr< UClickDragInputBehavior > ClickDragBehavior  
Public variable const FScriptableToolModifierStates & Modifiers  
Public variable UProperty Transient duplicatetransient, nontransactional, skipserialization TObjectPtr< UMouseHoverBehavior > MouseHoverBehavior  

Functions

  Type Name Description
Public function Virtual FInputRayHit

BeginHoverSequenceHitTest ( const FInputDeviceRay& PressPos
)

 IHoverBehaviorTarget API.
Public function Virtual FInputRayHit

CanBeginClickDragSequence ( const FInputDeviceRay& PressPos
)

 IClickDragBehaviorTarget API.
Public function UFunction BlueprintCallable, Category FScriptableToolModifierStates  
Public function Virtual void

OnBeginHover ( const FInputDeviceRay& DevicePos
)

  
Public function Virtual void

OnClickDrag ( const FInputDeviceRay& DragPos
)

  
Public function Virtual void

OnClickPress ( const FInputDeviceRay& PressPos
)

  
Public function Virtual void

OnClickRelease ( const FInputDeviceRay& ReleasePos
)

  
Public function UFunction Category blueprintnativeevent void

OnDragBegin ( FInputDeviceRay StartPosition,
const FScriptableToolModifierStates& Modifiers
)

  
Public function Virtual void

OnDragBegin_Implementation ( FInputDeviceRay StartPosition,
const FScriptableToolModifierStates& Modifiers
)

  
Public function UFunction Category blueprintnativeevent void

OnDragEnd ( FInputDeviceRay EndPosition,
const FScriptableToolModifierStates& Modifiers
)

  
Public function Virtual void

OnDragEnd_Implementation ( FInputDeviceRay EndPosition,
const FScriptableToolModifierStates& Modifiers
)

  
Public function UFunction Category blueprintnativeevent void  
Public function Virtual void  
Public function UFunction Category blueprintnativeevent void

OnDragUpdatePosition ( FInputDeviceRay NewPosition,
const FScriptableToolModifierStates& Modifiers
)

  
Public function Virtual void

OnDragUpdatePosition_Implementation ( FInputDeviceRay NewPosition,
const FScriptableToolModifierStates& Modifiers
)

  
Public function Virtual void  
Public function UFunction Category blueprintnativeevent void

OnHoverBegin ( FInputDeviceRay HoverPos,
const FScriptableToolModifierStates& Modifiers
)

 Begin a sequence of Hover input events
Public function Virtual void

OnHoverBegin_Implementation ( FInputDeviceRay HoverPos,
const FScriptableToolModifierStates& Modifiers
)

  
Public function UFunction Category blueprintnativeevent void Indicate that an active captured Hover sequence has ended.
Public function Virtual void  
Public function UFunction Category blueprintnativeevent FInputRayHit

OnHoverHitTest ( FInputDeviceRay HoverPos,
const FScriptableToolModifierStates& Modifiers
)

 Hover Support API OnHoverHitTest is called to allow the Tool to indicate if it would like to start consuing "hover" input at HoverPos.
Public function Virtual FInputRayHit

OnHoverHitTest_Implementation ( FInputDeviceRay HoverPos,
const FScriptableToolModifierStates& Modifiers
)

  
Public function Virtual bool

OnHoverUpdate_Implementation ( FInputDeviceRay HoverPos,
const FScriptableToolModifierStates& Modifiers
)

  
Public function Virtual void  
Public function Virtual bool

OnUpdateHover ( const FInputDeviceRay& DevicePos
)

  
Public function Virtual void

OnUpdateModifierState ( int ModifierID,
bool bIsOn
)

  
Public function UFunction Category blueprintnativeevent FInputRayHit

TestIfCanBeginClickDrag ( FInputDeviceRay ClickPos,
const FScriptableToolModifierStates& Modifiers
)

 Click Support API
Public function Virtual FInputRayHit

TestIfCanBeginClickDrag_Implementation ( FInputDeviceRay ClickPos,
const FScriptableToolModifierStates& Modifiers
)

  
Public function Const UFunction BlueprintCallable, Category  

UPARAM ( DisplayName
)

  
Public function UFunction Category blueprintnativeevent  

UPARAM ( DisplayName
)

 Update an active Hover sequence.
Public function Const UFunction BlueprintCallable, Category  

UPARAM ( DisplayName
)

  
Public function Const UFunction BlueprintCallable, Category  

UPARAM ( DisplayName
)

 Modifer Buttons Support API
Public function Const UFunction BlueprintCallable, Category  

UPARAM ( DisplayName
)

  
Public function Const UFunction BlueprintCallable, Category  

UPARAM ( DisplayName
)

  

Overridden from UScriptableInteractiveTool

  Type Name Description
Public function Virtual void

Setup ()

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page