UBaseLegacyWidgetEdMode | Unreal Engine 5.7 Documentation

API > API/Editor > API/Editor/UnrealEd

This class is to aid transitioning from native FEdModes to UEdModes, in the case that the FEdMode used property widgets and/or transform widgets To use this class:

Subclass FLegacyEdModeWidgetHelper, and override the methods needed for your native FEdMode implementation

Transition your native FEdMode to a UObject, by inheriting from this class

Override CreateWidgetHelper function to return a SharedRef to the class you created in step 1.


Name	UBaseLegacyWidgetEdMode
Type	class
Header File	/Engine/Source/Editor/UnrealEd/Public/Tools/LegacyEdModeWidgetHelpers.h
Include Path	#include "Tools/LegacyEdModeWidgetHelpers.h"

Syntax

UCLASS (Abstract, MinimalAPI)  
class UBaseLegacyWidgetEdMode :  
    public UEdMode ,  
    public ILegacyEdModeWidgetInterface ,  
    public ILegacyEdModeViewportInterface

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UEdMode → UBaseLegacyWidgetEdMode

Implements Interfaces

Derived Classes

UBaseLegacyWidgetEdMode derived class hierarchy

Functions

Public

Overridden from UEdMode

Name	Remarks	Include Path	Unreal Specifiers
virtual void ActorSelectionChangeNotify()		Tools/LegacyEdModeWidgetHelpers.h
virtual void Initialize ()	If you need to do any initialization in your mode, be sure to still call through to this function.	Tools/LegacyEdModeWidgetHelpers.h

Overridden from ILegacyEdModeWidgetInterface

Name	Remarks	Include Path
virtual bool AllowWidgetMove()	ILegacyEdModeWidgetInterface overrides are just a pass through to the FLegacyEdModeWidgetHelper.	Tools/LegacyEdModeWidgetHelpers.h
virtual bool CanCycleWidgetMode()	Check to see if the current widget mode can be cycled	Tools/LegacyEdModeWidgetHelpers.h
virtual void DrawHUD ( FEditorViewportClient* ViewportClient, FViewport* Viewport, const FSceneView* View, FCanvas* Canvas )		Tools/LegacyEdModeWidgetHelpers.h
virtual EAxisList::Type GetCurrentWidgetAxis()		Tools/LegacyEdModeWidgetHelpers.h
virtual bool GetCustomDrawingCoordinateSystem ( FMatrix& InMatrix, void* InData )		Tools/LegacyEdModeWidgetHelpers.h
virtual bool GetCustomInputCoordinateSystem ( FMatrix& InMatrix, void* InData )		Tools/LegacyEdModeWidgetHelpers.h
virtual EAxisList::Type GetWidgetAxisToDraw ( UE::Widget::EWidgetMode InWidgetMode ) const	Allows each mode to customize the axis pieces of the widget they want drawn.	Tools/LegacyEdModeWidgetHelpers.h
virtual FVector GetWidgetLocation()	Allows each mode/tool to determine a good location for the widget to be drawn at.	Tools/LegacyEdModeWidgetHelpers.h
virtual FVector GetWidgetNormalFromCurrentAxis ( void* InData )		Tools/LegacyEdModeWidgetHelpers.h
virtual void Render ( const FSceneView* View, FViewport* Viewport, FPrimitiveDrawInterface* PDI )		Tools/LegacyEdModeWidgetHelpers.h
virtual void SetCurrentWidgetAxis ( EAxisList::Type InAxis )		Tools/LegacyEdModeWidgetHelpers.h
virtual bool ShouldDrawWidget()	Lets the mode determine if it wants to draw the widget or not.	Tools/LegacyEdModeWidgetHelpers.h
virtual bool ShowModeWidgets()		Tools/LegacyEdModeWidgetHelpers.h
virtual bool UsesPropertyWidgets()	Lets each mode selectively enable widgets for editing properties tagged with 'Show 3D Widget' metadata.	Tools/LegacyEdModeWidgetHelpers.h
virtual bool UsesTransformWidget ()	Lets each tool determine if it wants to use the editor widget or not.	Tools/LegacyEdModeWidgetHelpers.h
virtual bool UsesTransformWidget ( UE::Widget::EWidgetMode CheckMode ) const	Lets each mode selectively exclude certain widget types.	Tools/LegacyEdModeWidgetHelpers.h

Overridden from ILegacyEdModeViewportInterface

Name	Remarks	Include Path	Unreal Specifiers
virtual bool AllowsViewportDragTool()		Tools/LegacyEdModeWidgetHelpers.h
virtual bool HandleClick ( FEditorViewportClient* InViewportClient, HHitProxy* HitProxy, const FViewportClick& Click )		Tools/LegacyEdModeWidgetHelpers.h
virtual bool InputDelta ( FEditorViewportClient* InViewportClient, FViewport* InViewport, FVector& InDrag, FRotator& InRot, FVector& InScale )		Tools/LegacyEdModeWidgetHelpers.h

Protected

Name	Remarks	Include Path	Unreal Specifiers
virtual TSharedRef< FLegacyEdModeWidgetHelper > CreateWidgetHelper()		Tools/LegacyEdModeWidgetHelpers.h

Navigation