1. Epic GamesDeveloper
  3. FMouseDeltaTracker

FMouseDeltaTracker

Keeps track of mouse movement deltas in the viewports.

API > API/Editor > API/Editor/UnrealEd

Keeps track of mouse movement deltas in the viewports.

   
Name FMouseDeltaTracker
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/MouseDeltaTracker.h
Include Path #include "MouseDeltaTracker.h"

Syntax

class FMouseDeltaTracker

Constructors

Name Remarks Include Path Unreal Specifiers

FMouseDeltaTracker()

   MouseDeltaTracker.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FMouseDeltaTracker()

   MouseDeltaTracker.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bExternalMovement bool Tracks whether keyboard/mouse wheel/etc have caused simulated mouse movement. MouseDeltaTracker.h  
bHasAttemptedDragTool bool True if we attempted to use a drag tool since StartTracking was called MouseDeltaTracker.h  
bHasReceivedAddDelta bool Keeps track of whether AddDelta has been called since StartTracking. MouseDeltaTracker.h  
bIsDeletingDragTool bool Tracks whether the drag tool is in the process of being deleted (to protect against reentrancy) MouseDeltaTracker.h  
bUsedDragModifier bool Tracks if the user used a modifier to drag a selected item. MouseDeltaTracker.h  
DragTool TSharedPtr< FDragTool > If there is a dragging tool being used, this will point to it. MouseDeltaTracker.h  
End FVector The unsnapped end position of the current mouse drag. MouseDeltaTracker.h  
EndScreen FVector The screen space end position of the current mouse drag (may be scaled or rotated according to the ortho zoom or view). MouseDeltaTracker.h  
EndSnapped FVector The snapped end position of the current mouse drag. MouseDeltaTracker.h  
RawDelta FVector The raw unscaled mouse delta in pixels MouseDeltaTracker.h  
ReductionAmount FVector The amount that the End vectors have been reduced by since dragging started, this is added to the deltas to get an absolute delta. MouseDeltaTracker.h  
Start FVector The unsnapped start position of the current mouse drag. MouseDeltaTracker.h  
StartScreen FVector The screen space start position of the current mouse drag (may be scaled or rotated according to the ortho zoom or view). MouseDeltaTracker.h  
StartSnapped FVector The snapped start position of the current mouse drag. MouseDeltaTracker.h  
TrackingWidgetMode UE::Widget::EWidgetMode Stores the widget mode active when the tracker begins tracking to help stop it change mid-track MouseDeltaTracker.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AbsoluteTranslationConvertMouseToDragRot ( FSceneView* InView,
FEditorViewportClient* InViewportClient,
FVector& OutDrag,
FRotator& OutRotation,
FVector& OutScale
) const

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

void AddDelta ( FEditorViewportClient* InViewportClient,
FKey InKey,
const int32 InDelta,
bool InNudge
)

 Adds delta movement into the tracker. MouseDeltaTracker.h  

void ConvertMovementDeltaToDragRot ( FSceneView* InView,
FEditorViewportClient* InViewportClient,
FVector& InDragDelta,
FVector& OutDrag,
FRotator& OutRotation,
FVector& OutScale
) const

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

bool EndTracking ( FEditorViewportClient* InViewportClient
)

 Called when a mouse button has been released. MouseDeltaTracker.h  

const FVector GetAbsoluteDelta()

 Returns the absolute delta since dragging started. MouseDeltaTracker.h  

const FVector GetAbsoluteDeltaSnapped()

 Returns the absolute snapped delta since dragging started. MouseDeltaTracker.h  

const FVector GetDelta()

 Returns the current delta. MouseDeltaTracker.h  

const FVector GetDeltaSnapped()

 Returns the current snapped delta. MouseDeltaTracker.h  

const FVector GetDragStartPos ()

 Returns the unsnapped start position of the current mouse drag. MouseDeltaTracker.h  

const FVector GetRawDelta ()

 Returns the raw mouse delta in pixels since dragging started. MouseDeltaTracker.h  

const FVector GetScreenDelta()

 Returns the screen space delta since dragging started. MouseDeltaTracker.h  

UE::Widget::EWidgetMode GetTrackingWidgetMode()

   MouseDeltaTracker.h  

const bool GetUsedDragModifier()

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

bool HasReceivedDelta()

   MouseDeltaTracker.h  

void ReduceBy ( const FVector& In
)

 Subtracts the specified value from End and EndSnapped. MouseDeltaTracker.h  

void Render3DDragTool ( const FSceneView* View,
FPrimitiveDrawInterface* PDI
)

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

void RenderDragTool ( const FSceneView* View,
FCanvas* Canvas
)

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

void ResetUsedDragModifier()

 Resets the UsedDragModifier flag MouseDeltaTracker.h  

void SetExternalMovement ( bool InExternalMovement
)

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

void StartTracking ( FEditorViewportClient* InViewportClient,
const int32 InX,
const int32 InY,
const FInputEventState& InInputState,
bool bNudge,
bool bResetDragToolState
)

 Begin tracking at the specified location for the specified viewport. MouseDeltaTracker.h  

bool UsingDragTool()

   MouseDeltaTracker.h  

bool WasExternalMovement()

   MouseDeltaTracker.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page