1. Epic GamesDeveloper
  3. UWidgetLayoutLibrary

UWidgetLayoutLibrary

API > API/Runtime > API/Runtime/UMG

   
Name UWidgetLayoutLibrary
Type class
Header File /Engine/Source/Runtime/UMG/Public/Blueprint/WidgetLayoutLibrary.h
Include Path #include "Blueprint/WidgetLayoutLibrary.h"

Syntax

UCLASS (MinimalAPI)  
class UWidgetLayoutLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UWidgetLayoutLibrary ( const FObjectInitializer& ObjectInitializer
)

   Blueprint/WidgetLayoutLibrary.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static FVector2D GetMousePositionOnPlatform()

 Gets the platform's mouse cursor position. This is the 'absolute' desktop location of the mouse. Blueprint/WidgetLayoutLibrary.h
  • BlueprintCallable
  • Category="Viewport"

static FVector2D GetMousePositionOnViewport ( const UObject* WorldContextObject
)

 Gets the platform's mouse cursor position in the local space of the viewport widget. Blueprint/WidgetLayoutLibrary.h
  • BlueprintCallable
  • Category="Viewport"
  • Meta=(WorldContext="WorldContextObject")

static bool GetMousePositionScaledByDPI ( const APlayerController* Player,
double& LocationX,
double& LocationY
)

   Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • BlueprintCosmetic
  • Category="Viewport"

static bool GetMousePositionScaledByDPI ( const APlayerController* Player,
float& LocationX,
float& LocationY
)

 Gets the mouse position of the player controller, scaled by the DPI. Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • BlueprintCosmetic
  • Category="Viewport"
Gets the geometry of the widget holding all widgets added to the "Player Screen". Blueprint/WidgetLayoutLibrary.h
  • BlueprintCallable
  • Category="Viewport"

static float GetViewportScale ( const UObject* WorldContextObject
)

 Gets the current DPI Scale being applied to the viewport and all the Widgets. Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • BlueprintCosmetic
  • Category="Viewport"
  • Meta=(WorldContext="WorldContextObject")

static float GetViewportScale ( const UGameViewportClient* ViewportClient
)

 Gets the current DPI Scale being applied to the viewport and all the Widgets. Blueprint/WidgetLayoutLibrary.h  

static FVector2D GetViewportSize ( const UObject* WorldContextObject
)

 Gets the size of the game viewport. Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • BlueprintCosmetic
  • Category="Viewport"
  • Meta=(WorldContext="WorldContextObject", Keywords="screen size")

static FGeometry GetViewportWidgetGeometry ( const UObject* WorldContextObject
)

 Gets the geometry of the widget holding all widgets added to the "Viewport". Blueprint/WidgetLayoutLibrary.h
  • BlueprintCallable
  • Category="Viewport"
  • Meta=(WorldContext="WorldContextObject")

static bool ProjectWorldLocationToWidgetPosition ( const APlayerController* PlayerController,
FVector WorldLocation,
FVector2D& ScreenPosition,
bool bPlayerViewportRelative
)

 Gets the projected world to screen position for a player, then converts it into a widget position, which takes into account any quality scaling. Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • BlueprintCosmetic
  • Category="Viewport"

static bool ProjectWorldLocationToWidgetPositionWithDistance ( const APlayerController* PlayerController,
FVector WorldLocation,
FVector& ScreenPosition,
bool bPlayerViewportRelative
)

 Convert a World Space 3D position into a 2D Widget Screen Space position, with distance from the camera the Z component. Blueprint/WidgetLayoutLibrary.h  

static void RemoveAllWidgets ( const UObject* WorldContextObject
)

 Removes all widgets from the viewport. Blueprint/WidgetLayoutLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Viewport"
  • Meta=(WorldContext="WorldContextObject")

static UBorderSlot * SlotAsBorderSlot ( UWidget* Widget
)

 Gets the slot object on the child widget as a Border Slot, allowing you to manipulate layout information. Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • Category="Slot"

static UCanvasPanelSlot * SlotAsCanvasSlot ( UWidget* Widget
)

 Gets the slot object on the child widget as a Canvas Slot, allowing you to manipulate layout information. Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • Category="Slot"

static UGridSlot * SlotAsGridSlot ( UWidget* Widget
)

 Gets the slot object on the child widget as a Grid Slot, allowing you to manipulate layout information. Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • Category="Slot"

static UHorizontalBoxSlot * SlotAsHorizontalBoxSlot ( UWidget* Widget
)

 Gets the slot object on the child widget as a Horizontal Box Slot, allowing you to manipulate its information. Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • Category="Slot"

static UOverlaySlot * SlotAsOverlaySlot ( UWidget* Widget
)

 Gets the slot object on the child widget as a Overlay Slot, allowing you to manipulate layout information. Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • Category="Slot"

static USafeZoneSlot * SlotAsSafeBoxSlot ( UWidget* Widget
)

 Gets the slot object on the child widget as a Safe Box Slot, allowing you to manipulate its information. Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • Category="Slot"

static UScaleBoxSlot * SlotAsScaleBoxSlot ( UWidget* Widget
)

 Gets the slot object on the child widget as a Scale Box Slot, allowing you to manipulate its information. Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • Category="Slot"

static UScrollBoxSlot * SlotAsScrollBoxSlot ( UWidget* Widget
)

 Gets the slot object on the child widget as a Scroll Box Slot, allowing you to manipulate its information. Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • Category="Slot"

static USizeBoxSlot * SlotAsSizeBoxSlot ( UWidget* Widget
)

 Gets the slot object on the child widget as a Size Box Slot, allowing you to manipulate its information. Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • Category="Slot"

static UStackBoxSlot * SlotAsStackBoxSlot ( UWidget* Widget
)

 Gets the slot object on the child widget as a Stack Box Slot, allowing you to manipulate its information. Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • Category="Slot"

static UUniformGridSlot * SlotAsUniformGridSlot ( UWidget* Widget
)

 Gets the slot object on the child widget as a Uniform Grid Slot, allowing you to manipulate layout information. Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • Category="Slot"

static UVerticalBoxSlot * SlotAsVerticalBoxSlot ( UWidget* Widget
)

 Gets the slot object on the child widget as a Vertical Box Slot, allowing you to manipulate its information. Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • Category="Slot"

static UWidgetSwitcherSlot * SlotAsWidgetSwitcherSlot ( UWidget* Widget
)

 Gets the slot object on the child widget as a Widget Switcher Slot, allowing you to manipulate its information. Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • Category="Slot"

static UWrapBoxSlot * SlotAsWrapBoxSlot ( UWidget* Widget
)

 Gets the slot object on the child widget as a Wrap Box Slot, allowing you to manipulate its information. Blueprint/WidgetLayoutLibrary.h
  • BlueprintPure
  • Category="Slot"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page