FDragTool

The base class that all drag tools inherit from.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

UnrealEd

Header

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

Include

#include "EditorDragTools.h"

Syntax

class FDragTool

Remarks

The base class that all drag tools inherit from. The drag tools implement special behaviors for the user clicking and dragging in a viewport.

Variables

Name Description

Protected variable

bool

 

bAltDown

These flags store the state of various buttons that were pressed when the drag was started.

Protected variable

bool

 

bControlDown

Public variable

bool

 

bConvertDelta

Does this drag tool need to have the mouse movement converted to the viewport orientation?

Protected variable

bool

 

bIsDragging

True if we are dragging

Protected variable

bool

 

bLeftMouseButtonDown

Protected variable

bool

 

bMiddleMouseButtonDown

Protected variable

bool

 

bRightMouseButtonDown

Protected variable

bool

 

bShiftDown

Protected variable

bool

 

bUseSnapping

If true, the drag tool wants to be passed grid snapped values.

Protected variable

FVector

 

End

Protected variable

FVector

 

EndWk

Protected variable

FEditorModeTool...

 

ModeTools

Protected variable

FVector

 

Start

The start/end location of the current drag.

Constructors

Name Description

Public function

FDragTool

(
    FEditorModeTools* InModeTools
)

Destructors

Name Description

Public function Virtual

~FDragTool()

Functions

Name Description

Public function Virtual

void

 

AddDelta

(
    const FVector& InDelta
)

Updates the drag tool's end location with the specified delta.

Public function Virtual

void

 

EndDrag()

Ends a mouse drag behavior (the user has let go of the mouse button).

Public function Const

bool

 

IsDragging()

Public function Virtual

void

 

Render

(
    FCanvas* Canvas
)

Rendering stub for 2D viewport drag tools.

Public function Virtual

void

 

Render

(
    const FSceneView* View,
    FCanvas* Canvas
)

Public function Virtual

void

 

Render3D

(
    const FSceneView* View,
    FPrimitiveDrawInterface* PDI
)

Public function Virtual

void

 

StartDrag

(
    FEditorViewportClient* InViewp...,
    const FVector& InStartWorld,
    const FVector2D& InStartScreen
)

Starts a mouse drag behavior.

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