Navigation
API > API/Editor > API/Editor/EditorInteractiveToolsFramework
A base class which can be used to implement interactions based on mouse drag actions
| Name | UViewportDragInteraction |
| Type | class |
| Header File | /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/Public/ViewportInteractions/ViewportDragInteraction.h |
| Include Path | #include "ViewportInteractions/ViewportDragInteraction.h" |
Syntax
UCLASS (MinimalAPI, Transient, Abstract)
class UViewportDragInteraction :
public UViewportInteraction ,
public IClickDragBehaviorTarget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UViewportInteraction → UViewportDragInteraction
Implements Interfaces
Derived Classes
UViewportDragInteraction derived class hierarchy
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UViewportDragInteraction() |
ViewportInteractions/ViewportDragInteraction.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanBeActivated
(
const FInputDeviceState& InInputDeviceState |
ViewportInteractions/ViewportDragInteraction.h | ||
virtual void OnDragDelta
(
float InMouseDeltaX, |
ViewportInteractions/ViewportDragInteraction.h | ||
void SetClickTarget
(
IClickBehaviorTarget* InClickBehaviorTarget |
Provides a click behavior target to be called when drag interaction fails | ViewportInteractions/ViewportDragInteraction.h |
Overridden from UViewportInteraction
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Initialize
(
UViewportInteractionsBehaviorSource*const InViewportInteractionsBehaviorSource |
Initialization code which can be expanded by derived classes | ViewportInteractions/ViewportDragInteraction.h |
Overridden from IClickDragBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit CanBeginClickDragSequence
(
const FInputDeviceRay& InPressPos |
ViewportInteractions/ViewportDragInteraction.h | ||
virtual void OnClickDrag
(
const FInputDeviceRay& InDragPos |
ViewportInteractions/ViewportDragInteraction.h | ||
virtual void OnClickPress
(
const FInputDeviceRay& InPressPos |
ViewportInteractions/ViewportDragInteraction.h | ||
virtual void OnClickRelease
(
const FInputDeviceRay& InReleasePos |
ViewportInteractions/ViewportDragInteraction.h | ||
virtual void OnTerminateDragSequence() |
ViewportInteractions/ViewportDragInteraction.h |
Overridden from IModifierToggleBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnForceEndCapture() |
ViewportInteractions/ViewportDragInteraction.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FDeviceButtonState GetActiveMouseButtonState
(
const FInputDeviceState& Input |
Returns the state of the mouse button currently used by this Interaction. | ViewportInteractions/ViewportDragInteraction.h | |
void SetClickOrDragPriority
(
int InPriority |
ViewportInteractions/ViewportDragInteraction.h |