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 > FEditorModeTools

Light Theme

Dark Theme

FEditorModeTools

A helper class to store the state of the various editor modes.

Windows

MacOS

Linux

Inheritance Hierarchy

FGCObject

FEditorUndoClient

FEditorModeTools

FAssetEditorModeManager

IPersonaEditorModeManager

References

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

Syntax

class FEditorModeTools :
public FGCObject,
public FEditorUndoClient

Remarks

A helper class to store the state of the various editor modes.

Variables

	Name	Description
TArray< UEdMode...	ActiveScriptableModes	A list of active editor modes.
bool	bHideViewportUI	If true, the viewports will hide all UI overlays
bool	bSelectionHasSceneComponent	If true the current selection has a scene component
bool	bShowWidget	If 1, draw the widget and let the user interact with it.
FVector	CachedLocation
TArray< FEditor...	DefaultModeIDs	List of default modes for this tool. These must all be compatible with each other.
FVector	GridBase
FString	InfoString	Draws in the top level corner of all FEditorViewportClient windows (can be used to relay info to the user).
FWidget::EWidge...	OverrideWidgetMode	If the widget mode is being overridden, this will be != WM_None.
FVector	PivotLocation
bool	PivotShown
TMap< FEditorMo...	RecycledScriptableModes	A list of previously active editor modes that we will potentially recycle
bool	SnappedActor
FVector	SnappedLocation
bool	Snapping
TWeakPtr< ITool...	ToolkitHost	The host of the toolkits created by these modes
float	TranslateRotate2DAngle	The angles for the 2d translate rotate widget
float	TranslateRotateXAxisAngle	The angle for the translate rotate widget
FWidget::EWidge...	WidgetMode	The mode that the editor viewport widget is in.
float	WidgetScale	Scale Factor for Widget

Constructors

	Name	Description
	FEditorModeTools()

Destructors

	Name	Description
	~FEditorModeTools()

Functions

	Name	Description
void	ActivateDefaultMode()	Activates the default modes defined by this class.
void	ActivateMode ( FEditorModeID InID, bool bToggle )	Activates an editor mode.
void	ActorMoveNotify()
void	ActorPropChangeNotify()
void	ActorsDuplicatedNotify ( TArray< AActor* >& InPreDupli..., TArray< AActor* >& InPostDupl..., const bool bOffsetLocations )
void	ActorSelectionChangeNotify()
void	AddDefaultMode ( const FEditorModeID DefaultModeID )	Adds a new default mode to this tool's list of default modes.
bool	AllowsViewportDragTool()
bool	AllowWidgetMove()	True if we should allow widget move true if we should allow widget move
bool	BoxSelect ( FBox& InBox, bool InSelect )	Notifies all active modes of box selection attempts
void	BroadcastCoordSystemChanged ( ECoordSystem InCoordSystem )	Broadcasts the CoordSystemChangedEvent event
void	BroadcastEditorModeIDChanged ( const FEditorModeID& ModeID, bool IsEnteringMode )	Broadcasts the EditorModeIDChanged event
void	BroadcastWidgetModeChanged ( FWidget::EWidgetMode InWidgetMode )	Broadcasts the WidgetModeChanged event
bool	CanAutoSave()	Returns true if all active EdModes are OK with an AutoSave happening now
bool	CanCycleWidgetMode()	Check with modes to see if the widget mode can be cycled
bool	CapturedMouseMove ( FEditorViewportClient* InViewp..., FViewport* InViewport, int32 InMouseX, int32 InMouseY )	Notifies all active modes of captured mouse movement
bool	ComputeBoundingBoxForViewportFocus ( AActor* Actor, UPrimitiveComponent* Primitive..., FBox& InOutBox )	Allows editor modes to override the bounding box used to focus the viewport on a selection
void	CycleWidgetMode()	Cycle the widget mode, forwarding queries to modes Used to cycle widget modes
void	DeactivateAllModes()	Deactivates all modes, some modes can never be deactivated.
void	DeactivateMode ( FEditorModeID InID )	Deactivates an editor mode.
void	DeactivateOtherVisibleModes ( FEditorModeID InMode )
void	DeactivateScriptableModeAtIndex ( int32 InIndex )	Deactivates the editor mode at the specified index
void	DestroyMode ( FEditorModeID InID )	Deactivate the mode and entirely purge it from memory. Used when a mode type is unregistered
bool	DisallowMouseDeltaTracking()	True if we should disallow mouse delta tracking.
void	DrawActiveModes ( const FSceneView* InView, FPrimitiveDrawInterface* PDI )	Draws all active modes Draws all active mode components
void	DrawHUD ( FEditorViewportClient* InViewp..., FViewport* Viewport, const FSceneView* View, FCanvas* Canvas )	Draws the HUD for all active modes
bool	EndTracking ( FEditorViewportClient* InViewp..., FViewport* InViewport )	Mouse tracking interface. Passes tracking messages to all active modes
bool	EnsureNotInMode ( FEditorModeID ModeID, const FText& ErrorMsg, bool bNotifyUser )	Returns true if the current mode is not the specified ModeID. Also optionally warns the user.
bool	FrustumSelect ( const FConvexVolume& InFrustum, FEditorViewportClient* InViewp..., bool InSelect )	Notifies all active modes of frustum selection attempts
EEditAction:...	GetActionEditCopy()
EEditAction:...	GetActionEditCut()
EEditAction:...	GetActionEditDelete()
EEditAction:...	GetActionEditDuplicate()
EEditAction:...	GetActionEditPaste()
const FEdMod...	GetActiveMode ( FEditorModeID InID )	Returns a pointer to an active mode specified by the passed in ID If the editor mode is not active, NULL is returned
FEdMode *...	GetActiveMode ( FEditorModeID InID )	Returns a pointer to an active mode specified by the passed in ID If the editor mode is not active, NULL is returned
SpecificMode...	GetActiveModeTyped ( FEditorModeID InID )
const Specif...	GetActiveModeTyped ( FEditorModeID InID )
UEdMode *...	GetActiveScriptableMode ( FEditorModeID InID )
const FModeT...	GetActiveTool ( FEditorModeID InID )	Returns the active tool of the passed in editor mode.
ECoordSystem	GetCoordSystem ( bool bGetRawValue )	Returns the current CoordSystem
bool	GetCursor ( EMouseCursor::Type& OutCursor )	Get a cursor to override the default with, if any
FMatrix	GetCustomDrawingCoordinateSystem()	Returns a coordinate system that should be applied on top of the worldspace system.
FMatrix	GetCustomInputCoordinateSystem()
FEditorViewp...	GetFocusedViewportClient()	Returns the currently focused viewport client
FEditorViewp...	GetHoveredViewportClient()	Returns the currently hovered viewport client
FMatrix	GetLocalCoordinateSystem()
bool	GetOverrideCursorVisibility ( bool& bWantsOverride, bool& bHardwareCursorVisible, bool bSoftwareCursorVisible )	Get override cursor visibility settings
bool	GetPivotForOrbit ( FVector& OutPivot )	Get a pivot point specified by any active modes around which the camera should orbit
USelection &...	GetSelectedActors()	Returns the set of selected actors.
USelection &...	GetSelectedComponents()	Returns the set of selected components.
USelection &...	GetSelectedObjects()
bool	GetShowWidget()
TSharedPtr< ...	GetToolkitHost()	Returns the host for toolkits created via modes from this mode manager
EAxisList::T...	GetWidgetAxisToDraw ( FWidget::EWidgetMode InWidgetMode )	Gets the widget axis to be drawn
FVector	GetWidgetLocation()	Returns a good location to draw the widget at.
FWidget::EWi...	GetWidgetMode()	Retrieves the current widget mode, taking overrides into account.
float	GetWidgetScale()	Get Widget Scale Get Scale On The Widget
UWorld *	GetWorld()	Returns the world that is being edited by this mode manager
bool	HandleClick ( FEditorViewportClient* InViewp..., HHitProxy* HitProxy, const FViewportClick& Click )	Notifies all active modes of mouse click messages.
bool	HasToolkitHost()	Check if toolkit host exists
bool	InputAxis ( FEditorViewportClient* InViewp..., FViewport* Viewport, int32 ControllerId, FKey Key, float Delta, float DeltaTime )	Notifies all active modes of axis movement
bool	InputDelta ( FEditorViewportClient* InViewp..., FViewport* InViewport, FVector& InDrag, FRotator& InRot, FVector& InScale )	Notifies all active modes of any change in mouse movement
bool	InputKey ( FEditorViewportClient* InViewp..., FViewport* Viewport, FKey Key, EInputEvent Event )	Notifies all active modes of keyboard input
void	InvokeToolPaletteTab ( FEditorModeID InMode, FName InPaletteName )	Sets the active Modes ToolBar Palette Tab to the named Palette
bool	IsDefaultMode ( const FEditorModeID ModeID )	Returns whether or not the provided mode ID is a default mode
bool	IsDefaultModeActive()	Returns true if the default modes are active.
bool	IsModeActive ( FEditorModeID InID )	Returns true if the passed in editor mode is active
bool	IsOnlyVisibleActiveMode ( FEditorModeID InMode )
bool	IsSelectionAllowed ( AActor* InActor, const bool bInSelected )
bool	IsSelectionHandled ( AActor* InActor, const bool bInSelected )
bool	IsSnapRotationEnabled()
bool	IsTracking()
bool	IsViewportUIHidden()	Is the viewport UI hidden?
void	LoadConfig()	Loads the state that was saved in the INI file
void	LoadWidgetSettings()	Load Widget Settings from Ini file
bool	LostFocus ( FEditorViewportClient* InViewp..., FViewport* Viewport )	Notifies all active modes that a viewport has lost focus
TSharedRef< ...	MakeModeToolbarTab()	Creates the mode toolbar tab if needed
void	MapChangeNotify()	Notifies all active modes that a map change has occured
bool	MouseEnter ( FEditorViewportClient* InViewp..., FViewport* Viewport, int32 X, int32 Y )
bool	MouseLeave ( FEditorViewportClient* InViewp..., FViewport* Viewport )
bool	MouseMove ( FEditorViewportClient* InViewp..., FViewport* Viewport, int32 X, int32 Y )	Notifies all active modes that the mouse has moved
FCoordSystem...	OnCoordSystemChanged()
FEditorModeI...	OnEditorModeIDChanged()
void	OnEditorSelectionChanged ( UObject* NewSelection )	Delegate handlers
void	OnEditorSelectNone()
void	OnModeUnregistered ( FEditorModeID ModeID )	Removes the mode ID from the tools manager when a mode is unregistered
FWidgetModeC...	OnWidgetModeChanged()
bool	PostConvertMouseMovement ( FEditorViewportClient* InViewp... )	Called after converting mouse movement to drag/rot
bool	PreConvertMouseMovement ( FEditorViewportClient* InViewp... )	Called before converting mouse movement to drag/rot
bool	ProcessCapturedMouseMoves ( FEditorViewportClient* InViewp..., FViewport* InViewport, const TArrayView< FIntPoint >& Cap... )	Notifies all active modes of all captured mouse movement
bool	ProcessEditCopy()
bool	ProcessEditCut()
bool	ProcessEditDelete()
bool	ProcessEditDuplicate()
bool	ProcessEditPaste()
bool	ReceivedFocus ( FEditorViewportClient* InViewp..., FViewport* Viewport )	Notifies all active modes that a viewport has received focus
void	RemoveDefaultMode ( const FEditorModeID DefaultModeID )	Removes a default mode
void	Render ( const FSceneView* InView, FViewport* Viewport, FPrimitiveDrawInterface* PDI )	Renders all active modes
void	SaveConfig()	Saves the current state to the INI file
void	SaveWidgetSettings()	Save Widget Settings to Ini file
bool	SelectionHasSceneComponent()	Whether or not the current selection has a scene component selected
void	SelectNone()	Notifies all active modes to empty their selections
void	SetCoordSystem ( ECoordSystem NewCoordSystem )	Sets the current CoordSystem
void	SetCurrentWidgetAxis ( EAxisList::Type NewAxis )	Sets the current widget axis
void	SetDefaultMode ( const FEditorModeID DefaultModeID )	Set the default editor mode for these tools
void	SetHideViewportUI ( bool bInHideViewportUI )	Sets the hide viewport UI state
void	SetPivotLocation ( const FVector& Location, const bool bIncGridBase )	Sets the pivot locations
void	SetShowWidget ( bool InShowWidget )
void	SetToolkitHost ( TSharedRef< IToolkitHost > Host )	Sets the host for toolkits created via modes from this mode manager (can only be called once)
void	SetWidgetMode ( FWidget::EWidgetMode InWidgetMode )	Changes the current widget mode.
void	SetWidgetModeOverride ( FWidget::EWidgetMode InWidgetMode )	Allows you to temporarily override the widget mode.
void	SetWidgetScale ( float InScale )	Set Scale On The Widget
bool	ShouldDrawBrushVertices()	True if brush vertices should be drawn
bool	ShouldDrawBrushWireframe ( AActor* InActor )	True if the passed in brush actor should be drawn in wireframe
bool	ShouldShowModeToolbar()	Whether or not the mode toolbar should be shown.
bool	SnapRotatorToGridOverride ( FRotator& InRotation )
bool	StartTracking ( FEditorViewportClient* InViewp..., FViewport* InViewport )	Mouse tracking interface. Passes tracking messages to all active modes
void	Tick ( FEditorViewportClient* Viewpor..., float DeltaTime )	Ticks all active modes
void	UpdateInternalData()
bool	UsesTransformWidget()	True if any active mode uses a transform widget
bool	UsesTransformWidget ( FWidget::EWidgetMode CheckMode )	True if any active mode uses the passed in transform widget

Overridden from FGCObject

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

Overridden from FEditorUndoClient

		Name	Description
	void	PostRedo ( bool bSuccess )	Signal that client should run any PostRedo code
	void	PostUndo ( bool bSuccess )	Begin FEditorUndoClient.

Classes

	Name	Description
	FCoordSystemChangedEvent	Delegate type for triggering when coordinate system changed
	FEditorModeIDChangedEvent	Multicast delegate for OnModeEntered and OnModeExited callbacks.
	FWidgetModeChangedEvent	Delegate type for triggering when widget mode changed

Constants

Name	Description
EditorModeToolbarTabName	The toolbar tab name that should be used as the tab identifier

Deprecated Functions

	Name	Description
bool	CheckBookmark ( uint32 InIndex, FEditorViewportClient* InViewp... )	Use IBookmarkTypeTools::Get().CheckBookmark
void	ClearAllBookmarks ( FEditorViewportClient* InViewp... )	Use IBookmarkTypeTools::Get().ClearAllBookmarks
void	ClearBookmark ( uint32 InIndex, FEditorViewportClient* InViewp... )	Use IBookmarkTypeTools::Get().ClearBookmark
void	CompactBookmarks ( FEditorViewportClient* InViewp... )	Use IBookmarkTypeTools::Get().CompactBookmarks
const uint32	GetMaxNumberOfBookmarks ( FEditorViewportClient* InViewp... )	Use IBookmarkTypeTools::Get().GetMaxNumberOfBookmarks
bool	GetShowFriendlyVariableNames()	Use GetDefault()->bShowFriendlyNames
void	JumpToBookmark ( uint32 InIndex, TSharedPtr< struct FBookmarkBaseJum..., FEditorViewportClient* InViewp... )	Use IBookmarkTypeTools::Get().JumpToBookmark
void	SetBookmark ( uint32 InIndex, FEditorViewportClient* InViewp... )	Use IBookmarkTypeTools::Get().CreateOrSetBookmark
bool	ShouldShowModeToolbox()	Individual toolkit hosts, such as the level editor, should handle determining if they show a mode toolbox for hosted toolkits.

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

Take our survey

Dismiss