Language:
Discover
By Skill Level
By Category

FModeTool

Choose your OS:

Inheritance Hierarchy

Syntax

class FModeTool

Remarks

Base class for all editor mode tools.

Variables

Name Description

Protected variable

bool

 

bUseWidget

If true, this tool wants to have input filtered through the editor widget.

Protected variable

EModeTools

 

ID

Which tool this is.

Constructors

Name Description

Public function

FModeTool()

Destructors

Name Description

Public function Virtual

~FModeTool()

Functions

Name Description

Public function Virtual

bool

 

BoxSelect

(
    FBox & InBox,
    bool InSelect
)

True if something was selected/deselected, false otherwise.

Public function Virtual

bool

 

CapturedMouseMove

(
    FEditorViewportClient * InViewp...,
    FViewport * InViewport,
    int32 InMouseX,
    int32 InMouseY
)

Called when the mouse is moved while a window input capture is in effect

Public function Virtual

void

 

DrawHUD

(
    FEditorViewportClient * Viewpor...,
    FViewport * Viewport,
    const FSceneView * View,
    FCanvas * Canvas
)

Public function Virtual

bool

 

EndModify()

Public function Virtual

void

 

EndTrans()

Public function Virtual

bool

 

FrustumSelect

(
    const FConvexVolume & InFrustum,
    FEditorViewportClient * InViewp...,
    bool InSelect
)

Public function

EModeTools

 

GetID()

Returns the tool type.

Public function Virtual

FString

 

GetName()

Returns the name that gets reported to the editor.

Public function Virtual

bool

 

InputAxis

(
    FEditorViewportClient * InViewp...,
    FViewport * Viewport,
    int32 ControllerId,
    FKey Key,
    float Delta,
    float DeltaTime
)

True if the delta was handled by this editor mode tool.

Public function Virtual

bool

 

InputDelta

(
    FEditorViewportClient * InViewp...,
    FViewport * InViewport,
    FVector & InDrag,
    FRotator & InRot,
    FVector & InScale
)

True if the delta was handled by this editor mode tool.

Public function Virtual

bool

 

InputKey

(
    FEditorViewportClient * Viewpor...,
    FViewport * Viewport,
    FKey Key,
    EInputEvent Event
)

True if the key was handled by this editor mode tool.

Public function Virtual

bool

 

LostFocus

(
    FEditorViewportClient * Viewpor...,
    FViewport * Viewport
)

Public function Virtual

bool

 

MouseEnter

(
    FEditorViewportClient * Viewpor...,
    FViewport * Viewport,
    int32 x,
    int32 y
)

User input.

Public function Virtual

bool

 

MouseLeave

(
    FEditorViewportClient * Viewpor...,
    FViewport * Viewport
)

Public function Virtual

bool

 

MouseMove

(
    FEditorViewportClient * Viewpor...,
    FViewport * Viewport,
    int32 x,
    int32 y
)

Public function Virtual

bool

 

ReceivedFocus

(
    FEditorViewportClient * Viewpor...,
    FViewport * Viewport
)

Public function Virtual

void

 

Render

(
    const FSceneView * View,
    FViewport * Viewport,
    FPrimitiveDrawInterface * PDI
)

Public function Virtual

void

 

SelectNone()

Public function Virtual

bool

 

StartModify()

Public function Virtual

void

 

StartTrans()

Public function Virtual

void

 

Tick

(
    FEditorViewportClient * Viewpor...,
    float DeltaTime
)

Tick.

Public function

bool

 

UseWidget()

Returns true if this tool wants to have input filtered through the editor widget.

References

Module

UnrealEd

Header

Editor/UnrealEd/Public/EditorModeTools.h