1. Epic GamesDeveloper
  3. SDesignerView

SDesignerView

The designer for widgets. Allows for laying out widgets in a drag and drop environment.

API > API/Editor > API/Editor/UMGEditor

The designer for widgets. Allows for laying out widgets in a drag and drop environment.

   
Name SDesignerView
Type class
Header File /Engine/Source/Editor/UMGEditor/Public/Designer/SDesignerView.h
Include Path #include "Designer/SDesignerView.h"

Syntax

class SDesignerView :  
    public SDesignSurface ,  
    public FGCObject ,  
    public IUMGDesigner

Inheritance Hierarchy

Implements Interfaces

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~SDesignerView()

   Designer/SDesignerView.h  

Structs

Name Remarks
FArguments  
FDropPreview  
FWidgetHitResult  

Constants

Name Type Remarks Include Path
ConfigSectionName const FString   Designer/SDesignerView.h
DefaultPreviewOverrideName const FString   Designer/SDesignerView.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
BackgroundImage FSlateBrush The slate brush we use to hold the background image shown in the designer. Designer/SDesignerView.h  
bCanPreviewSwapAspectRatio bool Whether or not the resolution can flip between portrait and landscape. Designer/SDesignerView.h  
bCommonResolutionSelected bool Whether we have selected one of the common resolutions for the preview. Designer/SDesignerView.h  
BlueprintEditor TWeakPtr< FWidgetBlueprintEditor > A reference to the BP Editor that owns this designer Designer/SDesignerView.h  
bMovingExistingWidget bool An existing widget is being moved in its current container, or in to a new container. Designer/SDesignerView.h  
bPreviewIsPortrait bool Whether the preview is currently in portrait mode. Designer/SDesignerView.h  
bSafeZoneFlipped bool   Designer/SDesignerView.h  
bShowResolutionOutlines bool   Designer/SDesignerView.h  
CachedMousePosition FVector2D Cache last mouse position to be used as a paste drop location Designer/SDesignerView.h  
CachedPreviewDesiredSize FVector2D We cache the desired preview desired size to maintain the same size between compiles when it lags a frame behind and no widget is available. Designer/SDesignerView.h  
CachedWidgetGeometry TMap< TSharedRef< SWidget >, FArrangedWidget >   Designer/SDesignerView.h  
CommandList TSharedPtr< FUICommandList > The designer command list Designer/SDesignerView.h  
CustomSafeZoneDimensions TArray< FVector2D >   Designer/SDesignerView.h  
CustomSafeZoneStarts TArray< FVector2D >   Designer/SDesignerView.h  
DesignerControls TSharedPtr< SCanvas >   Designer/SDesignerView.h  
DesignerExtensions TArray< TSharedRef< FDesignerExtension > > Extensions for the designer to allow for custom widgets to be inserted onto the design surface as selection changes. Designer/SDesignerView.h  
DesignerHittestGrid TSharedPtr< FHittestGrid >   Designer/SDesignerView.h  
DesignerMessageStack TArray< FText > The message stack to display the last item to the user in a non-modal fashion. Designer/SDesignerView.h  
DesignerSafeZoneOverride FMargin   Designer/SDesignerView.h  
DesignerWidgetCanvas TSharedPtr< SCanvas >   Designer/SDesignerView.h  
DraggingStartPositionScreenSpace FVector2D The position in screen space where the user began dragging a widget Designer/SDesignerView.h  
DropPreviews TArray< FDropPreview >   Designer/SDesignerView.h  
EffectsLayer TSharedPtr< SPaintSurface >   Designer/SDesignerView.h  
ExtensionWidgetCanvas TSharedPtr< SCanvas >   Designer/SDesignerView.h  
HeightReadFromSettings int32 The original Height of the preview area, read from the settings file. Designer/SDesignerView.h  
HoveredWidgetOutlineFade FCurveSequence Curve to handle the fade-in of the border around the hovered widget Designer/SDesignerView.h  
PendingSelectedWidget FWidgetReference Holds onto a temporary widget that the user may be getting ready to select, or may just be the widget that got hit on the initial mouse down before moving the parent. Designer/SDesignerView.h  
PreviewAreaConstraint TSharedPtr< SBox >   Designer/SDesignerView.h  
PreviewAspectRatio FString Resolution Info. Designer/SDesignerView.h  
PreviewHeight int32 The configured Height of the preview area, simulates screen size. Designer/SDesignerView.h  
PreviewHitTestRoot TSharedPtr< SWidget >   Designer/SDesignerView.h  
PreviewOverrideName FString   Designer/SDesignerView.h  
PreviewSizeConstraint TSharedPtr< SBox >   Designer/SDesignerView.h  
PreviewSlateWidget TWeakPtr< SWidget > The current preview widget's slate widget Designer/SDesignerView.h  
PreviewSurface TSharedPtr< SDPIScaler >   Designer/SDesignerView.h  
PreviewWidget TObjectPtr< UUserWidget > The current preview widget Designer/SDesignerView.h  
PreviewWidth int32 The configured Width of the preview area, simulates screen size. Designer/SDesignerView.h  
ResolutionTextFade FCurveSequence Curve to handle fading of the resolution Designer/SDesignerView.h  
ScaleFactor float   Designer/SDesignerView.h  
ScopedTransaction FScopedTransaction * The transaction used to commit undoable actions from resize, move...etc Designer/SDesignerView.h  
SelectedWidgetContextMenuLocation FVector2D The location in selected widget local space where the context menu was summoned. Designer/SDesignerView.h  
SelectedWidgetPath FWeakWidgetPath   Designer/SDesignerView.h  
SelectedWidgetsCache TSet< FWidgetReference > The currently selected preview widgets in the preview GUI, just a cache used to determine changes between selection changes. Designer/SDesignerView.h  
SideRuler TSharedPtr< SRuler > The ruler bar on the left side of the designer. Designer/SDesignerView.h  
TopRuler TSharedPtr< SRuler > The ruler bar at the top of the designer. Designer/SDesignerView.h  
TransformMode ETransformMode::Type   Designer/SDesignerView.h  
WidthReadFromSettings int32 The original Width of the preview area, read from the settings file. Designer/SDesignerView.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BeginResizingArea()

   Designer/SDesignerView.h  

void Construct ( const FArguments& InArgs,
TSharedPtr< class FWidgetBlueprintEditor > InBlueprintEditor
)

   Designer/SDesignerView.h  

TSharedRef< SWidget > CreateOverlayUI()

   Designer/SDesignerView.h  

void EndResizingArea()

   Designer/SDesignerView.h  

EActiveTimerReturnType EnsureTick ( double InCurrentTime,
float InDeltaTime
)

   Designer/SDesignerView.h  

FOptionalSize GetPreviewAreaHeight()

 The height of the preview screen for the UI Designer/SDesignerView.h  

FOptionalSize GetPreviewAreaWidth()

 The width of the preview screen for the UI Designer/SDesignerView.h  

float GetPreviewDPIScale()

 Gets the DPI scale that would be applied given the current preview width and height Designer/SDesignerView.h  

FOptionalSize GetPreviewSizeHeight()

 The height of the preview widget for the UI Designer/SDesignerView.h  

FOptionalSize GetPreviewSizeWidth()

 The width of the preview widget for the UI Designer/SDesignerView.h  

const UWidgetEditingProjectSettings * GetRelevantSettings()

   Designer/SDesignerView.h  

virtual FVector2D GetWidgetOriginAbsolute()

   Designer/SDesignerView.h  

void Register ( TSharedRef< FDesignerExtension > Extension
)

   Designer/SDesignerView.h  

void SetPreviewAreaSize ( int32 Width,
int32 Height
)

 Set the size of the preview screen for the UI Designer/SDesignerView.h  

void Unregister ( TSharedRef< FDesignerExtension > Extension
)

   Designer/SDesignerView.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual FReply OnDragDetected ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Designer/SDesignerView.h  

virtual void OnDragEnter ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

   Designer/SDesignerView.h  

virtual void OnDragLeave ( const FDragDropEvent& DragDropEvent
)

   Designer/SDesignerView.h  

virtual FReply OnDragOver ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

   Designer/SDesignerView.h  

virtual FReply OnDrop ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

   Designer/SDesignerView.h  

virtual FReply OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   Designer/SDesignerView.h  

virtual FReply OnKeyUp ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   Designer/SDesignerView.h  

virtual FReply OnMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Designer/SDesignerView.h  

virtual FReply OnMouseButtonUp ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Designer/SDesignerView.h  

virtual void OnMouseEnter ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Designer/SDesignerView.h  

virtual void OnMouseLeave ( const FPointerEvent& MouseEvent
)

   Designer/SDesignerView.h  

virtual FReply OnMouseMove ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

   Designer/SDesignerView.h  

virtual void Tick ( const FGeometry& AllottedGeometry,
const double InCurrentTime,
const float InDeltaTime
)

   Designer/SDesignerView.h  

Overridden from FGCObject

Name Remarks Include Path Unreal Specifiers

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

   Designer/SDesignerView.h  

virtual FString GetReferencerName()

   Designer/SDesignerView.h  

Overridden from IUMGDesigner

Name Remarks Include Path Unreal Specifiers

virtual FGeometry GetDesignerGeometry()

   Designer/SDesignerView.h  

virtual float GetPreviewScale()

   Designer/SDesignerView.h  

virtual FWidgetReference GetSelectedWidget()

   Designer/SDesignerView.h  

virtual const TSet< FWidgetReference > & GetSelectedWidgets()

   Designer/SDesignerView.h  

virtual ETransformMode::Type GetTransformMode()

   Designer/SDesignerView.h  

virtual bool GetWidgetGeometry ( const FWidgetReference& Widget,
FGeometry& Geometry
) const

 Gets the previous frames widget geometry. Designer/SDesignerView.h  

virtual bool GetWidgetGeometry ( const UWidget* PreviewWidget,
FGeometry& Geometry
) const

 Gets the previous frames widget geometry. Designer/SDesignerView.h  

virtual bool GetWidgetParentGeometry ( const FWidgetReference& Widget,
FGeometry& Geometry
) const

 Gets the previous frames widget geometry of the parent of the provided widget. Designer/SDesignerView.h  

virtual FGeometry MakeGeometryWindowLocal ( const FGeometry& WidgetGeometry
) const

 Takes geometry and adds the inverse of the window transform to get the geometry in the space of the window. Designer/SDesignerView.h  

virtual void MarkDesignModifed ( bool bRequiresRecompile
)

 Marks the designer content as being modified. Designer/SDesignerView.h  

virtual void PopDesignerMessage()

 Removes the last message from the message stack. Designer/SDesignerView.h  

virtual void PushDesignerMessage ( const FText& Message
)

 Push a new designer message to show at the bottom of the screen. Designer/SDesignerView.h  

Protected

Name Remarks Include Path Unreal Specifiers

void DrawResolution ( const FDebugResolution& Resolution,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId
) const

   Designer/SDesignerView.h  

Overridden from SDesignSurface

Name Remarks Include Path Unreal Specifiers

virtual FSlateRect ComputeAreaBounds()

   Designer/SDesignerView.h  

virtual int32 GetGraphRulePeriod()

   Designer/SDesignerView.h  

virtual float GetGridScaleAmount()

   Designer/SDesignerView.h  

virtual int32 GetSnapGridSize()

   Designer/SDesignerView.h  

virtual void OnPaintBackground ( const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId
) const

   Designer/SDesignerView.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page