Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > InteractiveToolsFramework > BaseBehaviors > UClickDragInputBehavior

Light Theme

Dark Theme

UClickDragInputBehavior

[UClickDragInputBehavior](API\Runtime\InteractiveToolsFramework\BaseBehaviors\UClickDragInputBehavior) implements a standard "button-click-drag"-style input behavior.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInputBehavior

UAnyButtonInputBehavior

UClickDragInputBehavior

ULocalClickDragInputBehavior

References

Module	InteractiveToolsFramework
Header	/Engine/Source/Runtime/Experimental/InteractiveToolsFramework/Public/BaseBehaviors/ClickDragBehavior.h
Include	#include "BaseBehaviors/ClickDragBehavior.h"

Syntax

class UClickDragInputBehavior : public UAnyButtonInputBehavior

Remarks

UClickDragInputBehavior implements a standard "button-click-drag"-style input behavior. An IClickDragBehaviorTarget instance must be provided which is manipulated by this behavior.

The state machine works as follows: 1) on input-device-button-press, call Target::CanBeginClickDragSequence to determine if capture should begin 2) on input-device-move, call Target::OnClickDrag 3) on input-device-button-release, call Target::OnClickRelease

If a ForceEndCapture occurs we call Target::OnTerminateDragSequence

Variables

	Name	Description
bool	bInClickDrag	Set to true if we are in a capture
bool	bUpdateModifiersDuringDrag	If true, then we will update Modifier states in UpdateCapture().
TFunction< bool...	ModifierCheckFunc	WantsCapture() will only return capture request if this function returns true (or is null)
FInputBehaviorM...	Modifiers	The modifier set for this behavior
IClickDragBehav...	Target	Click Target object

Constructors

	Name	Description
	UClickDragInputBehavior()

Functions

	Name	Description
void	Initialize ( IClickDragBehaviorTarget* Targ... )	Initialize this behavior with the given Target
void	OnClickDragInternal ( const FInputDeviceState& Input, const FInputCaptureData& Data )	Internal function that forwards click evens to Target::OnClickDrag, you can customize behavior here
void	OnClickPressInternal ( const FInputDeviceState& Input, EInputCaptureSide Side )	Internal function that forwards click evens to Target::OnClickPress, you can customize behavior here
void	OnClickReleaseInternal ( const FInputDeviceState& Input, const FInputCaptureData& Data )	Internal function that forwards click evens to Target::OnClickRelease, you can customize behavior here

Overridden from UInputBehavior

	Name	Description
FInputCaptur...	BeginCapture ( const FInputDeviceState& InputStat..., EInputCaptureSide eSide )	Called after WantsCapture() returns a capture request that was accepted
void	ForceEndCapture ( const FInputCaptureData& CaptureDa... )	If this is called, the Behavior has forcibly lost capture (eg due to app losing focus for example) and needs to clean up accordingly
FInputCaptur...	UpdateCapture ( const FInputDeviceState& InputStat..., const FInputCaptureData& CaptureDa... )	Called for each new input event during a capture sequence.
FInputCaptur...	WantsCapture ( const FInputDeviceState& InputStat... )	Given the input state, does this Behavior want to begin capturing some input devices?

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss