1. Epic GamesDeveloper
  3. FEdMode

FEdMode

Base class for all editor modes.

API > API/Editor > API/Editor/UnrealEd

Base class for all editor modes.

   
Name FEdMode
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/EdMode.h
Include Path #include "EdMode.h"

Syntax

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

Inheritance Hierarchy

Derived Classes

FEdMode derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FEdMode()

   EdMode.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FEdMode()

   EdMode.h  

Typedefs

Name Type Remarks Include Path
FPropertyWidgetInfo FLegacyEdModeWidgetHelper::FPropertyWidgetInfo   EdMode.h

Constants

Name Type Remarks Include Path
MD_MakeEditWidget const FName @TODO: Find a better home for these? EdMode.h
MD_ValidateWidgetUsing const FName Specifies a function used for validation of the current value of a property. EdMode.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void ActorMoveNotify()

   EdMode.h  

virtual void ActorPropChangeNotify()

   EdMode.h  

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

   EdMode.h  

virtual bool BeginTransform ( const FGizmoState& InState
)

   EdMode.h  

virtual bool BoxSelect ( FBox& InBox,
bool InSelect
)

 Lets each mode/tool handle box selection in its own way. EdMode.h  

virtual void BuildModeToolbar ( FToolBarBuilder& ToolbarBuilder
)

 Called when the editor mode should rebuild its toolbar EdMode.h  

virtual bool CanAutoSave()

 Check to see if this EdMode wants to disallow AutoSave EdMode.h  

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 EdMode.h  

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

 Allows an editor mode to override the bounding box used to focus the viewport on a selection EdMode.h  

virtual void CurrentToolChanged()

   EdMode.h  

virtual bool DisallowMouseDeltaTracking()

 If the Edmode is handling its own mouse deltas, it can disable the MouseDeltaTacker EdMode.h  

virtual bool EndTracking ( FEditorViewportClient* InViewportClient,
FViewport* InViewport
)

   EdMode.h  

virtual bool EndTransform ( const FGizmoState& InState
)

   EdMode.h  

virtual void Enter()

   EdMode.h  

virtual void Exit()

   EdMode.h  

FModeTool * FindTool ( EModeTools InID
)

   EdMode.h  

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

 Lets each mode/tool handle frustum selection in its own way. EdMode.h  

virtual EEditAction::Type GetActionEditCopy()

   EdMode.h  

virtual EEditAction::Type GetActionEditCut()

   EdMode.h  

virtual EEditAction::Type GetActionEditDelete()

   EdMode.h  

virtual EEditAction::Type GetActionEditDuplicate()

 Added for handling EDIT Command... EdMode.h  

virtual EEditAction::Type GetActionEditPaste()

   EdMode.h  
  EdMode.h  
Returns the current tool. EdMode.h  

virtual bool GetCursor ( EMouseCursor::Type& OutCursor
) const

 Get a cursor to override the default with, if any. EdMode.h  

FEditorModeID GetID()

 Returns the editor mode identifier. EdMode.h  

const FEditorModeInfo & GetModeInfo()

 Returns the editor mode information. EdMode.h  

FEditorModeTools * GetModeManager()

 Returns the owning mode manager for this mode EdMode.h  

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

 Get override cursor visibility settings EdMode.h  

virtual bool GetPivotForOrbit ( FVector& OutPivot
) const

 Lets each mode/tool specify a pivot point around which the camera should orbit EdMode.h  

TSharedPtr< FModeToolkit > GetToolkit()

 Gets the toolkit created by this mode EdMode.h  

const TArray< FModeTool * > & GetTools()

   EdMode.h  

virtual UTexture2D * GetVertexTexture()

   EdMode.h  

UWorld * GetWorld()

 Returns the world this toolkit is editing EdMode.h  

virtual bool HandleDragDuplicate()

 Called when attempting to duplicate the selected actors by alt+dragging, return true to prevent normal duplication. EdMode.h  

virtual void Initialize()

   EdMode.h  

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

   EdMode.h  

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

   EdMode.h  

virtual bool IsCompatibleWith ( FEditorModeID OtherModeID
) const

   EdMode.h  

virtual bool IsSelectionAllowed ( AActor* InActor,
bool bInSelection
) const

 Check to see if an actor can be selected in this mode - no side effects EdMode.h  

virtual bool IsSnapRotationEnabled()

 If Rotation Snap should be enabled for this mode EdMode.h  

virtual bool LostFocus ( FEditorViewportClient* ViewportClient,
FViewport* Viewport
)

   EdMode.h  

virtual void MapChangeNotify()

   EdMode.h  

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

   EdMode.h  

virtual bool MouseLeave ( FEditorViewportClient* ViewportClient,
FViewport* Viewport
)

   EdMode.h  

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

   EdMode.h  

virtual bool PostConvertMouseMovement ( FEditorViewportClient* InViewportClient
)

 Called after mouse movement is converted to drag/rot EdMode.h  

virtual void PostUndo()

   EdMode.h  

virtual bool PreConvertMouseMovement ( FEditorViewportClient* InViewportClient
)

 Called before mouse movement is converted to drag/rot EdMode.h  

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

 Process all captured mouse moves that occurred during the current frame EdMode.h  

virtual bool ProcessEditCopy()

   EdMode.h  

virtual bool ProcessEditCut()

   EdMode.h  

virtual bool ProcessEditDelete()

   EdMode.h  

virtual bool ProcessEditDuplicate()

   EdMode.h  

virtual bool ProcessEditPaste()

   EdMode.h  

virtual bool ReceivedFocus ( FEditorViewportClient* ViewportClient,
FViewport* Viewport
)

   EdMode.h  

void RequestDeletion()

 Request that this mode be deleted at the next convenient opportunity (FEditorModeTools::Tick) EdMode.h  

virtual bool Select ( AActor* InActor,
bool bInSelected
)

 Handling SelectActor EdMode.h  

virtual void SelectionChanged()

   EdMode.h  

virtual void SelectNone()

   EdMode.h  

void SetCurrentTool ( FModeTool* InModeTool
)

   EdMode.h  

void SetCurrentTool ( EModeTools InID
)

   EdMode.h  

virtual bool ShouldDrawBrushWireframe ( AActor* InActor
) const

   EdMode.h  

virtual bool SnapRotatorToGridOverride ( FRotator& Rotation
)

 If this mode should override the snap rotation EdMode.h  

virtual bool StartTracking ( FEditorViewportClient* InViewportClient,
FViewport* InViewport
)

   EdMode.h  

virtual void Tick ( FEditorViewportClient* ViewportClient,
float DeltaTime
)

   EdMode.h  

virtual void UpdateInternalData()

   EdMode.h  

virtual bool UsesToolkits()

 True if this mode uses a toolkit mode (eventually they all should) EdMode.h  

Overridden from FGCObject

Name Remarks Include Path Unreal Specifiers

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

   EdMode.h  

virtual FString GetReferencerName()

   EdMode.h  

Overridden from FLegacyEdModeWidgetHelper

Name Remarks Include Path Unreal Specifiers

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

 Overlays the editor hud (brushes, drag tools, static mesh vertices, etc*. EdMode.h  

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

   EdMode.h  

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

   EdMode.h  

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

 Draws translucent polygons on brushes and volumes. EdMode.h  

virtual bool UsesPropertyWidgets()

   EdMode.h  

virtual bool UsesTransformWidget ()

 Lets each tool determine if it wants to use the editor widget or not. EdMode.h  

virtual bool UsesTransformWidget ( UE::Widget::EWidgetMode CheckMode
) const

   EdMode.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool CanCreateWidgetForProperty ( FProperty* InProp
)

 Returns true if this property can support creating a widget in the editor EdMode.h  

static bool CanCreateWidgetForStructure ( const UStruct* InPropStruct
)

 Returns true if this structure can support creating a widget in the editor EdMode.h  

static bool ShouldCreateWidgetForProperty ( FProperty* InProp
)

 See if we should create a widget for the supplied property when selecting an actor instance EdMode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page