1. Epic GamesDeveloper
  3. FEdMode

FEdMode

Base class for all editor modes.

API > API/Editor > API/Editor/UnrealEd

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 ,  
    public FLegacyEdModeWidgetHelper

Remarks

Base class for all editor modes.

Variables

  Type Name Description
Protected variable FModeTool * CurrentTool The tool that is currently active within this mode.
Protected variable FEditorModeInfo Info Information pertaining to this mode.
Protected variable TSharedPtr< class FModeToolkit > Toolkit Editor Mode Toolkit that is associated with this toolkit mode
Protected variable TArray< FModeTool * > Tools Optional array of tools for this mode.

Constructors

  Type Name Description
Public function  

FEdMode ()

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

ActorsDuplicatedNotify ( TArray< AActor* >& PreDuplicateSelection,
TArray< AActor* >& PostDuplicateSelection,
bool bOffsetLocations
)

  
Public function Virtual bool

BeginTransform ( const FGizmoState& InState
)

  
Public function Virtual bool

BoxSelect ( FBox& InBox,
bool InSelect
)

 Lets each mode/tool handle box selection in its own way.
Public function Virtual void

BuildModeToolbar ( FToolBarBuilder& ToolbarBuilder
)

 Called when the editor mode should rebuild its toolbar
Public function Virtual Const bool Check to see if this EdMode wants to disallow AutoSave
Public function Static bool Returns true if this property can support creating a widget in the editor
Public function Static bool

CanCreateWidgetForStructure ( const UStruct* InPropStruct
)

 Returns true if this structure can support creating a widget in the editor
Public function Virtual bool

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

 Called when the mouse is moved while a window input capture is in effect
Public function Virtual Const bool

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

 Allows an editor mode to override the bounding box used to focus the viewport on a selection
Public function Virtual void  
Public function Virtual Const bool If the Edmode is handling its own mouse deltas, it can disable the MouseDeltaTacker
Public function Virtual bool

EndTracking ( FEditorViewportClient* InViewportClient,
FViewport* InViewport
)

  
Public function Virtual bool

EndTransform ( const FGizmoState& InState
)

  
Public function Virtual void

Enter ()

  
Public function Virtual void

Exit ()

  
Public function FModeTool *

FindTool ( EModeTools InID
)

  
Public function Virtual bool

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

 Lets each mode/tool handle frustum selection in its own way.
Public function Virtual EEditAction::Type  
Public function Virtual EEditAction::Type  
Public function Virtual EEditAction::Type  
Public function Virtual EEditAction::Type Added for handling EDIT Command...
Public function Virtual EEditAction::Type  
Public function Const const FModeTool *  
Public function FModeTool * Returns the current tool.
Public function Virtual Const bool

GetCursor ( EMouseCursor::Type& OutCursor
)

 Get a cursor to override the default with, if any.
Public function Const FEditorModeID

GetID ()

 Returns the editor mode identifier.
Public function Const const FEditorModeInfo & Returns the editor mode information.
Public function Const FEditorModeTools * Returns the owning mode manager for this mode
Public function Virtual Const bool

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

 Get override cursor visibility settings
Public function Virtual Const bool

GetPivotForOrbit ( FVector& OutPivot
)

 Lets each mode/tool specify a pivot point around which the camera should orbit
Public function TSharedPtr< FModeToolkit > Gets the toolkit created by this mode
Public function Const const TArray< FModeTool * > &  
Public function Virtual UTexture2D *  
Public function Const UWorld * Returns the world this toolkit is editing
Public function Virtual bool Called when attempting to duplicate the selected actors by alt+dragging, return true to prevent normal duplication.
Public function Virtual void  
Public function Virtual bool

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

  
Public function Virtual bool

InputKey ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
FKey Key,
EInputEvent Event
)

  
Public function Virtual Const bool  
Public function Virtual Const bool

IsSelectionAllowed ( AActor* InActor,
bool bInSelection
)

 Check to see if an actor can be selected in this mode - no side effects
Public function Virtual bool If Rotation Snap should be enabled for this mode
Public function Virtual bool

LostFocus ( FEditorViewportClient* ViewportClient,
FViewport* Viewport
)

  
Public function Virtual void  
Public function Virtual bool

MouseEnter ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
int32 x,
int32 y
)

  
Public function Virtual bool

MouseLeave ( FEditorViewportClient* ViewportClient,
FViewport* Viewport
)

  
Public function Virtual bool

MouseMove ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
int32 x,
int32 y
)

  
Public function Virtual bool Called after mouse movement is converted to drag/rot
Public function Virtual void  
Public function Virtual bool Called before mouse movement is converted to drag/rot
Public function Virtual bool

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

 Process all captured mouse moves that occurred during the current frame
Public function Virtual bool  
Public function Virtual bool  
Public function Virtual bool  
Public function Virtual bool  
Public function Virtual bool  
Public function Virtual bool

ReceivedFocus ( FEditorViewportClient* ViewportClient,
FViewport* Viewport
)

  
Public function void Request that this mode be deleted at the next convenient opportunity (FEditorModeTools::Tick)
Public function Virtual bool

Select ( AActor* InActor,
bool bInSelected
)

 Handling SelectActor
Public function Virtual void  
Public function Virtual void  
Public function void

SetCurrentTool ( FModeTool* InModeTool
)

  
Public function void  
Public function Static bool See if we should create a widget for the supplied property when selecting an actor instance
Public function Virtual Const bool

ShouldDrawBrushWireframe ( AActor* InActor
)

  
Public function Virtual bool If this mode should override the snap rotation
Public function Virtual bool

StartTracking ( FEditorViewportClient* InViewportClient,
FViewport* InViewport
)

  
Public function Virtual void

Tick ( FEditorViewportClient* ViewportClient,
float DeltaTime
)

  
Public function Virtual void  
Public function Virtual Const bool True if this mode uses a toolkit mode (eventually they all should)

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 FLegacyEdModeWidgetHelper

  Type Name Description
Public function Virtual void

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

 Overlays the editor hud (brushes, drag tools, static mesh vertices, etc*.
Public function Virtual bool

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

  
Public function Virtual bool

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

  
Public function Virtual void

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

 Draws translucent polygons on brushes and volumes.
Public function Virtual Const bool  
Public function Virtual Const bool Lets each tool determine if it wants to use the editor widget or not.
Public function Virtual Const bool  

Typedefs

Name Description
FPropertyWidgetInfo  

Constants

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page