WidgetLayoutLibrary.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Kismet/BlueprintFunctionLibrary.h"
#include "Layout/Geometry.h"
#include "WidgetLayoutLibrary.generated.h"
 
class APlayerController;
class UGameViewportClient;
class UCanvasPanelSlot;
class UGridSlot;
class UHorizontalBoxSlot;
class UOverlaySlot;
class UUniformGridSlot;
class UVerticalBoxSlot;
class UScrollBoxSlot;
class USafeZoneSlot;
class UScaleBoxSlot;
class USizeBoxSlot;
class UStackBoxSlot;
class UWrapBoxSlot;
class UWidgetSwitcherSlot;
class UWidget;
 
UCLASS(MinimalAPI)
class UWidgetLayoutLibrary : public UBlueprintFunctionLibrary
{
    GENERATED_UCLASS_BODY()
 
public:
 
    UFUNCTION(BlueprintPure, BlueprintCosmetic, Category="Viewport")
    static UMG_API bool ProjectWorldLocationToWidgetPosition(const APlayerController* PlayerController, FVector WorldLocation, FVector2D& ScreenPosition, bool bPlayerViewportRelative);
 
    static UMG_API bool ProjectWorldLocationToWidgetPositionWithDistance(const APlayerController* PlayerController, FVector WorldLocation, FVector& ScreenPosition, bool bPlayerViewportRelative);
 
    UFUNCTION(BlueprintPure, BlueprintCosmetic, Category="Viewport", meta=( WorldContext="WorldContextObject" ))
    static UMG_API float GetViewportScale(const UObject* WorldContextObject);
 
    static UMG_API float GetViewportScale(const UGameViewportClient* ViewportClient);
 
    UFUNCTION(BlueprintPure, BlueprintCosmetic, Category="Viewport", meta=( WorldContext="WorldContextObject", Keywords = "screen size"))
    static UMG_API FVector2D GetViewportSize(const UObject* WorldContextObject);
 
    UFUNCTION(BlueprintCallable, Category="Viewport", meta=( WorldContext="WorldContextObject" ))
    static UMG_API FGeometry GetViewportWidgetGeometry(const UObject* WorldContextObject);
 
    UFUNCTION(BlueprintCallable, Category="Viewport")
    static UMG_API FGeometry GetPlayerScreenWidgetGeometry(APlayerController* PlayerController);
 
    UFUNCTION(BlueprintCallable, Category="Viewport")
    static UMG_API FVector2D GetMousePositionOnPlatform();
 
    UFUNCTION(BlueprintCallable, Category="Viewport", meta=( WorldContext="WorldContextObject" ))
    static UMG_API FVector2D GetMousePositionOnViewport(const UObject* WorldContextObject);
 
    //UE_DEPRECATED(4.17, "Use GetMousePositionOnViewport() instead.  Optionally and for more options, you can use GetViewportWidgetGeometry and GetPlayerScreenWidgetGeometry are newly introduced to give you the geometry of the viewport and the player screen for widgets to help convert between spaces.")
    UFUNCTION(BlueprintPure, BlueprintCosmetic, Category="Viewport")
    static UMG_API bool GetMousePositionScaledByDPI(const APlayerController* Player, float& LocationX, float& LocationY);
    static UMG_API bool GetMousePositionScaledByDPI(const APlayerController* Player, double& LocationX, double& LocationY); // LWC_TODO: Temp stand in for native calls with FVector2D components.
 
    UFUNCTION(BlueprintPure, Category = "Slot")
    static UMG_API class UBorderSlot* SlotAsBorderSlot(UWidget* Widget);
 
    UFUNCTION(BlueprintPure, Category="Slot")
    static UMG_API UCanvasPanelSlot* SlotAsCanvasSlot(UWidget* Widget);
 
    UFUNCTION(BlueprintPure, Category="Slot")
    static UMG_API UGridSlot* SlotAsGridSlot(UWidget* Widget);
 
    UFUNCTION(BlueprintPure, Category="Slot")
    static UMG_API UHorizontalBoxSlot* SlotAsHorizontalBoxSlot(UWidget* Widget);
 
    UFUNCTION(BlueprintPure, Category="Slot")
    static UMG_API UOverlaySlot* SlotAsOverlaySlot(UWidget* Widget);
 
    UFUNCTION(BlueprintPure, Category="Slot")
    static UMG_API UUniformGridSlot* SlotAsUniformGridSlot(UWidget* Widget);
 
    UFUNCTION(BlueprintPure, Category = "Slot")
    static UMG_API UVerticalBoxSlot* SlotAsVerticalBoxSlot(UWidget* Widget);
 
 
    UFUNCTION(BlueprintPure, Category = "Slot")
    static UMG_API UScrollBoxSlot* SlotAsScrollBoxSlot(UWidget* Widget);
 
    UFUNCTION(BlueprintPure, Category = "Slot")
    static UMG_API USafeZoneSlot* SlotAsSafeBoxSlot(UWidget* Widget);
 
    UFUNCTION(BlueprintPure, Category = "Slot")
    static UMG_API UScaleBoxSlot* SlotAsScaleBoxSlot(UWidget* Widget);
 
    UFUNCTION(BlueprintPure, Category = "Slot")
    static UMG_API USizeBoxSlot* SlotAsSizeBoxSlot(UWidget* Widget);
 
    UFUNCTION(BlueprintPure, Category = "Slot")
    static UMG_API UStackBoxSlot* SlotAsStackBoxSlot(UWidget* Widget);
 
    UFUNCTION(BlueprintPure, Category = "Slot")
    static UMG_API UWrapBoxSlot* SlotAsWrapBoxSlot(UWidget* Widget);
 
    UFUNCTION(BlueprintPure, Category = "Slot")
    static UMG_API UWidgetSwitcherSlot* SlotAsWidgetSwitcherSlot(UWidget* Widget);
 
    UFUNCTION(BlueprintCallable, BlueprintCosmetic, Category="Viewport", meta=( WorldContext="WorldContextObject" ))
    static UMG_API void RemoveAllWidgets(const UObject* WorldContextObject);
};