Navigation
API > API/Editor > API/Editor/EditorInteractiveToolsFramework
A behavior dedicated to Viewport Drag Interactions, directly supporting threshold-based capture. It can be used when capture stealing e.g. a single click behavior. The IViewportClickDragBehaviorTarget of this behavior will receive OnDragStart and OnDragEnd when drag starts/ends, and not on actual button press/release
| Name | UViewportClickDragBehavior |
| Type | class |
| Header File | /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/Public/Behaviors/ViewportClickDragBehavior.h |
| Include Path | #include "Behaviors/ViewportClickDragBehavior.h" |
Syntax
UCLASS (MinimalAPI)
class UViewportClickDragBehavior : public UInputBehavior
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInputBehavior → UViewportClickDragBehavior
Derived Classes
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FGetBindingsDelegate | TBaseDelegate_NoParams< const UE::Editor::ViewportInteractions::FButtonBindings & > | Behaviors/ViewportClickDragBehavior.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FVector2D GetMouseDownPosition() |
Behaviors/ViewportClickDragBehavior.h | ||
void Initialize
(
IViewportClickDragBehaviorTarget* InTarget |
Behaviors/ViewportClickDragBehavior.h | ||
bool IsDragging() |
Behaviors/ViewportClickDragBehavior.h | ||
void ResetDrag
(
const FInputDeviceState& InputState |
Reset drag state and tracked drag distance. Calls OnDragEnd() but does not exit the behavior. | Behaviors/ViewportClickDragBehavior.h | |
void SetBindings
(
const TArray< UE::Editor::ViewportInteractions::FButtonBinding >& InBindings |
Behaviors/ViewportClickDragBehavior.h | ||
void SetBindings
(
const FGetBindingsDelegate& InDelegate |
Behaviors/ViewportClickDragBehavior.h | ||
void SetDragConfirmedPriority
(
FInputCapturePriority InDragConfirmedPriority |
Set the priority this Drag Behavior will return from GetPriority once the current interaction is confirmed to be a drag. | Behaviors/ViewportClickDragBehavior.h | |
void SetRequireDistanceThresholdOnCapture
(
TAttribute< bool > InRequireDistanceThresholdOnCapture |
Call to set whether drag starts should be contingent on the distance threshold when this behavior has capture. | Behaviors/ViewportClickDragBehavior.h | |
void SetUsesUnboundedCursor
(
TAttribute< bool > InUsesUnboundedCursor |
Call to set the default unbounded cursor attribute. | Behaviors/ViewportClickDragBehavior.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputDeviceRay GetDeviceRay
(
const FInputDeviceState& InInputDeviceState |
Behaviors/ViewportClickDragBehavior.h | ||
virtual const FVector2D & GetMousePosition
(
const FInputDeviceState& InInputDeviceState |
Extract the current mouse position from the Input Device State | Behaviors/ViewportClickDragBehavior.h | |
virtual bool UsesUnboundedCursor() |
Behaviors/ViewportClickDragBehavior.h |
Overridden from UInputBehavior
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputCaptureUpdate BeginCapture
(
const FInputDeviceState& InputState, |
Behaviors/ViewportClickDragBehavior.h | ||
virtual void ForceEndCapture
(
const FInputCaptureData& CaptureData |
Behaviors/ViewportClickDragBehavior.h | ||
virtual FInputCapturePriority GetPriority() |
Behaviors/ViewportClickDragBehavior.h | ||
virtual FInputCaptureUpdate UpdateCapture
(
const FInputDeviceState& InputState, |
Behaviors/ViewportClickDragBehavior.h | ||
virtual FInputCaptureRequest WantsCapture
(
const FInputDeviceState& InputState |
Behaviors/ViewportClickDragBehavior.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const UE::Editor::ViewportInteractions::FButtonBindings & GetBindings() |
Behaviors/ViewportClickDragBehavior.h | ||
bool HasMovedEnoughForDrag() |
Behaviors/ViewportClickDragBehavior.h |
Protected Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TOptional< FInputCapturePriority > GetCapturePriority
(
UE::Editor::ViewportInteractions::EInputStage Stage, |
Behaviors/ViewportClickDragBehavior.h | ||
virtual void OnClickDragInternal
(
const FInputDeviceState& InputState, |
Behaviors/ViewportClickDragBehavior.h | ||
virtual void OnDragEndInternal
(
const FInputDeviceState& InputState, |
Behaviors/ViewportClickDragBehavior.h | ||
virtual void OnDragStartInternal
(
const FInputDeviceState& InputState |
Behaviors/ViewportClickDragBehavior.h | ||
virtual void OnStateUpdatedInternal
(
const FInputDeviceState& InInputDeviceState |
Behaviors/ViewportClickDragBehavior.h |