DreamGUI
类参考

UDreamUILayoutLibrary

UDreamUILayoutLibrary

继承自 UBlueprintFunctionLibrary。

声明于 Public/DreamUILayoutLibrary.h。

视口、鼠标和屏幕——本框架的 UWidgetLayoutLibrary。

这里的一切过去只能从 C++ 访问,除此之外别无他法:视口的大小、它的 DPI 缩放、鼠标在 UI 实际使用的坐标系中的位置,以及世界位置落在屏幕上的何处。想在敌人身上钉一个标记的蓝图,必须绕道 UMG 库——它的答案位于 Slate 的坐标系中,而不是本框架的坐标系,然后祈祷两者一致。

函数

函数类型描述
bool GetMousePositionOnPlatform(FVector2D& OutMousePosition)纯函数鼠标在平台坐标系中的位置——桌面像素,跨所有显示器。
bool GetMousePositionOnViewport(UObject* WorldContextObject, FVector2D& OutMousePosition)纯函数鼠标在视口像素中的位置,左上角为零。
bool GetMousePositionScaledByDPI(APlayerController* InPlayer, FVector2D& OutMousePosition)纯函数鼠标在 DPI 缩放后的视口坐标中的位置——即 UI 布局所在的坐标空间。
FDreamUIWidgetGeometry GetPlayerScreenWidgetGeometry(UObject* WorldContextObject, APlayerController* InPlayer)纯函数某个玩家的整个屏幕的几何信息——UMG 的 GetViewportWidgetGeometry 和 GetPlayerScreenWidgetGeometry,这里合并为一个函数,因为每个本地玩家只有一个屏幕根,其背后没有共享层。
float GetViewportScale(UObject* WorldContextObject)纯函数针对当前视口大小的项目 DPI 缩放——整个 UI 在显示前按其缩放的数值。与 UMG 读取的是同一条曲线,因此项目一旦调好,这里也会遵循。
FVector2D GetViewportSize(UObject* WorldContextObject)纯函数游戏视口的像素大小。没有视口时为零,例如在专用服务器上。
bool ProjectWorldLocationToWidgetPosition(APlayerController* InPlayer, FVector InWorldLocation, FVector2D& OutScreenPosition, bool bPlayerViewportRelative)纯函数世界位置落在屏幕上的位置,以视口像素表示——敌人头顶血条所需的内容。当位置在相机后方或没有视口时返回 false。
bool ProjectWorldLocationToWidgetPositionWithDistance(APlayerController* InPlayer, FVector InWorldLocation, FVector2D& OutScreenPosition, float& OutDistance, bool bPlayerViewportRelative)纯函数同上,外加它有多远。距离用于标记的淡出或排序。
void RemoveAllWidgets(UObject* WorldContextObject)可调用将每个被跟踪的页面从屏幕上移除。即 UMG 的 RemoveAllWidgets。
UDreamPanelSlot* SlotAsPanelSlot(UDreamWidget* InWidget)纯函数控件的面板插槽——UMG 的一整组 SlotAs* 函数,这里合并为一个节点。

与 UMG 对比

UMG 类中每一个面向蓝图的成员,以及它们的去向。adopt:名称相同,含义相同。map:在另一个名称下或另一个类型上。reject:刻意缺失,并附原因。

UMG成员状态此处说明
UWidgetLayoutLibraryProjectWorldLocationToWidgetPositionadoptProjectWorldLocationToWidgetPosition返回 bool 并写出位置,因此相机后方的位置会被如实报告,而不是用一个看似合理的数值来回答。
UWidgetLayoutLibraryProjectWorldLocationToWidgetPositionWithDistanceadoptProjectWorldLocationToWidgetPositionWithDistance距离是单独的 float,而不是 UMG 的 FVector 的 Z 分量;它沿视线方向带符号,因此相机后方的位置不会报告与其前方镜像位置相同的深度。
UWidgetLayoutLibraryGetViewportScaleadoptGetViewportScale读取项目自身的 UUserInterfaceSettings DPI 曲线,与 UMG 读取的是同一条,因此项目一旦调好,两者都会遵循。
UWidgetLayoutLibraryGetViewportSizeadoptGetViewportSize
UWidgetLayoutLibraryGetViewportWidgetGeometrymapGetPlayerScreenWidgetGeometry只有一个函数,因为每个本地玩家只有一个屏幕根,其背后没有共享层——UMG 在 AddToViewport 和 AddToPlayerScreen 之间所做的区分在这里不存在。
UWidgetLayoutLibraryGetPlayerScreenWidgetGeometryadoptGetPlayerScreenWidgetGeometry读取屏幕根而不创建它:询问几何信息不应导致屏幕被创建出来。
UWidgetLayoutLibraryGetMousePositionOnPlatformadoptGetMousePositionOnPlatform当 Slate 未运行时返回 false,因此无头调用者可以区分“没有光标”和“光标在原点”。
UWidgetLayoutLibraryGetMousePositionOnViewportadoptGetMousePositionOnViewport
UWidgetLayoutLibraryGetMousePositionScaledByDPIadoptGetMousePositionScaledByDPI返回 FVector2D,而不是 UMG 的两个 float。
UWidgetLayoutLibrarySlotAsBorderSlotmapSlotAsPanelSlot无论父级是什么,都是同一个 UDreamPanelSlot 类,因此整组 SlotAs* 函数合并为一个节点,不存在选错的可能。
UWidgetLayoutLibrarySlotAsCanvasSlotmapSlotAsPanelSlot
UWidgetLayoutLibrarySlotAsGridSlotmapSlotAsPanelSlot
UWidgetLayoutLibrarySlotAsHorizontalBoxSlotmapSlotAsPanelSlot
UWidgetLayoutLibrarySlotAsOverlaySlotmapSlotAsPanelSlot
UWidgetLayoutLibrarySlotAsUniformGridSlotmapSlotAsPanelSlot
UWidgetLayoutLibrarySlotAsVerticalBoxSlotmapSlotAsPanelSlot
UWidgetLayoutLibrarySlotAsScrollBoxSlotmapSlotAsPanelSlot
UWidgetLayoutLibrarySlotAsSafeBoxSlotmapSlotAsPanelSlot
UWidgetLayoutLibrarySlotAsScaleBoxSlotmapSlotAsPanelSlot
UWidgetLayoutLibrarySlotAsSizeBoxSlotmapSlotAsPanelSlot
UWidgetLayoutLibrarySlotAsStackBoxSlotmapSlotAsPanelSlot
UWidgetLayoutLibrarySlotAsWrapBoxSlotmapSlotAsPanelSlot
UWidgetLayoutLibrarySlotAsWidgetSwitcherSlotmapSlotAsPanelSlot
UWidgetLayoutLibraryRemoveAllWidgetsadoptRemoveAllWidgets通过 UDreamScreenUISubsystem 将每个被跟踪的页面从屏幕上移除。
UWidgetLayoutLibraryGetDesignTimeInfomapUDreamUserWidget::IsDesignTimeUMG 的结构体携带设计器的预览大小和标志。这里只有其中一部分在运行时有意义,即“我是否处于设计器中”,这也是图使用它的目的。

本页目录