Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > UnrealEd > FModeTool

Light Theme

Dark Theme

FModeTool

Base class for all editor mode tools.

Windows

MacOS

Linux

Inheritance Hierarchy

FModeTool

	FModeTool_GeometryModify
	FModeTool_InterpEdit
	FModeTool_Texture

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

		Name	Description
	bool	bUseWidget	If true, this tool wants to have input filtered through the editor widget.
	EModeTools	ID	Which tool this is.

Constructors

	Name	Description
	FModeTool()

Destructors

	Name	Description
	~FModeTool()

Functions

	Name	Description
bool	BoxSelect ( FBox& InBox, bool InSelect )
bool	CapturedMouseMove ( FEditorViewportClient* InViewp..., FViewport* InViewport, int32 InMouseX, int32 InMouseY )	Called when the mouse is moved while a window input capture is in effect
void	DrawHUD ( FEditorViewportClient* Viewpor..., FViewport* Viewport, const FSceneView* View, FCanvas* Canvas )
bool	EndModify()
void	EndTrans()
bool	FrustumSelect ( const FConvexVolume& InFrustum, FEditorViewportClient* InViewp..., bool InSelect )
EModeTools	GetID()	Returns the tool type.
FString	GetName()	Returns the name that gets reported to the editor.
bool	InputAxis ( FEditorViewportClient* InViewp..., FViewport* Viewport, int32 ControllerId, FKey Key, float Delta, float DeltaTime )
bool	InputDelta ( FEditorViewportClient* InViewp..., FViewport* InViewport, FVector& InDrag, FRotator& InRot, FVector& InScale )
bool	InputKey ( FEditorViewportClient* Viewpor..., FViewport* Viewport, FKey Key, EInputEvent Event )
bool	LostFocus ( FEditorViewportClient* Viewpor..., FViewport* Viewport )
bool	MouseEnter ( FEditorViewportClient* Viewpor..., FViewport* Viewport, int32 x, int32 y )
bool	MouseLeave ( FEditorViewportClient* Viewpor..., FViewport* Viewport )
bool	MouseMove ( FEditorViewportClient* Viewpor..., FViewport* Viewport, int32 x, int32 y )
bool	ReceivedFocus ( FEditorViewportClient* Viewpor..., FViewport* Viewport )
void	Render ( const FSceneView* View, FViewport* Viewport, FPrimitiveDrawInterface* PDI )
void	SelectNone()
bool	StartModify()
void	StartTrans()
void	Tick ( FEditorViewportClient* Viewpor..., float DeltaTime )	Tick.
bool	UseWidget()	Returns true if this tool wants to have input filtered through the editor widget.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss