UDreamButton
UDreamButton
继承自 UDreamUIControl。
声明于 Public/Controls/DreamButton.h。
一个层级结构由代码而非资产定义的按钮。
两个节点——一个面,以及其上的孔——以及 BP_Button 数月来缺失的行为。这一缺失正是这个类存在的全部理由:一个始终添加自身 UIButton 的控件不存在点击它却毫无反应的状态。
面的画刷保持白色,而可选组件将样式中的颜色以绝对值写入其中,而非画廊那种用有色画刷乘以近白色调的惯常做法——两个来源的乘积是任何样式表都无法命名的一种外观。
它自身不绘制任何文本。按钮上的内容就是宿主放入孔中的内容,而孔默认只有一个,因此嵌套即可填充它:
Native.Button Confirm {
Text { Text = "确定" }
OnClicked -> HandleConfirm
}只有一个子项,因为每个内容槽都只接受一个——图标位于标签旁边时就是一个面板,而面板是作者放进洞里的东西,而不是洞本身必须具备的东西。过去有一个内置的 Label 属性,背后是一个 UDreamText 节点,而只要洞被填上,它就会让这个属性退场:两个回答“这个按钮上是什么”的方案交替出现,还要靠一条互换规则来保证其中恰好一个处于唤醒状态。只有一个回答就不需要规则。UDreamDialog 是该属性唯一真正的使用者,现在它像其他任何宿主一样,把自己的 UDreamText 放进洞里。
它的尺寸就是其内容的尺寸。正面是一个 UMG Size Box:它在洞里的任何内容周围保留 ContentPadding,并以此内容加上内边距来测量,样式的 Height 是下限而不是高度。这就是 Auto 行能够测量的按钮与此前的按钮之间的区别:此前一个带有自己文本布局的内置标签决定了高度,作者填写的数值被写到控件上,而下一次排列又会把它覆盖掉,而洞——一个没有容器的节点——根本不会排列宿主挂在其中的内容。
Height 作为下限,才让两种解读都成立:空按钮的宽度是 ContentPadding、高度是 Height,含一行文本的按钮则是该文本加上内边距,且高度至少为 Height,而装了较大内容的按钮会随之增大。宽度没有下限——没有人声明的轴归使用者,这也是该系列在其他所有地方都遵循的规则。
属性
| 名称 | 类型 | 分类 | 在细节面板中 | 来自蓝图 | 描述 |
|---|---|---|---|---|---|
Style | FDreamButtonStyle | Button | 是 | GetStyle / SetStyle | 此实例自身的外观。当 StyleSource 指示如此且项目中确实存在样式表时,项目样式表胜出;若项目中无样式表,则这就是实际生效的外观——这正是它保持可编辑而不被枚举所限制的原因:旧的编辑条件恰好把驱动控件的那些值变灰了。 |
BackgroundColor | FColor | Button | 是 | GetBackgroundColor / SetBackgroundColor | 一个乘以面上所显示内容的着色——UMG 的 BackgroundColor,也是面画刷创作时 Tint 的运行时部分。 |
ColorAndOpacity | FLinearColor | Button | 是 | GetColorAndOpacity / SetColorAndOpacity | 一个覆盖整个按钮(面与内容一视同仁)的着色——UMG 的 ColorAndOpacity,此属性会遵循其 alpha。 |
bAllowDragDrop | bool | Button | 是 | GetAllowDragDrop / SetAllowDragDrop | 拖拽是否可以从这个按钮开始——UMG 的 bAllowDragDrop,默认关闭,与 UMG 一致。 |
ClickMethod | EDreamUIClickMethod | Button | 是 | GetClickMethod / SetClickMethod | 此按钮的点击在何时触发,按输入类型区分——UMG 的三个枚举,在控件层面暴露。 |
TouchMethod | EDreamUITouchMethod | Button | 是 | GetTouchMethod / SetTouchMethod | |
PressMethod | EDreamUIPressMethod | Button | 是 | GetPressMethod / SetPressMethod | |
AcceptedMouseButtons | int32 | Button | 是 | GetAcceptedMouseButtons / SetAcceptedMouseButtons | 哪些鼠标按键可以按下并点击此按钮——基于 EDreamUIMouseButtonType 的位掩码,默认仅左键,这是 UMG 的规则:SButton 只响应左键,其他一概不响应,因此右键点击按钮不算使用它(没有 OnPressed、OnReleased 或 OnClicked),而是继续传递给其后面的东西。 |
FaceNode | TObjectPtr<UDreamWidget> | Button | - | 只读 | |
ContentNode | TObjectPtr<UDreamWidget> | Button | - | 只读 | 孔。空是正常状态,空的孔不占据任何尺寸——见 RealizeBuiltIn。 |
ButtonBehaviour | TObjectPtr<UUIButton> | Button | - | 只读 | |
DragSource | TObjectPtr<UDreamUIDragSource> | Button | - | 只读 | 仅在 bAllowDragDrop 开启时存在;关于它为何是被添加和销毁而非静音,请参见该属性。 |
函数
| 函数 | 类型 | 描述 |
|---|---|---|
int32 GetAcceptedMouseButtons() | 纯 | 获取接受的鼠标按键 |
bool GetAllowDragDrop() | 纯 | 获取允许拖放 |
FColor GetBackgroundColor() | 纯 | 获取背景颜色 |
EDreamUIClickMethod GetClickMethod() | 纯 | 获取点击方式 |
FLinearColor GetColorAndOpacity() | 纯 | 获取颜色与不透明度 |
UDreamUIDragSource* GetDragSource() | 纯 | 此按钮的开关放在面上的拖拽源,开关关闭时为空。 |
EDreamUIPressMethod GetPressMethod() | 纯 | 获取按下方式 |
FDreamButtonStyle GetStyle() | 纯 | 获取样式 |
EDreamUITouchMethod GetTouchMethod() | 纯 | 获取触摸方式 |
bool IsPressed() | 纯 | 当前是否有指针正按住此按钮。 |
void SetAcceptedMouseButtons(int32 InAcceptedMouseButtons) | 可调用 | 写入位掩码并立即将其推送到行为上,与那三个方式设置器一样。 |
void SetAllowDragDrop(bool bInAllowDragDrop) | 可调用 | 设置允许拖放 |
void SetBackgroundColor(FColor InBackgroundColor) | 可调用 | 设置背景颜色 |
void SetClickMethod(EDreamUIClickMethod InMethod) | 可调用 | 下面四个设置器各自写入字段并将其重新推送到行为上。 |
void SetColorAndOpacity(FLinearColor InColorAndOpacity) | 可调用 | 参见该属性:alpha 会级联到整个按钮,颜色则无处可去。 |
void SetPressMethod(EDreamUIPressMethod InMethod) | 可调用 | 设置按下方式 |
void SetStyle(FDreamButtonStyle InStyle) | 可调用 | 此实例的整个外观,被替换并推送。它是否就是实际生效的外观,仍由 StyleSource 决定——当样式表正在驱动时写入内联样式不会改变任何可见内容,这正是推送无论如何都会执行而不是假装有效的原因。 |
void SetTouchMethod(EDreamUITouchMethod InMethod) | 可调用 | 设置触摸方式 |
事件
| 事件 | 签名 | 描述 |
|---|---|---|
OnClicked | void DreamButtonClickedEvent__DelegateSignature() | 从行为重新广播,因此使用者绑定的是控件,而不是它的某个部件。 |
OnPressed | void DreamButtonClickedEvent__DelegateSignature() | UMG 按钮发声的其他四个时刻,从同一行为重新广播,理由与 OnClicked 相同:这些信号一直存在于 UUIButton 上,却止步于面,因此任何想要它们的东西——按下时的音效、悬停时的提示——都必须越过控件去触及控件所拥有的某个部件。 |
OnReleased | void DreamButtonClickedEvent__DelegateSignature() | |
OnHovered | void DreamButtonClickedEvent__DelegateSignature() | |
OnUnhovered | void DreamButtonClickedEvent__DelegateSignature() |
与 UMG 对比
UMG 类中每一个面向蓝图的成员,以及它们的去向。adopt:同名,同义。map:以另一个名字或另一种类型出现在这里。reject:有意缺失,并附理由。
| UMG | 成员 | 状态 | 此处 | 说明 |
|---|---|---|---|---|
UButton | WidgetStyle | map | Style | FDreamButtonStyle,通过 StyleSource 解析:默认使用项目样式表,在被告知时使用此实例。 |
UButton | ColorAndOpacity | adopt | ColorAndOpacity | 该控件接收 UMG 的 FLinearColor,并将其 ALPHA 用于自身的 RenderOpacity,进而级联到面板、标签以及放入其中的任何其他内容。仅在设置时应用一次,绝不在样式传递中应用:render opacity 是宿主可能也在驱动的通道,而在淡出之上写回 1 的重新样式会让样式传递撤销动画。颜色部分故意不伪造——参见 UDreamBorder::ContentColorAndOpacity;BackgroundColor 是面板的着色,这通常是调用方所指的部分。 |
UButton | BackgroundColor | adopt | BackgroundColor | 使用 FColor 而非 FLinearColor,该样式家族中的每种颜色都是如此。与面板画刷自身的着色相乘。 |
UButton | ClickMethod | adopt | ClickMethod | EDreamUIClickMethod;被推送到下方的可选控件上。 |
UButton | TouchMethod | adopt | TouchMethod | EDreamUITouchMethod。 |
UButton | PressMethod | adopt | PressMethod | EDreamUIPressMethod。 |
UButton | IsFocusable | map | UDreamWidget::bIsFocusable | 此处的每个控件都带有它,因此控件级别的副本会遮蔽基类成员,成为同一问题的第二个答案。 |
UButton | OnClicked | adopt | OnClicked | 只有 AcceptedMouseButtons 中的鼠标按钮才会按下并点击按钮——默认仅左键,这是 SButton 的规则(其 OnMouseButtonDown/Up 会检测 EKeys::LeftMouseButton 或触摸)。UMG 没有对应的开关;AcceptedMouseButtons 是此控件自己的,用于让按钮也响应另一个按钮。触摸以及手柄或键盘按下始终计入。双击是两次完整点击,与 SButton 上相同:事件系统将第二次按下作为双击传递,而按钮将双击视为一次按下(SButton::OnMouseButtonDoubleClick 将其交给 OnMouseButtonDown)。 |
UButton | OnPressed | adopt | OnPressed | 不适用于按钮不响应的鼠标按钮(参见 OnClicked),也不适用于禁用时。 |
UButton | OnReleased | adopt | OnReleased | 仅在 OnPressed 之后,因为 SButton 的 Release 以 bIsPressed 为门槛:按下对始终成对出现。 |
UButton | OnHovered | adopt | OnHovered | |
UButton | OnUnhovered | adopt | OnUnhovered | |
UButton | SetStyle | adopt | SetStyle | |
UButton | SetColorAndOpacity | map | SetColorAndOpacity | 与上面的属性同样各占一半。 |
UButton | SetBackgroundColor | adopt | SetBackgroundColor | |
UButton | IsPressed | adopt | IsPressed | 向行为体的选择状态询问,而非在控件上记忆。 |
UButton | SetClickMethod | adopt | SetClickMethod | |
UButton | SetTouchMethod | adopt | SetTouchMethod | |
UButton | SetPressMethod | adopt | SetPressMethod | |
UButton | SetAllowDragDrop | adopt | SetAllowDragDrop | 添加或销毁面板的 UDreamUIDragSource,这正是赋予此处拖拽意义的东西。 |
UButton | bAllowDragDrop | adopt | bAllowDragDrop | 关闭,与 UMG 一致。 |