1. Epic GamesDeveloper
  3. UBaseLegacyWidgetEdMode

UBaseLegacyWidgetEdMode

This class is to aid transitioning from native FEdModes to UEdModes, in the case that the [FEdMode](API\Editor\UnrealEd\FEdMode) used property widgets and/or transform widgets To use this class:

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

Inheritance Hierarchy

References

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

Syntax

class UBaseLegacyWidgetEdMode :  
    public UEdMode,  
    public ILegacyEdModeWidgetInterface,  
    public ILegacyEdModeViewportInterface

Remarks

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.

Variables

  Type Name Description
Protected variable TSharedPtr< FLegacyEdModeWidgetHelper > WidgetHelper  

Functions

  Type Name Description
Protected function Virtual TSharedRef< FLegacyEdModeWidgetHelper >  

Overridden from UEdMode

  Type Name Description
Public function Virtual void  
Public function Virtual void If you need to do any initialization in your mode, be sure to still call through to this function.

Overridden from ILegacyEdModeWidgetInterface

  Type Name Description
Public function Virtual bool ILegacyEdModeWidgetInterface overrides are just a pass through to the FLegacyEdModeWidgetHelper.
Public function Virtual Const bool Check to see if the current widget mode can be cycled
Public function Virtual void

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

  
Public function Virtual Const EAxisList::Type  
Public function Virtual bool

GetCustomDrawingCoordinateSystem ( FMatrix& InMatrix,
void* InData
)

  
Public function Virtual bool

GetCustomInputCoordinateSystem ( FMatrix& InMatrix,
void* InData
)

  
Public function Virtual Const EAxisList::Type Allows each mode to customize the axis pieces of the widget they want drawn.
Public function Virtual Const FVector Allows each mode/tool to determine a good location for the widget to be drawn at.
Public function Virtual FVector  
Public function Virtual void

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

  
Public function Virtual void  
Public function Virtual Const bool Lets the mode determine if it wants to draw the widget or not.
Public function Virtual Const bool  
Public function Virtual Const bool Lets each mode selectively enable widgets for editing properties tagged with 'Show 3D Widget' metadata.
Public function Virtual Const bool Lets each tool determine if it wants to use the editor widget or not.
Public function Virtual Const bool Lets each mode selectively exclude certain widget types.

Overridden from ILegacyEdModeViewportInterface

  Type Name Description
Public function Virtual Const bool  
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
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page