1. Epic GamesDeveloper
  3. UScriptableSingleClickTool

UScriptableSingleClickTool

[UScriptableSingleClickTool](API\Plugins\ScriptableToolsFramework\BaseTools\UScriptableSingleClickTool) is an extension of [UScriptableInteractiveTool](API\Plugins\ScriptableToolsFramework\UScriptableInteractiveTool) that supports a "click" interaction, ie button press-down-and-release on an arbitrary Target (defined by the Tool).

API > API/Plugins > API/Plugins/ScriptableToolsFramework > API/Plugins/ScriptableToolsFramework/BaseTools

Inheritance Hierarchy

References

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

Syntax

UCLASS (Hidden)  
class UScriptableSingleClickTool :  
    public UScriptableInteractiveTool ,  
    public IClickBehaviorTarget ,  
    public IHoverBehaviorTarget

Remarks

UScriptableSingleClickTool is an extension of UScriptableInteractiveTool that supports a "click" interaction, ie button press-down-and-release on an arbitrary Target (defined by the Tool). Note that like a standard GUI click interaction, if the device is moved off the "Target" before the button is released, the click is cancelled. Note that in this context, the Target is defined implicitly by the Tool returning a "hit" for a given input device location, rather than any specific geometry.

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 bInHover  
Public variable bool bShiftModifier  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bWantMouseHover Enable Hover support API functions OnHoverHitTest / OnHoverBegin / OnHoverUpdate / OnHoverEnd for Mouse devices.
Public variable const FScriptableToolModifierStates & Modifiers  
Public variable UProperty Transient duplicatetransient, nontransactional, skipserialization TObjectPtr< UMouseHoverBehavior > MouseHoverBehavior  
Public variable UProperty Transient duplicatetransient, nontransactional, skipserialization TObjectPtr< USingleClickInputBehavior > SingleClickBehavior  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category FScriptableToolModifierStates  
Public function UFunction Category blueprintnativeevent void OnHitByClick is called when the Tool has indicated it would like to consume a click event (via TestIfHitByClick), and the click was not cancelled or consumed by a nearer object.
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 TestIfHitByClick is called to allow the Tool to indicate if it would like to consume a potential click at ClickPos.
Public function Virtual FInputRayHit  
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 IClickBehaviorTarget

  Type Name Description
Public function Virtual FInputRayHit

IsHitByClick ( const FInputDeviceRay& ClickPos
)

 IClickBehaviorTarget API.
Public function Virtual void

OnClicked ( const FInputDeviceRay& ClickPos
)

 Notify Target that click ocurred

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