UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FDelayedDrag Class Reference

#include <DelayedDrag.h>

Public Member Functions

 FDelayedDrag (FVector2D InInitialPosition, FKey InEffectiveKey)
 
const FVector2DGetInitialPosition () const
 
bool IsDragging () const
 
void ForceDragStart ()
 
bool AttemptDragStart (const FPointerEvent &MouseEvent)
 
void SetTriggerScaleFactor (float InTriggerScaleFactor)
 

Protected Attributes

FVector2D InitialPosition
 
bool bHasInitiatedDrag
 
float DistanceDragged
 
float TriggerDistance
 
FKey EffectiveKey
 

Detailed Description

Helper class to assist with delayed drag operations

Constructor & Destructor Documentation

◆ FDelayedDrag()

FDelayedDrag::FDelayedDrag ( FVector2D  InInitialPosition,
FKey  InEffectiveKey 
)
inline

Construct this drag helper with an initial posision, and a key (probably mouse button) required for dragging

Member Function Documentation

◆ AttemptDragStart()

bool FDelayedDrag::AttemptDragStart ( const FPointerEvent MouseEvent)
inline

Attempt to start a drag from the given mouse event.

◆ ForceDragStart()

void FDelayedDrag::ForceDragStart ( )
inline

Force the state of this helper to be 'dragging'

◆ GetInitialPosition()

const FVector2D & FDelayedDrag::GetInitialPosition ( ) const
inline

Get the initial start position (before any drag has started)

◆ IsDragging()

bool FDelayedDrag::IsDragging ( ) const
inline

Check whether we have initiated a drag or not

◆ SetTriggerScaleFactor()

void FDelayedDrag::SetTriggerScaleFactor ( float  InTriggerScaleFactor)
inline

Assign a new scale factor to apply to the drag trigger distance

Member Data Documentation

◆ bHasInitiatedDrag

bool FDelayedDrag::bHasInitiatedDrag
protected

True where the distance dragged is sufficient to have started a drag

◆ DistanceDragged

float FDelayedDrag::DistanceDragged
protected

The amount we have dragged

◆ EffectiveKey

FKey FDelayedDrag::EffectiveKey
protected

The key that must be pressed to initiate the drag

◆ InitialPosition

FVector2D FDelayedDrag::InitialPosition
protected

The initial position of the drag start

◆ TriggerDistance

float FDelayedDrag::TriggerDistance
protected

The minimum distance that must be moved before the drag initiates.


The documentation for this class was generated from the following file: