DreamGUI
类参考

UDreamUIWidgetGeometryLibrary

UDreamUIWidgetGeometryLibrary

继承自 UBlueprintFunctionLibrary。

在 Public/DreamUIWidgetGeometryLibrary.h 中声明。

在控件自身空间、视口和屏幕之间进行坐标转换——本框架的 USlateBlueprintLibrary。

所有函数都返回 bool,并通过输出参数给出结果,而 UMG 中的对应函数直接返回值。这是有意为之,并且与世界空间 UI 有关:一个焊接在关卡中机器上的面板,在没有相机对准它之前是没有视口位置的,而诚实的答案是“在这里”和“哪里都没有”,而不是在错误空间中计算出的一个数字。忽略 bool 的调用者得到的是零,而不是一个看起来像位置的谎言。

函数

函数类型描述
bool AbsoluteToLocal(FDreamUIWidgetGeometry InGeometry, FVector2D InAbsoluteCoordinate, FVector2D& OutLocalCoordinate)pure控件自身空间中的一个视口像素位置。假定该点位于控件平面内。
bool AbsoluteToViewport(UObject* WorldContextObject, FVector2D InAbsoluteCoordinate, FVector2D& OutPixelPosition, FVector2D& OutViewportPosition)pure视口像素,同时以像素和 DPI 缩放后的视口坐标表示。UMG 的 AbsoluteToViewport。
bool GetAbsoluteSize(FDreamUIWidgetGeometry InGeometry, FVector2D& OutAbsoluteSize)pure控件以视口像素为单位的大小。当该矩形无法放入视口时返回 False。
FVector2D GetLocalSize(FDreamUIWidgetGeometry InGeometry)pure控件以自身单位表示的大小。对于未指定任何控件的几何体,返回零。
FVector2D GetLocalTopLeft(FDreamUIWidgetGeometry InGeometry)pure局部坐标所依据测量的角,位于控件自身空间中。
FDreamUIWidgetGeometry GetWidgetGeometry(UDreamWidget* InWidget)pure读取控件的几何体——UMG 的 GetCachedGeometry、GetTickSpaceGeometry 和 GetPaintSpaceGeometry 三者合一。
bool IsUnderLocation(FDreamUIWidgetGeometry InGeometry, FVector2D InAbsoluteCoordinate)pure某个视口像素位置是否位于此控件的矩形内?UMG 的 IsUnderLocation。
bool LocalToAbsolute(FDreamUIWidgetGeometry InGeometry, FVector2D InLocalCoordinate, FVector2D& OutAbsoluteCoordinate)pure控件自身空间中的一个点,以视口像素表示。
bool LocalToViewport(UObject* WorldContextObject, FDreamUIWidgetGeometry InGeometry, FVector2D InLocalCoordinate, FVector2D& OutPixelPosition, FVector2D& OutViewportPosition)pure控件自身空间中的一个点,同时以视口像素和 DPI 缩放后的视口坐标表示——UMG 的 LocalToViewport,出于同样的原因返回两者。
bool ScreenToViewport(UObject* WorldContextObject, FVector2D InScreenPosition, FVector2D& OutViewportPosition)pure一个屏幕位置,以 DPI 缩放后的视口坐标表示。UMG 的 ScreenToViewport。
bool ScreenToWidgetAbsolute(FVector2D InScreenPosition, FVector2D& OutAbsoluteCoordinate)pure同一个屏幕位置,以视口像素表示。此处两者是同一空间,因此这是恒等变换。
bool ScreenToWidgetLocal(FDreamUIWidgetGeometry InGeometry, FVector2D InScreenPosition, FVector2D& OutLocalCoordinate)pure一个屏幕位置——即鼠标位置或世界到屏幕投影给出的结果——位于控件自身空间中。UMG 的 ScreenToWidgetLocal。
bool TransformScalarAbsoluteToLocal(FDreamUIWidgetGeometry InGeometry, float InAbsoluteScalar, float& OutLocalScalar)pureTransform Scalar Absolute to Local
bool TransformScalarLocalToAbsolute(FDreamUIWidgetGeometry InGeometry, float InLocalScalar, float& OutAbsoluteScalar)pure在两个空间之间转换的一个长度,不涉及原点——UMG 的 Scalar_LocalToAbsolute 及相关函数。
bool TransformVectorAbsoluteToLocal(FDreamUIWidgetGeometry InGeometry, FVector2D InAbsoluteVector, FVector2D& OutLocalVector)pureTransform Vector Absolute to Local
bool TransformVectorLocalToAbsolute(FDreamUIWidgetGeometry InGeometry, FVector2D InLocalVector, FVector2D& OutAbsoluteVector)pure按轴表示的一个方向和长度。UMG 的 Vector_LocalToAbsolute。

与 UMG 的比较

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

UMG成员状态此处备注
USlateBlueprintLibraryIsUnderLocationadoptIsUnderLocation基于控件测得的像素矩形。对于完全没有视口位置的几何体返回 False——例如渲染目标画布,或没有相机的世界空间画布。
USlateBlueprintLibraryAbsoluteToLocaladoptAbsoluteToLocal假定该点位于控件自身平面内,这对每个 2D 界面都成立。对于缩放器无法求逆的画布返回 false——尤其是世界空间,那里应使用射线投射器。
USlateBlueprintLibraryLocalToAbsoluteadoptLocalToAbsolute局部坐标的原点位于控件的左下角,而不是 Slate 的左上角:本框架中所有其他归一化坐标已经把零点放在左下角。
USlateBlueprintLibraryGetLocalTopLeftadoptGetLocalTopLeft始终为零,因为局部坐标就是从那一个角定义的——与 UMG 对普通控件给出的答案相同。保留它以便针对 UMG 编写的图表读起来一致。
USlateBlueprintLibraryGetLocalSizeadoptGetLocalSize
USlateBlueprintLibraryGetAbsoluteSizeadoptGetAbsoluteSize由矩形两个投影角测得,因此画布缩放器、渲染缩放以及祖先的缩放都已包含在内。
USlateBlueprintLibraryScalar_AbsoluteToLocalmapTransformScalarAbsoluteToLocal以其转换的内容命名,而非使用类型前缀。对于非均匀缩放的控件,由较宽的轴决定,与 UMG 中一致。
USlateBlueprintLibraryScalar_LocalToAbsolutemapTransformScalarLocalToAbsolute
USlateBlueprintLibraryVector_AbsoluteToLocalmapTransformVectorAbsoluteToLocal按轴处理,因此非均匀缩放在这里得到尊重,而标量版本只能选取其一。
USlateBlueprintLibraryVector_LocalToAbsolutemapTransformVectorLocalToAbsolute
USlateBlueprintLibraryEqualEqual_SlateBrushmapUDreamUIWidgetLibrary::EqualEqual_DreamUIImageBrush本框架的画刷是 FDreamUIImageBrush,因此该节点以其命名。对浮点数进行精确比较而非容差比较:调用者用 == 提出的问题是“是否有人修改过这个画刷”,而近似比较会对一个像素的微调回答“否”。该节点位于控件库上,因为其他画刷动词也在那里。
USlateBlueprintLibraryLocalToViewportadoptLocalToViewport同时返回像素位置和 DPI 缩放后的位置,与 UMG 一致。
USlateBlueprintLibraryAbsoluteToViewportadoptAbsoluteToViewport
USlateBlueprintLibraryScreenToWidgetLocaladoptScreenToWidgetLocal没有 bIncludeWindowPosition 参数:此处屏幕位置和视口像素位置是同一空间,因为本框架在视口内绘制,从不针对桌面绘制。
USlateBlueprintLibraryScreenToWidgetAbsoluteadoptScreenToWidgetAbsolute恒等变换,原因见上一行。它存在是为了让移植的图表保持其形状,并让这种等价关系在某处被明确陈述。
USlateBlueprintLibraryScreenToViewportadoptScreenToViewport

本页目录