Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework
ULocalClickDragInputBehavior is an implementation of UClickDragInputBehavior that also implements IClickDragBehaviorTarget directly, via a set of local lambda functions. To use/customize this class the client replaces the lambda functions with their own. This avoids having to create a second IClickDragBehaviorTarget implementation for trivial use-cases.
| Name | ULocalClickDragInputBehavior |
| Type | class |
| Header File | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseBehaviors/ClickDragBehavior.h |
| Include Path | #include "BaseBehaviors/ClickDragBehavior.h" |
Syntax
UCLASS (MinimalAPI)
class ULocalClickDragInputBehavior :
public UClickDragInputBehavior ,
public IClickDragBehaviorTarget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInputBehavior → UAnyButtonInputBehavior → UClickDragInputBehavior → ULocalClickDragInputBehavior
Implements Interfaces
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CanBeginClickDragFunc | TUniqueFunction< FInputRayHit(const FInputDeviceRay &PressPos)> | Lambda implementation of CanBeginClickDragSequence | BaseBehaviors/ClickDragBehavior.h | |
| OnClickDragFunc | TUniqueFunction< void(const FInputDeviceRay &PressPos)> | Lambda implementation of OnClickDrag | BaseBehaviors/ClickDragBehavior.h | |
| OnClickPressFunc | TUniqueFunction< void(const FInputDeviceRay &PressPos)> | Lambda implementation of OnClickPress | BaseBehaviors/ClickDragBehavior.h | |
| OnClickReleaseFunc | TUniqueFunction< void(const FInputDeviceRay &ReleasePos)> | Lambda implementation of OnClickRelease | BaseBehaviors/ClickDragBehavior.h | |
| OnTerminateFunc | TUniqueFunction< void()> | Lambda implementation of OnTerminateDragSequence | BaseBehaviors/ClickDragBehavior.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Initialize () |
Call this to initialize the class | BaseBehaviors/ClickDragBehavior.h |
Overridden from IClickDragBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit CanBeginClickDragSequence
(
const FInputDeviceRay& PressPos |
IClickDragBehaviorTarget implementation | BaseBehaviors/ClickDragBehavior.h | |
virtual void OnClickDrag
(
const FInputDeviceRay& DragPos |
Notify Target that input position has changed | BaseBehaviors/ClickDragBehavior.h | |
virtual void OnClickPress
(
const FInputDeviceRay& PressPos |
Notify Target that click press ocurred | BaseBehaviors/ClickDragBehavior.h | |
virtual void OnClickRelease
(
const FInputDeviceRay& ReleasePos |
Notify Target that click release occurred | BaseBehaviors/ClickDragBehavior.h | |
virtual void OnTerminateDragSequence() |
Notify Target that click-drag sequence has been explicitly terminated (eg by escape key) | BaseBehaviors/ClickDragBehavior.h |
Protected
Overridden from UClickDragInputBehavior
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Initialize
(
IClickDragBehaviorTarget* Target |
Initialize this behavior with the given Target | BaseBehaviors/ClickDragBehavior.h |