Language:
Discover
By Skill Level
By Category

FDragTool

Choose your OS:

Inheritance Hierarchy

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
)

FDragTool

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

bool

 

IsDragging()

True if we are dragging

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.

References

Module

UnrealEd

Header

Editor/UnrealEd/Public/EditorDragTools.h