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 > Plugins > ModelingToolsEditorMode > FModelingToolsEditorMode

Light Theme

Dark Theme

FModelingToolsEditorMode

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

FGCObject

FEditorCommonDrawHelper

FEdMode

FModelingToolsEditorMode

References

Module	ModelingToolsEditorMode
Header	/Engine/Plugins/Experimental/ModelingToolsEditorMode/Source/ModelingToolsEditorMode/Public/ModelingToolsEditorMode.h
Include	#include "ModelingToolsEditorMode.h"

Syntax

class FModelingToolsEditorMode : public FEdMode

Variables

	Name	Description
FOnModelingMode...	OnToolNotificationMessage
FOnModelingMode...	OnToolWarningMessage
TUniquePtr< FSt...	StylusStateTracker
UEdModeInteract...	ToolsContext
TSharedPtr< FUI...	UICommandList	Command list lives here so that the key bindings on the commands can be processed in the viewport.

Constructors

	Name	Description
	FModelingToolsEditorMode()

Destructors

	Name	Description
	~FModelingToolsEditorMode()

Functions

		Name	Description
	void	ConfigureRealTimeViewportsOverride ( bool bEnable )
	void	FocusCameraAtCursorHotkey()
	UInteractive...	GetToolManager()
	UEdModeInter...	GetToolsContext()
	void	ModelingModeShortcutRequested ( EModelingModeActionCommands Command )

Overridden from FEdMode

	Name	Description
void	ActorSelectionChangeNotify()
bool	CanAutoSave()	Check to see if this EdMode wants to disallow AutoSave
bool	CapturedMouseMove ( FEditorViewportClient* InViewp..., FViewport* InViewport, int32 InMouseX, int32 InMouseY )	Called during mouse-down mouse-move.
void	DrawHUD ( FEditorViewportClient* Viewpor..., FViewport* Viewport, const FSceneView* View, FCanvas* Canvas )	Overlays the editor hud (brushes, drag tools, static mesh vertices, etc*.
bool	EndTracking ( FEditorViewportClient* InViewp..., FViewport* InViewport )	Always called on mouse-up
void	Enter()	Called when we "start" this editor mode (ie switch to this tab)
void	Exit()	Called when we "end" this editor mode (ie switch to another tab)
bool	GetPivotForOrbit ( FVector& OutPivot )	Lets each mode/tool specify a pivot point around which the camera should orbit
bool	InputAxis ( FEditorViewportClient* InViewp..., FViewport* Viewport, int32 ControllerId, FKey Key, float Delta, float DeltaTime )	Called for 1D Axis movements - EKeys::MouseX, EKeys::MouseY, and EKeys::MouseWheelAxis Called even if we return true from InputKey which otherwise blocks tracking.
bool	InputKey ( FEditorViewportClient* Viewpor..., FViewport* Viewport, FKey Key, EInputEvent Event )	Input Button/Axis Events & Mouse Capture
bool	LostFocus ( FEditorViewportClient* Viewpor..., FViewport* Viewport )	Called when viewport window loses focus (ie when some other window is focused) not called when editor is backgrounded, but is called when editor is minimized
bool	MouseEnter ( FEditorViewportClient* Viewpor..., FViewport* Viewport, int32 x, int32 y )	Called when mouse moves over viewport window
bool	MouseLeave ( FEditorViewportClient* Viewpor..., FViewport* Viewport )	Called when mouse leaves viewport window
bool	MouseMove ( FEditorViewportClient* Viewpor..., FViewport* Viewport, int32 x, int32 y )	Called on any mouse-move event. not called during tracking/capturing, eg if any button is down
bool	ProcessEditCut()
bool	ProcessEditDelete()
bool	ReceivedFocus ( FEditorViewportClient* Viewpor..., FViewport* Viewport )	Called when viewport window is focused
void	Render ( const FSceneView* View, FViewport* Viewport, FPrimitiveDrawInterface* PDI )	Draws translucent polygons on brushes and volumes.
bool	ShouldDrawWidget()	Lets the mode determine if it wants to draw the widget or not.
bool	StartTracking ( FEditorViewportClient* InViewp..., FViewport* InViewport )	Called on mouse-down.
void	Tick ( FEditorViewportClient* Viewpor..., float DeltaTime )
bool	UsesToolkits()	True if this mode uses a toolkit mode (eventually they all should)
bool	UsesTransformWidget()	Lets each tool determine if it wants to use the editor widget or not.

Overridden from FGCObject

		Name	Description
	void	AddReferencedObjects ( FReferenceCollector& Collector )	Pure virtual that must be overloaded by the inheriting class.

Typedefs

Name	Description
FOnModelingModeToolNotification

Constants

Name	Description
EM_ModelingToolsEditorModeId
LastModeStartTimestamp	Analytics tracking
LastToolStartTimestamp

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

Take our survey

Dismiss