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 > Tools > UEdMode

Light Theme

Dark Theme

UEdMode

Base class for all editor modes.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UEdMode

References

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

Syntax

class UEdMode :
public UObject,
public FEditorCommonDrawHelper

Remarks

Base class for all editor modes.

Variables

	Name	Description
IToolsContextAs...	AssetAPI
FDelegateHandle	BeginPIEDelegateHandle	Called when PIE is about to start, shuts down active tools
bool	bHaveSavedEditorState
bool	bInvalidationPending
bool	bSavedAntiAliasingState
FInputDeviceSta...	CurrentMouseState	Input event instance used to keep track of various button states, etc, that we cannot directly query on-demand
FName	CurrentPaletteName
FEditorModeInfo	Info	Information pertaining to this mode.
FDelegateHandle	MapChangeDelegateHandle	Called before a map changes. This currently shuts down active tools.
FOnModeToolNoti...	OnToolNotificationMessage
FOnModeToolNoti...	OnToolWarningMessage
FEditorModeTool...	Owner	Pointer back to the mode tools that we are registered with
IToolsContextQu...	QueriesAPI
TSoftClassPtr< ...	SettingsClass
UObject *	SettingsObject
UMaterialInterf...	StandardVertexColorMaterial	Property Widgets.
TSharedPtr< FUI...	ToolCommandList	Command list lives here so that the key bindings on the commands can be processed in the viewport.
TSharedPtr< cla...	Toolkit	Editor Mode Toolkit that is associated with this toolkit mode
UInteractiveToo...	ToolsContext
TSoftClassPtr< ...	ToolsContextClass
IToolsContextTr...	TransactionAPI

Constructors

	Name	Description
	UEdMode()

Functions

	Name	Description
void	ActivateDefaultTool()
void	ActorMoveNotify()
void	ActorPropChangeNotify()
void	ActorsDuplicatedNotify ( TArray< AActor* >& PreDuplica..., TArray< AActor* >& PostDuplic..., bool bOffsetLocations )
void	ActorSelectionChangeNotify()
bool	AllowsViewportDragTool()
bool	CanAutoSave()	Check to see if this UEdMode wants to disallow AutoSave
bool	CapturedMouseMove ( FEditorViewportClient* InViewp..., FViewport* InViewport, int32 InMouseX, int32 InMouseY )	Called when the mouse is moved while a window input capture is in effect
bool	ComputeBoundingBoxForViewportFocus ( AActor* Actor, UPrimitiveComponent* Primitive..., FBox& InOutBox )	Allows an editor mode to override the bounding box used to focus the viewport on a selection
void	CreateToolkit()
void	DeactivateAllActiveTools()
bool	DisallowMouseDeltaTracking()	If the Edmode is handling its own mouse deltas, it can disable the MouseDeltaTacker
void	DrawBrackets ( FEditorViewportClient* Viewpor..., FViewport* Viewport, const FSceneView* View, FCanvas* Canvas )	Called when the mode wants to draw brackets around selected objects
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 )
void	Enter()
void	Exit()
EEditAction:...	GetActionEditCopy()
EEditAction:...	GetActionEditCut()
EEditAction:...	GetActionEditDelete()
EEditAction:...	GetActionEditDuplicate()	Added for handling EDIT Command...
EEditAction:...	GetActionEditPaste()
FName	GetCurrentPaletteName()
bool	GetCursor ( EMouseCursor::Type& OutCursor )	Get a cursor to override the default with, if any.
AActor *	GetFirstSelectedActorInstance()	Returns the first selected Actor, or NULL if there is no selection.
FEditorModeI...	GetID()	Returns the editor mode identifier.
TMap< FName,...	GetModeCommands()
const FEdito...	GetModeInfo()	Returns the editor mode information.
FEditorModeT...	GetModeManager()	Returns the owning mode manager for this mode
bool	GetOverrideCursorVisibility ( bool& bWantsOverride, bool& bHardwareCursorVisible, bool bSoftwareCursorVisible )	Get override cursor visibility settings
bool	GetPivotForOrbit ( FVector& OutPivot )	Lets each mode/tool specify a pivot point around which the camera should orbit
TSharedPtr< ...	GetToolkit()	Gets the toolkit created by this mode
UInteractive...	GetToolManager()
UTexture2D &...	GetVertexTexture()
UWorld *	GetWorld()	Returns the world this toolkit is editing
bool	HandleClick ( FEditorViewportClient* InViewp..., HHitProxy* HitProxy, const FViewportClick& Click )
void	Initialize()
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	IsCompatibleWith ( FEditorModeID OtherModeID )
bool	IsPendingDeletion()	Returns true if this mode is to be deleted at the next convenient opportunity (FEditorModeTools::Tick)
bool	IsSelectionAllowed ( AActor* InActor, bool bInSelection )	Check to see if an actor can be selected in this mode - no side effects
bool	IsSnapRotationEnabled()	If Rotation Snap should be enabled for this mode
bool	LostFocus ( FEditorViewportClient* Viewpor..., FViewport* Viewport )
void	MapChangeNotify()
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 )
void	OnToolEnded ( UInteractiveToolManager* Manag..., UInteractiveTool* Tool )
void	OnToolStarted ( UInteractiveToolManager* Manag..., UInteractiveTool* Tool )
bool	PostConvertMouseMovement ( FEditorViewportClient* InViewp... )	Called after mouse movement is converted to drag/rot
void	PostInvalidation()
void	PostUndo()
bool	PreConvertMouseMovement ( FEditorViewportClient* InViewp... )	Called before mouse movement is converted to drag/rot
bool	ProcessCapturedMouseMoves ( FEditorViewportClient* InViewp..., FViewport* InViewport, const TArrayView< FIntPoint >& Cap... )	Process all captured mouse moves that occurred during the current frame
bool	ProcessEditCopy()
bool	ProcessEditCut()
bool	ProcessEditDelete()
bool	ProcessEditDuplicate()
bool	ProcessEditPaste()
bool	ReceivedFocus ( FEditorViewportClient* Viewpor..., FViewport* Viewport )
void	RegisterTool ( TSharedPtr< FUICommandInfo > UIComm..., FString ToolIdentifier, UInteractiveToolBuilder* Build... )
void	Render ( const FSceneView* View, FViewport* Viewport, FPrimitiveDrawInterface* PDI )	Draws translucent polygons on brushes and volumes.
void	RequestDeletion()	Request that this mode be deleted at the next convenient opportunity (FEditorModeTools::Tick)
void	RestoreEditorState()
bool	Select ( AActor* InActor, bool bInSelected )	Handling SelectActor
void	SelectionChanged()
void	SelectNone()
void	SetCurrentPaletteName ( FName InName )
bool	ShouldDrawBrushWireframe ( AActor* InActor )
bool	SnapRotatorToGridOverride ( FRotator& Rotation )	If this mode should override the snap rotation
bool	StartTracking ( FEditorViewportClient* InViewp..., FViewport* InViewport )
void	Tick ( FEditorViewportClient* Viewpor..., float DeltaTime )
void	UpdateInternalData()
void	UpdateOnPaletteChange()
bool	UsesToolkits()	True if this mode uses a toolkit mode (eventually they all should)

Typedefs

Name	Description
FOnModeToolNotification

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

Take our survey

Dismiss