FMouseDeltaTracker

Keeps track of mouse movement deltas in the viewports.

Windows
MacOS
Linux

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Public/MouseDeltaTracker.h

Include

#include "MouseDeltaTracker.h"

Syntax

class FMouseDeltaTracker

Remarks

Keeps track of mouse movement deltas in the viewports.

Constructors

Name Description

Public function

FMouseDeltaTracker()

Destructors

Name Description

Public function

~FMouseDeltaTracker()

Functions

Name Description

Public function Const

void

 

AbsoluteTranslationConvertMouseToDragRot

(
    FSceneView* InView,
    FEditorViewportClient* InViewp...,
    FVector& OutDrag,
    FRotator& OutRotation,
    FVector& OutScale
)

Absolute Translation conversion from mouse position on the screen to widget axis movement/rotation.

Public function

void

 

AddDelta

(
    FEditorViewportClient* InViewp...,
    FKey InKey,
    const int32 InDelta,
    bool InNudge
)

Adds delta movement into the tracker.

Public function Const

void

 

ConvertMovementDeltaToDragRot

(
    FSceneView* InView,
    FEditorViewportClient* InViewp...,
    FVector& InDragDelta,
    FVector& OutDrag,
    FRotator& OutRotation,
    FVector& OutScale
)

Converts the delta movement to drag/rotation/scale based on the viewport type or widget axis.

Public function

bool

 

EndTracking

(
    FEditorViewportClient* InViewp...
)

Called when a mouse button has been released.

Public function Const

const FVecto...

 

GetAbsoluteDelta()

Returns the absolute delta since dragging started.

Public function Const

const FVecto...

 

GetAbsoluteDeltaSnapped()

Returns the absolute snapped delta since dragging started.

Public function Const

const FVecto...

 

GetDelta()

Returns the current delta.

Public function Const

const FVecto...

 

GetDeltaSnapped()

Returns the current snapped delta.

Public function Const

const FVecto...

 

GetDragStartPos()

Returns the unsnapped start position of the current mouse drag.

Public function Const

const FVecto...

 

GetRawDelta()

Returns the raw mouse delta in pixels since dragging started.

Public function Const

const FVecto...

 

GetScreenDelta()

Returns the screen space delta since dragging started.

Public function Const

FWidget::EWi...

 

GetTrackingWidgetMode()

Public function Const

const bool

 

GetUsedDragModifier()

Returns if the user used a modifier to drag a selected item. (Rather than using a widget handle)

Public function Const

bool

 

HasReceivedDelta()

Public function

void

 

ReduceBy

(
    const FVector& In
)

Subtracts the specified value from End and EndSnapped.

Public function

void

 

Render3DDragTool

(
    const FSceneView* View,
    FPrimitiveDrawInterface* PDI
)

Renders the drag tool. Does nothing if no drag tool exists.

Public function

void

 

RenderDragTool

(
    const FSceneView* View,
    FCanvas* Canvas
)

Renders the drag tool. Does nothing if no drag tool exists.

Public function

void

 

ResetUsedDragModifier()

Resets the UsedDragModifier flag

Public function

void

 

SetExternalMovement()

Marks that something caused the equivalent of mouse dragging, but with other means (keyboard short cut, mouse wheel).

Public function

void

 

StartTracking

(
    FEditorViewportClient* InViewp...,
    const int32 InX,
    const int32 InY,
    const FInputEventState& InInputSta...,
    bool bNudge,
    bool bResetDragToolState
)

Begin tracking at the specified location for the specified viewport.

Public function Const

bool

 

UsingDragTool()

Public function Const

bool

 

WasExternalMovement()

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback