类参考
UDreamBorder
UDreamBorder
继承自 UDreamUIControl。
声明于 Public/Controls/DreamBorder.h。
一种层级结构是代码而非资产的边框:一个面子、一个内边距,以及一个用来放东西的洞。
UMG 的 Border 是一个单子级面板,会在其容纳内容背后绘制一个画刷,而本库已经以调色板面板的形式提供了那种形状——一个承载图像视觉的 overlay。这里是控件的写法,而二者的区别正是贯穿这整个家族的那一点:面板的画刷、颜色和内边距是按实例编写的,而控件的则来自项目样式表,因此重新设计一个项目中的方框样式只需编辑一处,而不是每个方框各改一次。
刻意支持多个子级,而 UMG 的 border 只接受一个。面子承载一个 overlay,因此一个 Native.Border { A B } 会将 A 堆叠在 B 之下,二者都填满带内边距的区域——这正是 overlay 的含义,也是读这两行的人所预期的。UDreamScrollBox 的内容槽出于同样的理由做出了同样的选择;一个只接受恰好一个子级的洞会把每隔一个的子级送到某个看不见的地方。
轮廓是面子的一部分,而不是第二个控件:UDreamRectBlock 会绘制它自己的边框,因此 BorderThickness 和 BorderColor 被推入 rect,不消耗任何节点。零厚度即为 UMG 的普通边框,也就是样式默认提供的。
属性
| 名称 | 类型 | 类别 | 在细节面板中 | 从蓝图 | 描述 |
|---|---|---|---|---|---|
Style | FDreamBorderStyle | Border | 是 | GetStyle / SetStyle | 此实例自身的外观。只要 StyleSource 如此声明且确实存在样式表,项目样式表就胜出;项目中若没有样式表,这本身就是生效的外观。 |
HorizontalAlignment | EDreamPanelHorizontalAlignment | Border | 是 | GetHorizontalAlignment / SetHorizontalAlignment | 内容在带内边距区域内的位置——UMG 的 HorizontalAlignment / VerticalAlignment。 |
VerticalAlignment | EDreamPanelVerticalAlignment | Border | 是 | GetVerticalAlignment / SetVerticalAlignment | |
BrushColor | FColor | Border | 是 | GetBrushColor / SetBrushColor | 对样式背景颜色的一层着色——UMG 的 BrushColor,出于同样理由它是对 SBorder 画刷的一层着色:样式规定边框看起来是什么样,而它规定这个边框此刻正在发生什么。白色即为不表态。 |
ContentColorAndOpacity | FLinearColor | Border | 是 | GetContentColorAndOpacity / SetContentColorAndOpacity | 对内容的一层着色——UMG 的 ContentColorAndOpacity,颜色与 alpha 二者兼有,且从不作用于边框自身的面子。 |
bReportMouseEvents | bool | Border | 是 | GetReportMouseEvents / SetReportMouseEvents | 此边框是否报告指针事件——UMG 的四个鼠标事件,默认关闭。 |
bConsumeMouseEvents | bool | Border | 是 | GetConsumeMouseEvents / SetConsumeMouseEvents | 被报告的指针事件是否到此为止——本框架对 UMG 的 Handled 的写法。 |
FaceNode | TObjectPtr<UDreamWidget> | Border | - | 只读 | 面子:绘制画刷、着色和轮廓的东西,也是裁剪到圆角的东西。 |
ContentNode | TObjectPtr<UDreamWidget> | Border | - | 只读 | 洞。宿主在此控件上嵌套的任何东西最终都会落在这里。 |
EventTrigger | TObjectPtr<UUIEventTrigger> | Border | - | 只读 | 监听器,当它存在时。瞬态:组件随控件树重建,而非加载。 |
函数
| 函数 | 种类 | 描述 |
|---|---|---|
FDreamUIFaceBrush GetBrush() | pure | 面子的皮肤,从生效的样式中读取。 |
FColor GetBrushColor() | pure | 获取画刷颜色 |
bool GetConsumeMouseEvents() | pure | 获取是否消费鼠标事件 |
FLinearColor GetContentColorAndOpacity() | pure | 获取内容颜色与不透明度 |
UDreamWidget* GetContentNode() | pure | 东西放哪里。作为父级放入其中,或嵌套进 .dui,内边距会让它们远离边缘。 |
UUIEventTrigger* GetEventTrigger() | pure | 面子上的监听器,或在 bReportMouseEvents 关闭时为 null。 |
EDreamPanelHorizontalAlignment GetHorizontalAlignment() | pure | 获取水平对齐 |
FMargin GetPadding() | pure | 使内容远离边缘的东西,从生效的样式而非其旁边的字段读取——因此由项目样式表驱动的边框会回答它实际绘制所用的数值,而不是此实例恰好携带的那个。 |
bool GetReportMouseEvents() | pure | 获取是否报告鼠标事件 |
FDreamBorderStyle GetStyle() | pure | 获取样式 |
EDreamPanelVerticalAlignment GetVerticalAlignment() | pure | 获取垂直对齐 |
void SetBrush(FDreamUIFaceBrush InBrush) | callable | 设置画刷 |
void SetBrushColor(FColor InBrushColor) | callable | 设置画刷颜色 |
void SetBrushFromSprite(UDreamUISpriteData_BaseObject* InSprite) | callable | 面子画刷接受的另一种东西:图集精灵。UMG 没有对应的调用,因为 Slate 没有图集;在这里它二者中更廉价,因此让它无法触及会让昂贵的路径成为调用者唯一能找到的路。 |
void SetBrushFromTexture(UTexture2D* InTexture) | callable | 上述的常见情形,也是 UMG 所写明的那一个:把此纹理放到面子上,并让画刷的其他一切都保持原样。 |
void SetConsumeMouseEvents(bool bInConsumeMouseEvents) | callable | 设置是否消费鼠标事件 |
void SetContentColorAndOpacity(FLinearColor InContentColorAndOpacity) | callable | 参见该属性:颜色与 alpha 二者都着色内部的一切,而不着色面子。 |
void SetHorizontalAlignment(EDreamPanelHorizontalAlignment InHorizontalAlignment) | callable | 设置水平对齐 |
void SetPadding(FMargin InPadding) | callable | 下面的每个外观 setter 都编辑此实例的样式并重新推送,因为内边距、画刷以及其他部分是一个量,而样式正是它所在之处——在控件上再放一份副本,就是控件与其样式学会产生分歧的方式。 |
void SetReportMouseEvents(bool bInReportMouseEvents) | callable | 在面子上创建或销毁监听器。关闭即销毁它,因此关闭的边框不花费任何代价。 |
void SetStyle(FDreamBorderStyle InStyle) | callable | 此实例的整个外观,被替换并推送。注意事项参见 UDreamButton::SetStyle。 |
void SetVerticalAlignment(EDreamPanelVerticalAlignment InVerticalAlignment) | callable | 设置垂直对齐 |
事件
| 事件 | 签名 | 描述 |
|---|---|---|
OnMouseButtonDownEvent | void DreamBorderPointerEvent__DelegateSignature(UDreamPointerEventData* PointerEvent) | UMG 边框发声的四个时刻,从指针系统重新广播。 |
OnMouseButtonUpEvent | void DreamBorderPointerEvent__DelegateSignature(UDreamPointerEventData* PointerEvent) | |
OnMouseMoveEvent | void DreamBorderPointerEvent__DelegateSignature(UDreamPointerEventData* PointerEvent) | 指针在边框上的移动,本系统将其报告为它所参与的拖拽。 |
OnMouseDoubleClickEvent | void DreamBorderPointerEvent__DelegateSignature(UDreamPointerEventData* PointerEvent) | 双击的第二次按下、第四次、第六次——在该次按下时说出,并替代其 OnMouseButtonDownEvent,这正是 UBorder 报告它的方式:Slate 将第二次按下路由到 OnMouseButtonDoubleClick 而从不路由到 OnMouseButtonDown,因此这里的一次双击是一次按钮按下、一次双击和两次按钮抬起。 |
与 UMG 对比
UMG 类中每个面向蓝图的成员,以及它去了哪里。adopt:同名,同义。map:在这里换了名字或换了类型。reject:刻意缺失,并附理由。
| UMG | 成员 | 状态 | 此处 | 备注 |
|---|---|---|---|---|
UBorder | HorizontalAlignment | adopt | HorizontalAlignment | EDreamPanelHorizontalAlignment。位于控件而非样式中:某个东西放在哪儿是它自己的事,而共享一张样式表的两个边框各自装着不同的东西。 |
UBorder | VerticalAlignment | adopt | VerticalAlignment | |
UBorder | bShowEffectWhenDisabled | map | UDreamLayoutContainerBorder::bShowEffectWhenDisabled | 位于边框的 PANEL 拼写上,与 UMG 一样默认开启:当边框的控件被禁用时(无论是它自己的开关还是祖先的,UDreamWidget::GetIsEnabledInHierarchy),背景——即拥有该控件的控件的视觉——以 45% 的 alpha 绘制,这正是 SBorder 的禁用绘制效果在默认 Slate 着色器中所达到的结果。仅背景如此:边框所装的内容会显示它自己的禁用外观。 |
UBorder | ContentColorAndOpacity | adopt | ContentColorAndOpacity | 颜色和 alpha 都包括,作为内容洞的内容着色(UDreamWidget::SetContentTint):洞下方的每一个视觉在传送到屏幕的过程中都会在线性空间中被它乘上,正如 SCompoundWidget 将其 ColorAndOpacity 混合进其子级绘制所用的内容,而边框自身的表面从不被着色。内部没有任何东西被写入,内容的 RenderOpacity 保持空闲,留给任何使其淡出的东西使用。UDreamLayoutContainerBorder::ContentColorAndOpacity 在面板拼写上与此相同。 |
UBorder | Padding | map | FDreamBorderStyle::Padding | 在样式中,因为它是一个量,而在控件上再放一份副本正是两者学会产生分歧的方式。GetPadding 返回解析后的数值;SetPadding 编辑此实例的样式。 |
UBorder | Background | map | FDreamBorderStyle::BackgroundBrush | 使用 FDreamUIFaceBrush 而非 FSlateBrush——控件表面是一个程序化矩形,而画刷是它的主体纹理。参见该结构体自身的说明。 |
UBorder | BrushColor | adopt | BrushColor | 使用 FColor,并且是叠加在样式背景色之上的一个着色——在 Slate 中它也是这样。 |
UBorder | DesiredSizeScale | map | UDreamLayoutContainerBorder::DesiredSizeScale | 位于边框的 PANEL 拼写上,在那里它已经会缩放面板所报告的结果(MeasureLayout 会乘上结果,并在它实际得到的矩形中排列内容——正是 UBorder 的规则)。控件用自己的叠加层来布局其表面和内容,而不是通过那个面板;需要缩放报告的项目应使用面板,或将控件包裹在一个面板中。 |
UBorder | bFlipForRightToLeftFlowDirection | map | UDreamLayoutContainerBorder::bFlipForRightToLeftFlowDirection | 位于边框的 PANEL 拼写上,与 UMG 一样默认关闭:当它开启且边框从右到左布局时,背景——即拥有该控件的控件的视觉——会通过一个运行时 UDreamMeshModifierMirror 围绕自身中心镜像,正如 SBorder 通过 (-1, 1) 渲染变换绘制其画刷。内容不会被它镜像:内容放在哪儿是面板的事,而每一个通过 CommitChildRect 排列的面板在从右到左的流向下都已经会沿其宽度反射其子级(UDreamWidget::FlowDirectionPreference)。 |
UBorder | OnMouseButtonDownEvent | adopt | OnMouseButtonDownEvent | 一个携带 UDreamPointerEventData 的多播,而非 UMG 的返回 FEventReply 的单一绑定:此事件系统中没有任何东西会在每次调用时询问处理器事件是否继续。那个答案是四个事件共用的一个属性——bConsumeMouseEvents,它是 UUIEventTrigger::AllowEventBubbleUp 的反面。受 bReportMouseEvents 门控,默认关闭,因为一个监听的边框就是一个消费的边框。 |
UBorder | OnMouseButtonUpEvent | adopt | OnMouseButtonUpEvent | |
UBorder | OnMouseMoveEvent | adopt | OnMouseMoveEvent | 由 DRAG 接缝供给:此事件系统将移动的指针报告给它按下时所处的元素,这是边框唯一能诚实声称的移动。从未按下的悬停是 OnPointerEnter/Exit,UMG 在别处拼写它。 |
UBorder | OnMouseDoubleClickEvent | adopt | OnMouseDoubleClickEvent | 在第二次按下时说出,并替代它的 OnMouseButtonDownEvent,正如 UBorder 那样:事件系统将双击的第二次按下路由到双击而非按下,这是 Slate 的 FSlateApplication::ProcessMouseButtonDoubleClickEvent。所以一次双击是一次按下、一次双击和两次抬起。什么算作双击是事件系统自己的规则(它的 DoubleClickTime、相同的控件和按钮,以及第二次按下落在第一次的指针拖拽阈值之内——桌面的双击矩形和拖拽阈值是同样的几个像素),而不是这里可能与之产生分歧的第二套规则。 |
UBorder | SetContentColorAndOpacity | map | SetContentColorAndOpacity | 颜色和 alpha 都包括,直接作用于内容洞的内容着色,同上一条属性。 |
UBorder | SetPadding | adopt | SetPadding | |
UBorder | SetHorizontalAlignment | adopt | SetHorizontalAlignment | 直接推送到内容槽上。 |
UBorder | SetVerticalAlignment | adopt | SetVerticalAlignment | |
UBorder | SetBrushColor | adopt | SetBrushColor | |
UBorder | SetBrush | adopt | SetBrush | 接收 FDreamUIFaceBrush;为何它不是 FSlateBrush,见上面的 Background。 |
UBorder | SetBrushFromAsset | reject | USlateBrushAsset 包装了一个 FSlateBrush,而程序化矩形表面无法绘制它。此框架的表面画刷接收的两样东西——一个纹理和一个图集精灵——正是 SetBrush 和 SetBrushFromTexture 所接收的。 | |
UBorder | SetBrushFromTexture | adopt | SetBrushFromTexture | 替换图像,并让九宫格、缩放模式和着色保持原样。 |
UBorder | SetBrushFromMaterial | reject | 程序化矩形没有自己的材质可设置。它的材质是 GetMaterialToCreateGeometry——画布批处理每个矩形所用的共享材质——并且在 UDreamVisual 上任何地方都没有逐实例覆盖(注释中提到的 CustomUIMaterial 是来自上游库的一个遗留名称;此插件中没有任何东西声明它)。确实携带材质的两个视觉,UDreamText 和 UDreamImage,才是材质绘制表面的样子:把一个放进边框里。这里改为提供 SetBrushFromSprite,这是此表面能够接收而 Slate 不能接收的东西。 | |
UBorder | SetShowEffectWhenDisabled | map | UDreamLayoutContainerBorder::SetShowEffectWhenDisabled | 见 bShowEffectWhenDisabled:背景的 alpha 会立即跟随。 |
UBorder | GetDynamicMaterial | reject | 矩形没有自己的材质实例:它通过其绘制调用的材质来绘制,而画布通过与批处理进同一次调用的每一个其他控件共享的渲染线程代理来应答该材质的参数。没有任何东西可以交出去,使得在它上面设置参数就能仅重新着色此边框。 | |
UBorder | SetDesiredSizeScale | map | UDreamLayoutContainerBorder::SetDesiredSizeScale | 见上面的 DesiredSizeScale。 |
UBorder | SetStyle | adopt | SetStyle | UBorder 根本没有样式结构体;这是本家族在运行时替换外观的拼写。 |