1. Epic GamesDeveloper
  3. FEditorModeTools

FEditorModeTools

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

Unreal Engine C++ API Reference > Editor > UnrealEd

Inheritance Hierarchy

References

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

Syntax

class FEditorModeTools :  
    public FGCObject,  
    public FEditorUndoClient,  
    public TSharedFromThis< FEditorModeTools >

Remarks

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

Variables

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

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void Activates the default modes defined by this class.
Public function void

ActivateMode ( FEditorModeID InID,
bool bToggle
)

 Activates an editor mode.
Public function void  
Public function void  
Public function void

ActorsDuplicatedNotify ( TArray< AActor* >& InPreDuplicateSelection,
TArray< AActor* >& InPostDuplicateSelection,
const bool bOffsetLocations
)

  
Public function void  
Public function void

AddDefaultMode ( const FEditorModeID DefaultModeID
)

 Adds a new default mode to this tool's list of default modes.
Public function Const bool  
Public function Const bool True if we should allow widget movetrue if we should allow widget move
Public function bool

BoxSelect ( FBox& InBox,
bool InSelect
)

 Notifies all active modes of box selection attempts
Public function void

BroadcastCoordSystemChanged ( ECoordSystem InCoordSystem
)

 Broadcasts the CoordSystemChangedEvent event
Public function void

BroadcastEditorModeIDChanged ( const FEditorModeID& ModeID,
bool IsEnteringMode
)

 Broadcasts the EditorModeIDChanged event
Public function void Broadcasts the WidgetModeChanged event
Public function Const bool Sets the active Modes ToolBar Palette Tab to the named Palettereturns true if all active EdModes are OK with an AutoSave happening now
Public function Const bool Check with modes to see if the widget mode can be cycled
Public function bool

CapturedMouseMove ( FEditorViewportClient* InViewportClient,
FViewport* InViewport,
int32 InMouseX,
int32 InMouseY
)

 Notifies all active modes of captured mouse movement
Public function bool

ComputeBoundingBoxForViewportFocus ( AActor* Actor,
UPrimitiveComponent* PrimitiveComponent,
FBox& InOutBox
)

 Allows editor modes to override the bounding box used to focus the viewport on a selection
Public function void Cycle the widget mode, forwarding queries to modesUsed to cycle widget modes
Public function void Deactivates all modes, note some modes can never be deactivated.
Public function void

DeactivateMode ( FEditorModeID InID
)

 Deactivates an editor mode.
Protected function void

DeactivateModeAtIndex ( int32 Index
)

  
Public function void

DestroyMode ( FEditorModeID InID
)

 Deactivate the mode and entirely purge it from memory. Used when a mode type is unregistered
Public function Const bool True if we should disallow mouse delta tracking.
Public function void Draws all active modesDraws all active mode components
Protected function Virtual void

DrawBrackets ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
const FSceneView* View,
FCanvas* Canvas
)

  
Public function void

DrawHUD ( FEditorViewportClient* InViewportClient,
FViewport* Viewport,
const FSceneView* View,
FCanvas* Canvas
)

 Draws the HUD for all active modes
Public function bool

EndTracking ( FEditorViewportClient* InViewportClient,
FViewport* InViewport
)

 Mouse tracking interface. Passes tracking messages to all active modes
Public function Const 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.
Protected function void  
Protected function void

ExitMode ( UEdMode* InMode
)

 Exits the given editor mode
Protected function Const void

ForEachEdMode ( TFunctionRef< bool(InterfaceToCastTo*)> InCallback
)

  
Protected function Const void

ForEachEdMode ( TFunctionRef< bool(UEdMode*)> InCalllback
)

  
Public function bool

FrustumSelect ( const FConvexVolume& InFrustum,
FEditorViewportClient* InViewportClient,
bool InSelect
)

 Notifies all active modes of frustum selection attempts
Public function EEditAction::Type  
Public function EEditAction::Type  
Public function EEditAction::Type  
Public function EEditAction::Type  
Public function EEditAction::Type  
Public function Const const 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
Public function 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
Public function Const const SpecificModeType *

GetActiveModeTyped ( FEditorModeID InID
)

  
Public function SpecificModeType *

GetActiveModeTyped ( FEditorModeID InID
)

  
Public function Const UEdMode *

GetActiveScriptableMode ( FEditorModeID InID
)

  
Public function Const const FModeTool *

GetActiveTool ( FEditorModeID InID
)

 Returns the active tool of the passed in editor mode.
Public function ECoordSystem

GetCoordSystem ( bool bGetRawValue
)

 Returns the current CoordSystem
Public function Const bool

GetCursor ( EMouseCursor::Type& OutCursor
)

 Get a cursor to override the default with, if any
Public function FMatrix  
Public function FMatrix  
Public function Const UTypedElementSelectionSet * Returns the selection set for the toolkit host. (i.e. the selection set for the level editor)
Public function Const FEditorViewportClient * Returns the currently focused viewport client
Public function Const FEditorViewportClient * Returns the currently hovered viewport client
Public function Const UModeManagerInteractiveToolsContext *  
Public function FMatrix  
Public function Const bool

GetOverrideCursorVisibility ( bool& bWantsOverride,
bool& bHardwareCursorVisible,
bool bSoftwareCursorVisible
)

 Get override cursor visibility settings
Public function Const bool

GetPivotForOrbit ( FVector& OutPivot
)

 Get a pivot point specified by any active modes around which the camera should orbit
Public function Virtual Const USelection * Returns the set of selected actors.
Public function Virtual Const USelection * Returns the set of selected components.
Public function Virtual Const USelection *  
Public function Const bool  
Public function Const TSharedPtr< IToolkitHost > Returns the host for toolkits created via modes from this mode manager
Public function Virtual Const UTexture2D *  
Public function Const EAxisList::Type Gets the widget axis to be drawn
Public function Const FVector Returns a good location to draw the widget at.
Public function Const UE::Widget::EWidgetMode Retrieves the current widget mode, taking overrides into account.
Public function Const float Get Widget ScaleGet Scale On The Widget
Public function Virtual Const UWorld * Returns the world that is being edited by this mode manager
Public function bool

HandleClick ( FEditorViewportClient* InViewportClient,
HHitProxy* HitProxy,
const FViewportClick& Click
)

 Notifies all active modes of mouse click messages.
Public function Const bool Check if toolkit host exists
Public function bool

InputAxis ( FEditorViewportClient* InViewportClient,
FViewport* Viewport,
int32 ControllerId,
FKey Key,
float Delta,
float DeltaTime
)

 Notifies all active modes of axis movement
Public function bool

InputDelta ( FEditorViewportClient* InViewportClient,
FViewport* InViewport,
FVector& InDrag,
FRotator& InRot,
FVector& InScale
)

 Notifies all active modes of any change in mouse movement
Public function bool

InputKey ( FEditorViewportClient* InViewportClient,
FViewport* Viewport,
FKey Key,
EInputEvent Event,
bool bRouteToToolsContext
)

 Notifies all active modes of keyboard input
Public function Const bool

IsDefaultMode ( const FEditorModeID ModeID
)

 Returns whether or not the provided mode ID is a default mode
Public function Const bool Returns true if the default modes are active.
Public function Const bool

IsModeActive ( FEditorModeID InID
)

 Returns true if the passed in editor mode is active
Public function Const bool

IsOnlyActiveMode ( FEditorModeID InMode
)

  
Public function Const bool

IsOnlyVisibleActiveMode ( FEditorModeID InMode
)

  
Public function Const bool

IsOperationSupportedForCurrentAsset ( EAssetOperation InOperation
)

 Returns true if all active EdModes are OK support operation on current asset
Public function Const bool

IsSelectionAllowed ( AActor* InActor,
const bool bInSelected
)

  
Public function Const bool

IsSelectionHandled ( AActor* InActor,
const bool bInSelected
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool Is the viewport UI hidden?
Public function void Loads the state that was saved in the INI file
Public function void Load Widget Settings from Ini file
Public function bool

LostFocus ( FEditorViewportClient* InViewportClient,
FViewport* Viewport
)

 Notifies all active modes that a viewport has lost focus
Public function void Notifies all active modes that a map change has occured
Public function bool

MouseEnter ( FEditorViewportClient* InViewportClient,
FViewport* Viewport,
int32 X,
int32 Y
)

  
Public function bool

MouseLeave ( FEditorViewportClient* InViewportClient,
FViewport* Viewport
)

  
Public function bool

MouseMove ( FEditorViewportClient* InViewportClient,
FViewport* Viewport,
int32 X,
int32 Y
)

 Notifies all active modes that the mouse has moved
Public function FCoordSystemChangedEvent &  
Public function FEditorModeIDChangedEvent &  
Protected function void

OnEditorSelectionChanged ( UObject* NewSelection
)

 Delegate handlers
Protected function void  
Protected function void

OnModeUnregistered ( FEditorModeID ModeID
)

 Removes the mode ID from the tools manager when a mode is unregistered
Public function bool Called by Editors when they are about to close
Public function FWidgetModeChangedEvent &  
Protected function void

OnWorldCleanup ( UWorld* InWorld,
bool bSessionEnded,
bool bCleanupResources
)

 Handles the notification when a world is going through GC to clean up any modes pending deactivation.
Public function bool Called after converting mouse movement to drag/rot
Public function bool Called before converting mouse movement to drag/rot
Public function bool

ProcessCapturedMouseMoves ( FEditorViewportClient* InViewportClient,
FViewport* InViewport,
const TArrayView< FIntPoint >& CapturedMouseMoves
)

 Notifies all active modes of all captured mouse movement
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function bool  
Public function bool

ReceivedFocus ( FEditorViewportClient* InViewportClient,
FViewport* Viewport
)

 Notifies all active modes that a viewport has received focus
Public function void  
Public function void

RemoveDefaultMode ( const FEditorModeID DefaultModeID
)

 Removes a default mode
Public function void

Render ( const FSceneView* InView,
FViewport* Viewport,
FPrimitiveDrawInterface* PDI
)

 Renders all active modes
Public function void

RestoreSelection ( FName SelectionStoreKey
)

 Restores the selection to the state that was stored using the given key.
Public function void Saves the current state to the INI file
Public function void Save Widget Settings to Ini file
Public function Const bool Whether or not the current selection has a scene component selected
Public function void Notifies all active modes to empty their selections
Public function void

SetCoordSystem ( ECoordSystem NewCoordSystem
)

 Sets the current CoordSystem
Public function void Sets the current widget axis
Public function void

SetDefaultMode ( const FEditorModeID DefaultModeID
)

 Set the default editor mode for these tools
Public function void

SetHideViewportUI ( bool bInHideViewportUI
)

 Sets the hide viewport UI state
Public function void

SetPivotLocation ( const FVector& Location,
const bool bIncGridBase
)

 Sets the pivot locations
Public function void

SetShowWidget ( bool InShowWidget
)

  
Public function void Sets the host for toolkits created via modes from this mode manager (can only be called once)
Public function void Changes the current widget mode.
Public function void Allows you to temporarily override the widget mode.
Public function void

SetWidgetScale ( float InScale
)

 Set Scale On The Widget
Public function Const bool True if brush vertices should be drawn
Public function Const bool True if the passed in brush actor should be drawn in wireframe
Public function Const bool

SnapRotatorToGridOverride ( FRotator& InRotation
)

  
Public function bool

StartTracking ( FEditorViewportClient* InViewportClient,
FViewport* InViewport
)

 Mouse tracking interface. Passes tracking messages to all active modes
Public function void

StoreSelection ( FName SelectionStoreKey,
bool bClearSelection
)

 Stores the current selection under the given key, and clears the current selection state if requested.
Protected function Const bool

TestAllModes ( TFunctionRef< bool(UEdMode*)> InCalllback,
bool bExpected
)

  
Public function void

Tick ( FEditorViewportClient* ViewportClient,
float DeltaTime
)

 Ticks all active modes
Public function void  
Public function Const bool True if any active mode uses a transform widget
Public function Const bool True if any active mode uses the passed in transform widget

Overridden from FGCObject

  Type Name Description
Public function Virtual void Pure virtual that must be overloaded by the inheriting class.
Public function Virtual Const FString Overload this method to report a name for your referencer

Overridden from FEditorUndoClient

  Type Name Description
Public function Virtual void

PostRedo ( bool bSuccess
)

 Signal that client should run any PostRedo code
Public function Virtual void

PostUndo ( bool bSuccess
)

 Begin FEditorUndoClient.

Classes

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

Deprecated Functions

  Type Name Description
Public function void

DeactivateOtherVisibleModes ( FEditorModeID InMode
)

 This function is redundant, and is handled as part of a call to ActivateMode.
Public function Const bool Individual toolkit hosts, such as the level editor, should handle determining if they show a mode toolbox for hosted toolkits.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page