DreamGUI
类参考

UDreamPanelSlot

UDreamPanelSlot

继承自 UDreamWidgetSubObjectBehaviour。

声明于 Public/Core/Components/DreamPanelSlot.h。

由子控件拥有的 UMG 风格逐子项布局数据。

属性

名称类型类别在细节面板中来自蓝图描述
PaddingFMargin插槽是SetPadding
HorizontalAlignmentEDreamPanelHorizontalAlignment插槽是SetHorizontalAlignment
VerticalAlignmentEDreamPanelVerticalAlignment插槽是SetVerticalAlignment
SizeRuleEDreamPanelSizeRule插槽是SetSizeRule
FillWeightfloat插槽是SetFillWeight
Rowint32插槽是SetRow
Columnint32插槽是SetColumn
RowSpanint32插槽是SetRowSpan
ColumnSpanint32插槽是SetColumnSpan
ZOrderint32插槽是SetZOrder同级之间的绘制顺序,以稳定重排的方式应用(相同值保持同级顺序)。Overlay 和 GridPanel 始终使用它,CanvasPanel 在 SortChildrenByZOrder 开启时使用它;其他所有面板都严格按同级顺序排列,忽略此值。
bAutoSizebool插槽是SetAutoSize
MinDesiredSizeFVector2D插槽是SetMinDesiredSize按轴应用于该子项测量结果的上下限,零表示“无意见”。
MaxDesiredSizeFVector2D插槽是SetMaxDesiredSize
bFillEmptySpacebool插槽是SetFillEmptySpace仅限 WrapBox,对应 UMG 的 UWrapBoxSlot:当此子项是其所在行的最后一个时,它会占据该行剩余的所有空间。行上的其他任何子项询问它时,它都不起作用 —— SWrapBox 只读取该行最后一个子项的这个标志。其他任何面板都不会读取它。
FillSpanWhenLessThanfloat插槽是SetFillSpanWhenLessThan仅限 WrapBox,对应 UMG 的 UWrapBoxSlot:当盒子的换行宽度低于此值时,让此子项独占一行。零会禁用它。经典用法是响应式的卡片列表,当面板窄到共享行会让所有内容难以阅读时,就停止共享行。
bForceNewLinebool插槽是SetNewLine仅限 WrapBox,对应 UMG 的 UWrapBoxSlot::bForceNewLine:从此子项开始新的一行,无论当前行还剩多少空间。它是 FillSpanWhenLessThan 的无条件版本,后者只在盒子变窄时才换行;这样可以让章节标题保持在自己行的开头。
NudgeFVector2D插槽是SetNudge添加在面板决定放置此子项的位置上的固定偏移,位于面板的内容空间中(x 向右,y 向下 —— 与 Padding 的方向一致)。

函数

函数种类描述
FVector2D GetAlignment()纯函数UMG 的 Alignment:控件位置参照其自身矩形内部的哪个点。本插件的 Pivot。
FAnchors GetAnchors()纯函数获取锚点
bool GetAutoSize()纯函数获取自动大小
int32 GetLayer()纯函数UMG 的 UGridSlot::Layer,即此插槽在其 UMG 名称下的 ZOrder,而不是另一个数字。
FDreamUIAnchorData GetLayout()纯函数UMG 的 UCanvasPanelSlot 矩形系列,读写控件自身的 FDreamUIAnchorData。
FMargin GetOffsets()纯函数获取偏移
FVector2D GetPosition()纯函数控件的对齐点相对于其锚点的偏移 —— 即 UMG 在点锚点上的 Position。
FVector2D GetSize()纯函数点锚点解析出的大小,以及在拉伸锚点上超出锚点范围的大小。
int32 GetZOrder()纯函数获取 ZOrder
void NotifySlotChanged(EDreamLayoutInvalidation Reason)可调用Reason 默认为 Measure,这是安全的答案。Alignment、size rule、fill weight 和 z-order 改为传递 Arrange:它们都不出现在任何面板的 MeasureLayout 中 —— 已逐一检查 —— 因此它们无法改变首选大小,只能影响此插槽的控件最终位于其父级内部的位置。Padding、网格坐标和 bAutoSize 都确实出现在其中,保持默认值。
void SetAlignment(FVector2D InAlignment)可调用设置对齐
void SetAnchors(FAnchors InAnchors)可调用设置锚点
void SetAutoSize(bool Value)可调用设置自动大小
void SetColumn(int32 Value)可调用设置列
void SetColumnSpan(int32 Value)可调用设置列跨度
void SetFillEmptySpace(bool Value)可调用设置填充空白空间
void SetFillSpanWhenLessThan(float Value)可调用设置小于时填充跨度
void SetFillWeight(float Value)可调用设置填充权重
void SetHorizontalAlignment(EDreamPanelHorizontalAlignment Value)可调用设置水平对齐
void SetLayer(int32 InLayer)可调用设置层
void SetLayout(FDreamUIAnchorData InLayout)可调用设置布局
void SetMaxDesiredSize(FVector2D Value)可调用设置最大期望大小
void SetMaximum(FVector2D InMaximumAnchors)可调用设置最大值
void SetMinDesiredSize(FVector2D Value)可调用设置最小期望大小
void SetMinimum(FVector2D InMinimumAnchors)可调用设置最小值
void SetNewLine(bool Value)可调用设置新行
void SetNudge(FVector2D Value)可调用设置微调
void SetOffsets(FMargin InOffsets)可调用设置偏移
void SetPadding(FMargin Value)可调用设置内边距
void SetPosition(FVector2D InPosition)可调用设置位置
void SetRow(int32 Value)可调用设置行
void SetRowSpan(int32 Value)可调用设置行跨度
void SetSize(FVector2D InSize)可调用设置大小
void SetSizeRule(EDreamPanelSizeRule Value)可调用设置大小规则
void SetVerticalAlignment(EDreamPanelVerticalAlignment Value)可调用设置垂直对齐
void SetZOrder(int32 Value)可调用设置 ZOrder

与 UMG 的对比

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

UMG成员状态此处备注
UBackgroundBlurSlotSetPaddingadoptSetPadding
UBackgroundBlurSlotSetHorizontalAlignmentadoptSetHorizontalAlignment
UBackgroundBlurSlotSetVerticalAlignmentadoptSetVerticalAlignment
UBackgroundBlurSlotPaddingadoptPadding
UBackgroundBlurSlotHorizontalAlignmentadoptHorizontalAlignment
UBackgroundBlurSlotVerticalAlignmentadoptVerticalAlignment
UBorderSlotSetPaddingadoptSetPadding
UBorderSlotSetHorizontalAlignmentadoptSetHorizontalAlignment
UBorderSlotSetVerticalAlignmentadoptSetVerticalAlignment
UBorderSlotPaddingadoptPadding
UBorderSlotHorizontalAlignmentadoptHorizontalAlignment
UBorderSlotVerticalAlignmentadoptVerticalAlignment
UButtonSlotPaddingadoptPadding
UButtonSlotHorizontalAlignmentadoptHorizontalAlignment
UButtonSlotVerticalAlignmentadoptVerticalAlignment
UButtonSlotSetPaddingadoptSetPadding
UButtonSlotSetHorizontalAlignmentadoptSetHorizontalAlignment
UButtonSlotSetVerticalAlignmentadoptSetVerticalAlignment
UCanvasPanelSlotLayoutDatamapUDreamWidget::AnchorData画布子项直接在控件自身上声明其矩形(枢轴点、锚点最小值/最大值、锚定位置、尺寸增量)。插槽读写该数据,而不再保存第二份副本。
UCanvasPanelSlotbAutoSizeadoptbAutoSize
UCanvasPanelSlotZOrderadoptZOrderOverlay 和 GridPanel 始终遵循,CanvasPanel 在开启 SortChildrenByZOrder 时遵循。
UCanvasPanelSlotSetLayoutadoptSetLayout接收 FDreamUIAnchorData,即本插件的 FAnchorData。
UCanvasPanelSlotGetLayoutadoptGetLayout
UCanvasPanelSlotSetPositionadoptSetPosition对齐点相对于锚点的偏移。此处 y 轴向上,与本插件中所有其他变换设置器一致,而不像 UMG 那样向下。
UCanvasPanelSlotGetPositionadoptGetPosition
UCanvasPanelSlotSetSizeadoptSetSize写入 SizeDelta:在点锚点上为解析后的尺寸,在拉伸锚点上为超出锚点跨度的尺寸。盒式插槽的 SetSize(FSlateChildSize) 无法共用此名称,因为这里只有一个插槽类;它对应的是 SetSizeRule/SetFillWeight。
UCanvasPanelSlotGetSizeadoptGetSize
UCanvasPanelSlotSetOffsetsadoptSetOffsets相对锚点矩形的四个边距,即在拉伸轴上的 UMG 含义;在点锚点上 UMG 复用 Right/Bottom 表示尺寸,而此处并非如此——那种读法对应 GetSize/SetSize。
UCanvasPanelSlotGetOffsetsadoptGetOffsets
UCanvasPanelSlotSetAnchorsadoptSetAnchors接收 FAnchors。Minimum 是锚点矩形的左下角,因为此处 y 轴向上。
UCanvasPanelSlotGetAnchorsadoptGetAnchors
UCanvasPanelSlotSetMinimumadoptSetMinimum已加入骨架:在 UCanvasPanelSlot 上以裸 UFUNCTION 反射,因此扫描未能发现。
UCanvasPanelSlotSetMaximumadoptSetMaximum已加入骨架,称为 SetMinimum。
UCanvasPanelSlotSetAlignmentadoptSetAlignment本插件的 Pivot:相同量、相同 0..1 范围、y 轴向上。
UCanvasPanelSlotGetAlignmentadoptGetAlignment
UCanvasPanelSlotSetAutoSizeadoptSetAutoSize
UCanvasPanelSlotGetAutoSizeadoptGetAutoSize
UCanvasPanelSlotSetZOrderadoptSetZOrder
UCanvasPanelSlotGetZOrderadoptGetZOrder
UGridSlotPaddingadoptPadding
UGridSlotHorizontalAlignmentadoptHorizontalAlignment
UGridSlotVerticalAlignmentadoptVerticalAlignment
UGridSlotRowadoptRow
UGridSlotRowSpanadoptRowSpan
UGridSlotColumnadoptColumn
UGridSlotColumnSpanadoptColumnSpan
UGridSlotLayermapZOrder网格的 layer 与插槽的 z-order 是同一件事——哪些子项绘制在哪些子项之上——而且网格面板已按 ZOrder 稳定重排。GetLayer/SetLayer 以 UMG 的名称存在并转发给它,而不是再保存第二个数字。
UGridSlotNudgeadoptNudge在 UDreamPanelLayoutBase::ApplyChildRect 中应用,因此每个面板都遵循它,而不只是网格;对度量不可见,微调本就应当如此。
UGridSlotSetPaddingadoptSetPadding
UGridSlotSetRowadoptSetRow
UGridSlotSetRowSpanadoptSetRowSpan
UGridSlotSetColumnadoptSetColumn
UGridSlotSetColumnSpanadoptSetColumnSpan
UGridSlotSetLayeradoptSetLayer
UGridSlotSetNudgeadoptSetNudge
UGridSlotSetHorizontalAlignmentadoptSetHorizontalAlignment
UGridSlotSetVerticalAlignmentadoptSetVerticalAlignment
UHorizontalBoxSlotSizemapSizeRuleFSlateChildSize 是一条规则加一个值;规则是 SizeRule(Auto/Fill),值是 FillWeight。
UHorizontalBoxSlotPaddingadoptPadding
UHorizontalBoxSlotHorizontalAlignmentadoptHorizontalAlignment
UHorizontalBoxSlotVerticalAlignmentadoptVerticalAlignment
UHorizontalBoxSlotSetPaddingadoptSetPadding
UHorizontalBoxSlotSetSizemapSetSizeRule两个设置器:SetSizeRule 和 SetFillWeight。裸名 SetSize 属于画布矩形族,因为这里只有一个插槽类,而非 UMG 那样每个面板一个。
UHorizontalBoxSlotSetHorizontalAlignmentadoptSetHorizontalAlignment
UHorizontalBoxSlotSetVerticalAlignmentadoptSetVerticalAlignment
UOverlaySlotPaddingadoptPadding
UOverlaySlotHorizontalAlignmentadoptHorizontalAlignment
UOverlaySlotVerticalAlignmentadoptVerticalAlignment
UOverlaySlotSetPaddingadoptSetPadding
UOverlaySlotSetHorizontalAlignmentadoptSetHorizontalAlignment
UOverlaySlotSetVerticalAlignmentadoptSetVerticalAlignment
UPanelSlotGetContentmapGetWidget此处的插槽属于它所布局的那个控件,因此其内容就是该控件;访问器继承自 UDreamWidgetSubObjectBehaviour。
USafeZoneSlotbIsTitleSafemapUDreamLayoutContainerSafeZone::bUsePlatformSafeZone安全区只接受一个子项,因此“此插槽请求平台的安全区域”和“此面板应用它”是同一个开关;它保留在面板上,与它配合使用的四个边开关放在一起。
USafeZoneSlotSafeAreaScalemapUDreamLayoutContainerSafeZone::SafeAreaScale与 Slate 相同,在平台安全边距上按边应用的乘数;出于与 bIsTitleSafe 相同的原因放在面板上。
USafeZoneSlotHAlignmapHorizontalAlignment通用插槽对齐方式;UMG 仅在此插槽上对其使用缩写。
USafeZoneSlotVAlignmapVerticalAlignment
USafeZoneSlotPaddingadoptPadding
UScaleBoxSlotHorizontalAlignmentadoptHorizontalAlignment
UScaleBoxSlotVerticalAlignmentadoptVerticalAlignment
UScaleBoxSlotSetHorizontalAlignmentadoptSetHorizontalAlignment
UScaleBoxSlotSetVerticalAlignmentadoptSetVerticalAlignment
UScrollBoxSlotSizemapSizeRuleFSlateChildSize 是一条规则加一个值;规则是 SizeRule(Auto/Fill),值是 FillWeight。沿滚动轴,Fill 插槽按 SScrollBox 堆叠单个插槽的方式堆叠,并关闭收缩:Fill 插槽按权重共享它们请求的大小与视口减去其他所有内容后的大小两者中的较大值,每个都受其自身 Min/MaxDesiredSize 限制。短内容会被拉伸至视口,溢出的内容保持其请求的长度,滚动范围始终是期望的总大小。
UScrollBoxSlotPaddingadoptPadding
UScrollBoxSlotHorizontalAlignmentadoptHorizontalAlignment
UScrollBoxSlotVerticalAlignmentadoptVerticalAlignment
UScrollBoxSlotSetPaddingadoptSetPadding
UScrollBoxSlotSetHorizontalAlignmentadoptSetHorizontalAlignment
UScrollBoxSlotSetVerticalAlignmentadoptSetVerticalAlignment
USizeBoxSlotPaddingadoptPadding
USizeBoxSlotHorizontalAlignmentadoptHorizontalAlignment
USizeBoxSlotVerticalAlignmentadoptVerticalAlignment
USizeBoxSlotSetPaddingadoptSetPadding
USizeBoxSlotSetHorizontalAlignmentadoptSetHorizontalAlignment
USizeBoxSlotSetVerticalAlignmentadoptSetVerticalAlignment
UStackBoxSlotPaddingadoptPadding
UStackBoxSlotSizemapSizeRuleFSlateChildSize 是一条规则加一个值;规则是 SizeRule(Auto/Fill),值是 FillWeight。
UStackBoxSlotHorizontalAlignmentadoptHorizontalAlignment
UStackBoxSlotVerticalAlignmentadoptVerticalAlignment
UUniformGridSlotHorizontalAlignmentadoptHorizontalAlignment
UUniformGridSlotVerticalAlignmentadoptVerticalAlignment
UUniformGridSlotRowadoptRow
UUniformGridSlotColumnadoptColumn
UUniformGridSlotSetRowadoptSetRow
UUniformGridSlotSetColumnadoptSetColumn
UUniformGridSlotSetHorizontalAlignmentadoptSetHorizontalAlignment
UUniformGridSlotSetVerticalAlignmentadoptSetVerticalAlignment
UVerticalBoxSlotSizemapSizeRuleFSlateChildSize 是一条规则加一个值;规则是 SizeRule(Auto/Fill),值是 FillWeight。
UVerticalBoxSlotPaddingadoptPadding
UVerticalBoxSlotHorizontalAlignmentadoptHorizontalAlignment
UVerticalBoxSlotVerticalAlignmentadoptVerticalAlignment
UVerticalBoxSlotSetPaddingadoptSetPadding
UVerticalBoxSlotSetSizemapSetSizeRule两个 setter:SetSizeRule 和 SetFillWeight;关于为何裸名称被占用,请参阅 HorizontalBoxSlot。
UVerticalBoxSlotSetHorizontalAlignmentadoptSetHorizontalAlignment
UVerticalBoxSlotSetVerticalAlignmentadoptSetVerticalAlignment
UWidgetSwitcherSlotPaddingadoptPadding
UWidgetSwitcherSlotHorizontalAlignmentadoptHorizontalAlignment
UWidgetSwitcherSlotVerticalAlignmentadoptVerticalAlignment
UWidgetSwitcherSlotSetPaddingadoptSetPadding
UWidgetSwitcherSlotSetHorizontalAlignmentadoptSetHorizontalAlignment
UWidgetSwitcherSlotSetVerticalAlignmentadoptSetVerticalAlignment
UWrapBoxSlotPaddingadoptPadding
UWrapBoxSlotFillSpanWhenLessThanadoptFillSpanWhenLessThan
UWrapBoxSlotHorizontalAlignmentadoptHorizontalAlignment
UWrapBoxSlotVerticalAlignmentadoptVerticalAlignment
UWrapBoxSlotbFillEmptySpaceadoptbFillEmptySpace
UWrapBoxSlotbForceNewLineadoptbForceNewLine由换行框的测量与排列共同读取,因此它产生的行数就是它为测量预留空间的那个行数。
UWrapBoxSlotSetPaddingadoptSetPadding
UWrapBoxSlotSetFillEmptySpaceadoptSetFillEmptySpace
UWrapBoxSlotSetFillSpanWhenLessThanadoptSetFillSpanWhenLessThan
UWrapBoxSlotSetHorizontalAlignmentadoptSetHorizontalAlignment
UWrapBoxSlotSetVerticalAlignmentadoptSetVerticalAlignment
UWrapBoxSlotSetNewLineadoptSetNewLine

本页目录