UEdMode

Base class for all editor modes.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UEdMode

UBaseLegacyWidgetEdMode

UEdModeDefault

UAssetPlacementEdMode

UFractureEditorMode

UGroomEditorMode

UModelingToolsEditorMode

USequencerToolsEditMode

UStaticMeshEditorModelingMode

UGizmoEdMode

USampleToolsEditorMode

UUVEditorMode

References

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

Syntax

class UEdMode : public UObject

Remarks

Base class for all editor modes.

Variables

	Name	Description
bool	bHaveSavedEditorState
bool	bSavedAntiAliasingState
FEditorModeInfo	Info	Information pertaining to this mode. Should be assigned in the constructor.
FEditorModeTool...	Owner	Pointer back to the mode tools that we are registered with
TSoftClassPtr< ...	SettingsClass
TObjectPtr< UOb...	SettingsObject
TSharedPtr< FUI...	ToolCommandList	Command list lives here so that the key bindings on the commands can be processed in the viewport.
TSharedPtr< FMo...	Toolkit	Editor Mode Toolkit that is associated with this toolkit mode

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()
FEdMode *...	AsLegacyMode()	For use by the EditorModeTools class to get the legacy FEdMode type from a legacy FEdMode wrapper You should not need to override this function in your UEdMode implementation.
void	BindCommands()
bool	CanAutoSave()	Check to see if this UEdMode wants to disallow AutoSave
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	Enter()
void	Exit()
EEditAction:...	GetActionEditCopy()
EEditAction:...	GetActionEditCut()
EEditAction:...	GetActionEditDelete()
EEditAction:...	GetActionEditDuplicate()	Added for handling EDIT Command...
EEditAction:...	GetActionEditPaste()
bool	GetCursor ( EMouseCursor::Type& OutCursor )	Get a cursor to override the default with, if any.
EToolsContex...	GetDefaultToolScope()	Default Scope for InteractiveToolsContext API functions, eg RegisterTool(), GetToolManager(), GetInteractiveToolsContext().
AActor *	GetFirstSelectedActorInstance()	Returns the first selected Actor, or NULL if there is no selection.
FEditorModeI...	GetID()	Returns the editor mode identifier.
UEditorInter...	GetInteractiveToolsContext ( EToolsContextScope ToolScope )
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
TWeakPtr< FM...	GetToolkit()	Gets the toolkit created by this mode
UInteractive...	GetToolManager ( EToolsContextScope ToolScope )
UWorld *	GetWorld()	Returns the world this toolkit is editing
void	Initialize()
bool	IsCompatibleWith ( FEditorModeID OtherModeID )
bool	IsOperationSupportedForCurrentAsset ( EAssetOperation InOperation )	Check to see if this UEdMode wants to disallow operation on current asset
bool	IsSelectionAllowed ( AActor* InActor, bool bInSelection )	Check to see if an actor can be selected in this mode - no side effects
bool	IsSelectionDisallowed ( AActor* InActor, bool bInSelection )	Check to see if an actor selection is exclusively dissallowed by a mode no side effects
bool	IsSnapRotationEnabled()	If Rotation Snap should be enabled for this mode
void	MapChangeNotify()
void	ModeTick ( float DeltaTime )
void	OnModeActivated ( const FEditorModeID& InID, bool bIsActive )
bool	OnRequestClose()
void	OnToolEnded ( UInteractiveToolManager* Manag..., UInteractiveTool* Tool )
void	OnToolStarted ( UInteractiveToolManager* Manag..., UInteractiveTool* Tool )
void	PostUndo()
bool	ProcessEditCopy()
bool	ProcessEditCut()
bool	ProcessEditDelete()
bool	ProcessEditDuplicate()
bool	ProcessEditPaste()
void	RegisterTool ( TSharedPtr< FUICommandInfo > UIComm..., FString ToolIdentifier, UInteractiveToolBuilder* Build..., EToolsContextScope ToolScope )
bool	Select ( AActor* InActor, bool bInSelected )	Handling SelectActor
void	SelectionChanged()
void	SelectNone()
bool	ShouldDrawBrushWireframe ( AActor* InActor )
bool	ShouldToolStartBeAllowed ( const FString& ToolIdentifier )	Subclasses can override this to add additional checks on whether a tool should be allowed to start.
bool	SnapRotatorToGridOverride ( FRotator& Rotation )	If this mode should override the snap rotation
void	UpdateInternalData()
bool	UsesToolkits()	True if this mode uses a toolkit mode (eventually they all should)