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 UFunction BlueprintCallable, Category FScriptableToolModifierStates  
Public function UFunction Category blueprintnativeevent void

OnDragBegin ( FInputDeviceRay StartPosition,
const FScriptableToolModifierStates& Modifiers
)

  
Public function Virtual void  
Public function UFunction Category blueprintnativeevent void

OnDragEnd ( FInputDeviceRay EndPosition,
const FScriptableToolModifierStates& Modifiers
)

  
Public function Virtual void  
Public function UFunction Category blueprintnativeevent void  
Public function Virtual void  
Public function UFunction Category blueprintnativeevent void  
Public function Virtual void  
Public function UFunction Category blueprintnativeevent void Begin a sequence of Hover input events
Public function Virtual void  
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 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  
Public function Virtual bool  
Public function UFunction Category blueprintnativeevent FInputRayHit Click Support API
Public function Virtual FInputRayHit  
Public function Const UFunction BlueprintCallable, Category    
Public function UFunction Category blueprintnativeevent   Update an active Hover sequence.
Public function Const UFunction BlueprintCallable, Category    
Public function Const UFunction BlueprintCallable, Category   Modifer Buttons Support API
Public function Const UFunction BlueprintCallable, Category    
Public function Const UFunction BlueprintCallable, Category    

Overridden from UInteractiveTool

  Type Name Description
Public function Virtual void

Setup ()

 Called by ToolManager to initialize the Tool after ToolBuilder::BuildTool() has been called

Overridden from IClickDragBehaviorTarget

  Type Name Description
Public function Virtual FInputRayHit IClickDragBehaviorTarget API.
Public function Virtual void

OnClickDrag ( const FInputDeviceRay& DragPos
)

 Notify Target that input position has changed
Public function Virtual void

OnClickPress ( const FInputDeviceRay& PressPos
)

 Notify Target that click press ocurred
Public function Virtual void

OnClickRelease ( const FInputDeviceRay& ReleasePos
)

 Notify Target that click release occurred
Public function Virtual void Notify Target that click-drag sequence has been explicitly terminated (eg by escape key)

Overridden from IModifierToggleBehaviorTarget

  Type Name Description
Public function Virtual void

OnUpdateModifierState ( int ModifierID,
bool bIsOn
)

 Notify target of current modifier state

Overridden from IHoverBehaviorTarget

  Type Name Description
Public function Virtual FInputRayHit IHoverBehaviorTarget API.
Public function Virtual void

OnBeginHover ( const FInputDeviceRay& DevicePos
)

 Initialize hover sequence at given position
Public function Virtual void Terminate active hover sequence
Public function Virtual bool

OnUpdateHover ( const FInputDeviceRay& DevicePos
)

 Update active hover sequence with new input position

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page