1. Epic GamesDeveloper
  3. UEdMode

UEdMode

Base class for all editor modes.

API > API/Editor > API/Editor/UnrealEd > API/Editor/UnrealEd/Tools

Inheritance Hierarchy

References

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

Syntax

class UEdMode : public UObject

Remarks

Base class for all editor modes.

Variables

  Type Name Description
Protected variable bool bHaveSavedEditorState  
Protected variable bool bSavedAntiAliasingState  
Protected variable FEditorModeInfo Info Information pertaining to this mode. Should be assigned in the constructor.
Protected variable FEditorModeTools * Owner Pointer back to the mode tools that we are registered with
Protected variable TSoftClassPtr< UObject > SettingsClass  
Protected variable TObjectPtr< UObject > SettingsObject  
Protected variable TSharedPtr< FUICommandList > ToolCommandList Command list lives here so that the key bindings on the commands can be processed in the viewport.
Protected variable TSharedPtr< FModeToolkit > Toolkit Editor Mode Toolkit that is associated with this toolkit mode

Constructors

  Type Name Description
Public function  

UEdMode ()

  

Functions

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

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

  
Public function Virtual void  
Public function Virtual FEdMode * For use by the EditorModeTools class to get the legacy FEdMode type from a legacy FEdMode wrapper You should not need to override this function in your UEdMode implementation.
Protected function Virtual void  
Public function Virtual Const bool Check to see if this UEdMode wants to disallow AutoSave
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
Protected function void  
Protected function Virtual void  
Protected function void  
Public function Virtual void

Enter ()

  
Public function Virtual void

Exit ()

  
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 Virtual Const bool

GetCursor ( EMouseCursor::Type& OutCursor
)

 Get a cursor to override the default with, if any.
Public function Const EToolsContextScope Default Scope for InteractiveToolsContext API functions, eg RegisterTool(), GetToolManager(), GetInteractiveToolsContext().
Protected function Const AActor * Returns the first selected Actor, or NULL if there is no selection.
Public function Const FEditorModeID

GetID ()

 Returns the editor mode identifier.
Public function Const UEditorInteractiveToolsContext *

GetInteractiveToolsContext ( EToolsContextScope ToolScope
)

  
Public function Virtual Const TMap< FName, TArray< TSharedPtr< FUICommandInfo > > >  
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 TWeakPtr< FModeToolkit > Gets the toolkit created by this mode
Public function Const UInteractiveToolManager *

GetToolManager ( EToolsContextScope ToolScope
)

  
Public function Const UWorld * Returns the world this toolkit is editing
Public function Virtual void  
Public function Virtual Const bool

IsCompatibleWith ( FEditorModeID OtherModeID
)

  
Public function Virtual Const bool

IsOperationSupportedForCurrentAsset ( EAssetOperation InOperation
)

 Check to see if this UEdMode wants to disallow operation on current asset
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 Const bool

IsSelectionDisallowed ( AActor* InActor,
bool bInSelection
)

 Check to see if an actor selection is exclusively dissallowed by a mode no side effects
Public function Virtual bool If Rotation Snap should be enabled for this mode
Public function Virtual void  
Public function Virtual void

ModeTick ( float DeltaTime
)

  
Protected function void

OnModeActivated ( const FEditorModeID& InID,
bool bIsActive
)

  
Public function Virtual bool  
Protected function Virtual void  
Protected function Virtual void  
Public function Virtual void  
Public function Virtual bool  
Public function Virtual bool  
Public function Virtual bool  
Public function Virtual bool  
Public function Virtual bool  
Public function Virtual void

RegisterTool ( TSharedPtr< FUICommandInfo > UICommand,
FString ToolIdentifier,
UInteractiveToolBuilder* Builder,
EToolsContextScope ToolScope
)

 Registers and maps the provided UI command to actions that start / stop a given tool.
Public function Virtual bool

Select ( AActor* InActor,
bool bInSelected
)

 Handling SelectActor
Public function Virtual void  
Public function Virtual void  
Public function Virtual Const bool  
Public function Virtual Const bool

ShouldToolStartBeAllowed ( const FString& ToolIdentifier
)

 Subclasses can override this to add additional checks on whether a tool should be allowed to start.
Public function Virtual bool

SnapRotatorToGridOverride ( FRotator& Rotation
)

 If this mode should override the snap rotation
Public function Virtual void  
Public function Virtual Const bool True if this mode uses a toolkit mode (eventually they all should)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page