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 > API/Editor/UMGEditor/Designer

Inheritance Hierarchy

References

   
Module UMGEditor
Header /Engine/Source/Editor/UMGEditor/Public/Designer/SDesignerView.h
Include #include "Designer/SDesignerView.h"

Syntax

class SDesignerView :  
    public SDesignSurface,  
    public FGCObject,  
    public IUMGDesigner

Remarks

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

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void  
Public function void

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

  
Public function TSharedRef< SWidget >  
Protected function Const void

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

  
Public function void  
Public function EActiveTimerReturnType

EnsureTick ( double InCurrentTime,
float InDeltaTime
)

  
Public function Const FOptionalSize The height of the preview screen for the UI
Public function Const FOptionalSize The width of the preview screen for the UI
Public function Const float Gets the DPI scale that would be applied given the current preview width and height
Public function Const FOptionalSize The height of the preview widget for the UI
Public function Const FOptionalSize The width of the preview widget for the UI
Public function Const const UWidgetEditingProjectSettings *  
Public function Virtual Const FVector2D  
Public function void  
Public function void

SetPreviewAreaSize ( int32 Width,
int32 Height
)

 Set the size of the preview screen for the UI
Public function void  

Overridden from SDesignSurface

  Type Name Description
Protected function Virtual Const FSlateRect  
Protected function Virtual Const int32  
Protected function Virtual Const float  
Protected function Virtual Const int32  
Protected function Virtual Const void

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

  

Overridden from SWidget

  Type Name Description
Public function Virtual FReply

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

 Called when Slate detects that a widget started to be dragged.
Public function Virtual void

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

 DRAG AND DROP (DragDrop) Called during drag and drop when the drag enters a widget.
Public function Virtual void

OnDragLeave ( const FDragDropEvent& DragDropEvent
)

 Called during drag and drop when the drag leaves a widget.
Public function Virtual FReply

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

 Called during drag and drop when the the mouse is being dragged over a widget.
Public function Virtual FReply

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

 Called when the user is dropping something onto a widget; terminates drag and drop.
Public function Virtual FReply

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

 Called after a key is pressed when this widget has focus (this event bubbles if not handled)
Public function Virtual FReply

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

 Called after a key is released when this widget has focus
Public function Virtual FReply

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

 MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it.
Public function Virtual FReply

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

 The system calls this method to notify the widget that a mouse button was release within it.
Public function Virtual void

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

 The system will use this event to notify a widget that the cursor has entered it.
Public function Virtual void

OnMouseLeave ( const FPointerEvent& MouseEvent
)

 The system will use this event to notify a widget that the cursor has left it.
Public function Virtual FReply

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

 The system calls this method to notify the widget that a mouse moved within it.
Public function Virtual void

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

 Ticks this widget with Geometry.

Overridden from FGCObject

  Type Name Description
Public function Virtual void Pure virtual that must be overloaded by the inheriting class.
Public function Virtual Const FString Overload this method to report a name for your referencer

Overridden from IUMGDesigner

  Type Name Description
Public function Virtual Const FGeometry  
Public function Virtual Const float  
Public function Virtual Const FWidgetReference  
Public function Virtual Const const TSet< FWidgetReference > &  
Public function Virtual Const ETransformMode::Type  
Public function Virtual Const bool

GetWidgetGeometry ( const UWidget* PreviewWidget,
FGeometry& Geometry
)

 Gets the previous frames widget geometry.
Public function Virtual Const bool

GetWidgetGeometry ( const FWidgetReference& Widget,
FGeometry& Geometry
)

 Gets the previous frames widget geometry.
Public function Virtual Const bool

GetWidgetParentGeometry ( const FWidgetReference& Widget,
FGeometry& Geometry
)

 Gets the previous frames widget geometry of the parent of the provided widget.
Public function Virtual Const FGeometry

MakeGeometryWindowLocal ( const FGeometry& WidgetGeometry
)

 Takes geometry and adds the inverse of the window transform to get the geometry in the space of the window.
Public function Virtual void

MarkDesignModifed ( bool bRequiresRecompile
)

 Marks the designer content as being modified.
Public function Virtual void Removes the last message from the message stack.
Public function Virtual void

PushDesignerMessage ( const FText& Message
)

 Push a new designer message to show at the bottom of the screen.

Classes

  Type Name Description
Public struct FArguments    

Constants

Name Description
ConfigSectionName  
DefaultPreviewOverrideName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page