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

Light Theme

Dark Theme

FEdMode

Base class for all editor modes.

Windows

MacOS

Linux

Inheritance Hierarchy

References

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

Syntax

class FEdMode :
    public TSharedFromThis< FEdMode >,
    public FGCObject,
    public FEditorCommonDrawHelper

Remarks

Base class for all editor modes.

Variables

	Name	Description
bool	bEditedPropertyIsTransform	Indicates
FModeTool *	CurrentTool	The tool that is currently active within this mode.
EAxisList::Type	CurrentWidgetAxis	The current axis that is being dragged on the widget.
int32	EditedPropertyIndex	If the property being edited is an array property, this is the index of the element we're currently dealing with
FString	EditedPropertyName	Name of the property currently being edited
FEditorModeInfo	Info	Information pertaining to this mode.
FEditorModeTool...	Owner	Pointer back to the mode tools that we are registered with
TSharedPtr< cla...	Toolkit	Editor Mode Toolkit that is associated with this toolkit mode
TArray< FModeTo...	Tools	Optional array of tools for this mode.

Constructors

	Name	Description
	FEdMode()

Destructors

	Name	Description
	~FEdMode()

Functions

	Name	Description
void	ActorMoveNotify()
void	ActorPropChangeNotify()
void	ActorsDuplicatedNotify ( TArray< AActor* >& PreDuplica..., TArray< AActor* >& PostDuplic..., bool bOffsetLocations )
void	ActorSelectionChangeNotify()
bool	AllowsViewportDragTool()
bool	AllowWidgetMove()	If the EdMode is handling InputDelta (i.e., returning true from it), this allows a mode to indicated whether or not the Widget should also move.
bool	BoxSelect ( FBox& InBox, bool InSelect )	Lets each mode/tool handle box selection in its own way.
void	BuildModeToolbar ( FToolBarBuilder& ToolbarBuilder )	Called when the editor mode should rebuild its toolbar
bool	CanAutoSave()	Check to see if this EdMode wants to disallow AutoSave
bool	CanCreateWidgetForProperty ( FProperty* InProp )	Returns true if this property can support creating a widget in the editor
bool	CanCreateWidgetForStructure ( const UStruct* InPropStruct )	Returns true if this structure can support creating a widget in the editor
bool	CanCycleWidgetMode()	Check to see if the current widget mode can be cycled
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	CurrentToolChanged()
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()
FModeTool &#...	FindTool ( EModeTools InID )
bool	FrustumSelect ( const FConvexVolume& InFrustum, FEditorViewportClient* InViewp..., bool InSelect )	Lets each mode/tool handle frustum selection in its own way.
EEditAction:...	GetActionEditCopy()
EEditAction:...	GetActionEditCut()
EEditAction:...	GetActionEditDelete()
EEditAction:...	GetActionEditDuplicate()	Added for handling EDIT Command...
EEditAction:...	GetActionEditPaste()
const FModeT...	GetCurrentTool()
FModeTool &#...	GetCurrentTool()	Returns the current tool.
EAxisList::T...	GetCurrentWidgetAxis()
bool	GetCursor ( EMouseCursor::Type& OutCursor )	Get a cursor to override the default with, if any.
bool	GetCustomDrawingCoordinateSystem ( FMatrix& InMatrix, void* InData )
bool	GetCustomInputCoordinateSystem ( FMatrix& InMatrix, void* InData )
AActor *	GetFirstSelectedActorInstance()	Returns the first selected Actor, or NULL if there is no selection.
FEditorModeI...	GetID()	Returns the editor mode identifier.
UObject *...	GetItemToTryDisplayingWidgetsFor ( FTransform& OutWidgetToWorld )	Finds the best item to display widgets for (preferring selected components over selected actors)
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
void	GetPropertyWidgetInfos ( const UStruct* InStruct, const void* InContainer, TArray< FPropertyWidgetInfo >& Out... )	Gets an array of property widget info structures for the given struct/class type for the given container.
TSharedPtr< ...	GetToolkit()	Gets the toolkit created by this mode
const TArray...	GetTools()
UTexture2D &...	GetVertexTexture()
EAxisList::T...	GetWidgetAxisToDraw ( FWidget::EWidgetMode InWidgetMode )	Allows each mode to customize the axis pieces of the widget they want drawn.
FVector	GetWidgetLocation()	Allows each mode/tool to determine a good location for the widget to be drawn at.
FVector	GetWidgetNormalFromCurrentAxis ( void* InData )
UWorld *	GetWorld()	Returns the world this toolkit is editing
bool	HandleClick ( FEditorViewportClient* InViewp..., HHitProxy* HitProxy, const FViewportClick& Click )
bool	HandleDragDuplicate()	Called when attempting to duplicate the selected actors by alt+dragging, return true to prevent normal duplication.
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 )
bool	PostConvertMouseMovement ( FEditorViewportClient* InViewp... )	Called after mouse movement is converted to drag/rot
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	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)
bool	Select ( AActor* InActor, bool bInSelected )	Handling SelectActor
void	SelectionChanged()
void	SelectNone()
void	SetCurrentTool ( FModeTool* InModeTool )
void	SetCurrentTool ( EModeTools InID )
void	SetCurrentWidgetAxis ( EAxisList::Type InAxis )
bool	ShouldCreateWidgetForProperty ( FProperty* InProp )	See if we should create a widget for the supplied property when selecting an actor instance
bool	ShouldDrawBrushWireframe ( AActor* InActor )
bool	ShouldDrawWidget()	Lets the mode determine if it wants to draw the widget or not.
bool	ShowModeWidgets()
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()
bool	UsesPropertyWidgets()	Lets each mode selectively enable widgets for editing properties tagged with 'Show 3D Widget' metadata.
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.
bool	UsesTransformWidget ( FWidget::EWidgetMode CheckMode )	Lets each mode selectively exclude certain widget types.

Overridden from FGCObject

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

Classes

	Name	Description
	FPropertyWidgetInfo	Property Widgets.

Constants

Name	Description
MD_MakeEditWidget	: Find a better home for these?
MD_ValidateWidgetUsing	Specifies a function used for validation of the current value of a property.

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

Take our survey

Dismiss