1. Epic GamesDeveloper
  3. UWidgetLayoutLibrary

UWidgetLayoutLibrary

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Blueprint

Inheritance Hierarchy

  • UBlueprintFunctionLibrary
  • UWidgetLayoutLibrary

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Blueprint/WidgetLayoutLibrary.h
Include #include "Blueprint/WidgetLayoutLibrary.h"

Syntax

UCLASS (MinimalAPI)  
class UWidgetLayoutLibrary : public UBlueprintFunctionLibrary

Constructors

  Type Name Description
Public function  

UWidgetLayoutLibrary ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category FVector2D Gets the platform's mouse cursor position. This is the 'absolute' desktop location of the mouse.
Public function Static UFunction BlueprintCallable, Category, Meta FVector2D

GetMousePositionOnViewport ( UObject* WorldContextObject
)

 Gets the platform's mouse cursor position in the local space of the viewport widget.
Public function Static UFunction BlueprintPure, Category blueprintcosmetic bool

GetMousePositionScaledByDPI ( APlayerController* Player,
double& LocationX,
double& LocationY
)

  
Public function Static UFunction BlueprintPure, Category blueprintcosmetic bool

GetMousePositionScaledByDPI ( APlayerController* Player,
float& LocationX,
float& LocationY
)

 Gets the mouse position of the player controller, scaled by the DPI.
Public function Static UFunction BlueprintCallable, Category FGeometry

GetPlayerScreenWidgetGeometry ( APlayerController* PlayerController
)

 Gets the geometry of the widget holding all widgets added to the "Player Screen".
Public function Static UFunction BlueprintPure, Category, Meta blueprintcosmetic float

GetViewportScale ( const UObject* WorldContextObject
)

 Gets the current DPI Scale being applied to the viewport and all the Widgets.
Public function Static float

GetViewportScale ( const UGameViewportClient* ViewportClient
)

 Gets the current DPI Scale being applied to the viewport and all the Widgets.
Public function Static UFunction BlueprintPure, Category, Meta blueprintcosmetic FVector2D

GetViewportSize ( UObject* WorldContextObject
)

 Gets the size of the game viewport.
Public function Static UFunction BlueprintCallable, Category, Meta FGeometry

GetViewportWidgetGeometry ( UObject* WorldContextObject
)

 Gets the geometry of the widget holding all widgets added to the "Viewport".
Public function Static UFunction BlueprintPure, Category blueprintcosmetic bool

ProjectWorldLocationToWidgetPosition ( 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.
Public function Static bool

ProjectWorldLocationToWidgetPositionWithDistance ( 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.
Public function Static UFunction BlueprintCallable, Category, Meta blueprintcosmetic void

RemoveAllWidgets ( UObject* WorldContextObject
)

 Removes all widgets from the viewport.
Public function Static UFunction BlueprintPure, Category UBorderSlot * Gets the slot object on the child widget as a Border Slot, allowing you to manipulate layout information.
Public function Static UFunction BlueprintPure, Category UCanvasPanelSlot * Gets the slot object on the child widget as a Canvas Slot, allowing you to manipulate layout information.
Public function Static UFunction BlueprintPure, Category UGridSlot *

SlotAsGridSlot ( UWidget* Widget
)

 Gets the slot object on the child widget as a Grid Slot, allowing you to manipulate layout information.
Public function Static UFunction BlueprintPure, Category UHorizontalBoxSlot * Gets the slot object on the child widget as a Horizontal Box Slot, allowing you to manipulate its information.
Public function Static UFunction BlueprintPure, Category UOverlaySlot * Gets the slot object on the child widget as a Overlay Slot, allowing you to manipulate layout information.
Public function Static UFunction BlueprintPure, Category USafeZoneSlot * Gets the slot object on the child widget as a Safe Box Slot, allowing you to manipulate its information.
Public function Static UFunction BlueprintPure, Category UScaleBoxSlot * Gets the slot object on the child widget as a Scale Box Slot, allowing you to manipulate its information.
Public function Static UFunction BlueprintPure, Category UScrollBoxSlot * Gets the slot object on the child widget as a Scroll Box Slot, allowing you to manipulate its information.
Public function Static UFunction BlueprintPure, Category USizeBoxSlot * Gets the slot object on the child widget as a Size Box Slot, allowing you to manipulate its information.
Public function Static UFunction BlueprintPure, Category UUniformGridSlot * Gets the slot object on the child widget as a Uniform Grid Slot, allowing you to manipulate layout information.
Public function Static UFunction BlueprintPure, Category UVerticalBoxSlot * Gets the slot object on the child widget as a Vertical Box Slot, allowing you to manipulate its information.
Public function Static UFunction BlueprintPure, Category UWidgetSwitcherSlot * Gets the slot object on the child widget as a Widget Switcher Slot, allowing you to manipulate its information.
Public function Static UFunction BlueprintPure, Category UWrapBoxSlot * Gets the slot object on the child widget as a Wrap Box Slot, allowing you to manipulate its information.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page