ULocalClickDragInputBehavior

[ULocalClickDragInputBehavior](API\Runtime\InteractiveToolsFramework\BaseBehaviors\ULocalClickDragInputBehavior) is an implementation of [UClickDragInputBehavior](API\Runtime\InteractiveToolsFramework\BaseBehaviors\UClickDragInputBehavior) that also implements [IClickDragBehaviorTarget](API\Runtime\InteractiveToolsFramework\BaseBehaviors\IClickDragBehaviorTarget) directly, via a set of local lambda functions.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/Experimental/InteractiveToolsFramework/Public/BaseBehaviors/ClickDragBehavior.h

Include

#include "BaseBehaviors/ClickDragBehavior.h"

Syntax

class ULocalClickDragInputBehavior :
    public UClickDragInputBehavior,
    public IClickDragBehaviorTarget

Remarks

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.

Variables

Name Description

Public variable

TUniqueFunction...

 

CanBeginClickDragFunc

Lambda implementation of CanBeginClickDragSequence

Public variable

TUniqueFunction...

 

OnClickDragFunc

Lambda implementation of OnClickDrag

Public variable

TUniqueFunction...

 

OnClickPressFunc

Lambda implementation of OnClickPress

Public variable

TUniqueFunction...

 

OnClickReleaseFunc

Lambda implementation of OnClickRelease

Public variable

TUniqueFunction...

 

OnTerminateFunc

Lambda implementation of OnTerminateDragSequence

Functions

Name Description

Public function Virtual

void

 

Initialize()

Call this to initialize the class

Overridden from IClickDragBehaviorTarget

Name Description

Public function Virtual

FInputRayHit

 

CanBeginClickDragSequence

(
    const FInputDeviceRay& PressPos
)

IClickDragBehaviorTarget implementation

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

 

OnTerminateDragSequence()

Notify Target that click-drag sequence has been explicitly terminated (eg by escape key)
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss