1. Epic GamesDeveloper
  3. FModeTool

FModeTool

Base class for all editor mode tools.

Unreal Engine C++ API Reference > Editor > UnrealEd

Inheritance Hierarchy

References

   
Module UnrealEd
Header /Engine/Source/Editor/UnrealEd/Public/EditorModeTools.h
Include #include "EditorModeTools.h"

Syntax

class FModeTool

Remarks

Base class for all editor mode tools.

Variables

  Type 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

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual bool

BoxSelect ( FBox& InBox,
bool InSelect
)

  
Public function Virtual bool

CapturedMouseMove ( FEditorViewportClient* InViewportClient,
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* ViewportClient,
FViewport* Viewport,
const FSceneView* View,
FCanvas* Canvas
)

  
Public function Virtual bool  
Public function Virtual void  
Public function Virtual bool

FrustumSelect ( const FConvexVolume& InFrustum,
FEditorViewportClient* InViewportClient,
bool InSelect
)

  
Public function Const EModeTools

GetID ()

 Returns the tool type.
Public function Virtual Const FString

GetName ()

 Returns the name that gets reported to the editor.
Public function Virtual bool

InputAxis ( FEditorViewportClient* InViewportClient,
FViewport* Viewport,
int32 ControllerId,
FKey Key,
float Delta,
float DeltaTime
)

  
Public function Virtual bool

InputDelta ( FEditorViewportClient* InViewportClient,
FViewport* InViewport,
FVector& InDrag,
FRotator& InRot,
FVector& InScale
)

  
Public function Virtual bool

InputKey ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
FKey Key,
EInputEvent Event
)

  
Public function Virtual bool

LostFocus ( FEditorViewportClient* ViewportClient,
FViewport* Viewport
)

  
Public function Virtual bool

MouseEnter ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
int32 x,
int32 y
)

  
Public function Virtual bool

MouseLeave ( FEditorViewportClient* ViewportClient,
FViewport* Viewport
)

  
Public function Virtual bool

MouseMove ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
int32 x,
int32 y
)

  
Public function Virtual bool

ReceivedFocus ( FEditorViewportClient* ViewportClient,
FViewport* Viewport
)

  
Public function Virtual void

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

  
Public function Virtual void  
Public function Virtual bool  
Public function Virtual void  
Public function Virtual void

Tick ( FEditorViewportClient* ViewportClient,
float DeltaTime
)

 Tick.
Public function Const bool Returns true if this tool wants to have input filtered through the editor widget.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page