UDreamMenuAnchor
UDreamMenuAnchor
继承自 UDreamUIControl。
声明于 Public/Controls/DreamMenuAnchor.h。
菜单弹出的位置,也是把它收回去的东西。
DreamGUI 风格中的 UMG MenuAnchor。菜单是 UDreamUIPopupLayer 的按玩家堆栈上的弹出层,正如下拉框的列表那样:被提升到屏幕根节点,这样没有任何祖先会裁剪它或把它计入自己的布局;由任意其他位置的按下(bCloseOnClickOutside)、Back 键、以及此锚点消失或离开视野来关闭;而从已打开菜单内部打开的菜单是它的子级,会随它一起关闭。进入菜单的焦点会返回到菜单打开时持有焦点的东西。在其他位置按下会关闭菜单,然后该按下会继续传递给它落到的对象,正如 Slate 的菜单堆栈所允许的那样,除非项目的 UDreamGUISettings::bMenusConsumeOutsideClick 将其保留。
两种说明菜单是什么的方式,二者互斥:
- 填充
Menu槽位——.dui 中的Native.MenuAnchor { ... },或设计器拖放——内容就地编写,这正是小型菜单想要的; - 或者设置 MenuClass,菜单第一次打开时会创建它的一个实例并保留下来,这正是多个锚点共享的菜单想要的。实例化用户控件需要一个 world,因此没有 world 时它会静默地保持为一个空菜单,而不是半个菜单。
两者都设置时,槽位优先:有人放进去的内容就是他们想要看到的内容。
它打开的位置是 FDreamMenuAnchorStyle::Placement,这是有意作为样式而不是控件属性——项目希望其中的每个菜单都以相同方式打开,而覆盖位仍然允许单个实例持不同意见。
尺寸是声明的,不是测量的。MenuSize 是一个编写好的数字,原因与下拉框的列表高度相同:弹出层在屏幕上之前不会被任何人排列,因此测量它意味着先让它不可见地打开一帧。内容自己声明了尺寸的菜单可以在该轴上将 MenuSize 留为零来表明这一点,这会把该轴交还给内容。
属性
| 名称 | 类型 | 类别 | 在细节面板中 | 可从蓝图 | 描述 |
|---|---|---|---|---|---|
Style | FDreamMenuAnchorStyle | Menu Anchor | 是 | GetStyle / SetStyle | 此实例自身的外观。当 StyleSource 如此声明且确实存在样式表时,项目样式表优先;项目中没有任何样式表时,这就是生效的外观。 |
MenuClass | TSubclassOf<UDreamUserWidget> | Menu Anchor | 是 | GetMenuClass / SetMenuClass | 菜单的类,适用于菜单不就地编写的锚点。 |
MenuSize | FVector2D | Menu Anchor | 是 | GetMenuSize / SetMenuSize | 菜单打开时的大小。某个轴为零表示该轴交由内部内容决定。 |
bCloseOnClickOutside | bool | Menu Anchor | 是 | GetCloseOnClickOutside / SetCloseOnClickOutside | 在其他任意位置按下是否关闭菜单。关闭后该职责交由调用方。该按下会继续传递给它落到的对象,正如 Slate 的菜单堆栈所允许的那样,除非项目的 UDreamGUISettings::bMenusConsumeOutsideClick 将其保留。 |
bFitInWindow | bool | Menu Anchor | 是 | GetFitInWindow / FitInWindow | 保持打开的菜单位于屏幕之内——UMG 的 bFitInWindow,与此锚点的面板版本使用的算术相同(调用 UDreamLayoutContainerMenuAnchor::FitMenuInWindow,而不是复制它,因此无论哪条路径打开菜单,菜单都会落在同一位置)。 |
OnGetUserMenuContentEvent | FDreamMenuAnchorGetContent | Menu Anchor | - | 读 / 写 | 首次需要时构建菜单的内容,而不是使用 MenuClass。 |
PopupNode | TObjectPtr<UDreamWidget> | Menu Anchor | - | 只读 | 弹出层根节点:被提升到屏幕、定位并淡入淡出的东西。 |
MenuNode | TObjectPtr<UDreamWidget> | Menu Anchor | - | 只读 | 它内部的孔洞。宿主嵌套在此控件上的任何内容最终都会到这里。 |
MenuInstance | TObjectPtr<UDreamUserWidget> | Menu Anchor | - | 只读 | MenuClass 产生的实例,或者当槽位已填充或没有 world 时为 null。 |
ProvidedMenuContent | TObjectPtr<UDreamWidget> | Menu Anchor | - | 只读 | OnGetUserMenuContentEvent 交出的内容,被保留下来,以便该处理器只被询问一次。 |
函数
| 函数 | 类型 | 描述 |
|---|---|---|
void Close() | 可调用 | 把它从屏幕上取下并送回原处:先关闭从它内部打开的任何菜单,然后把进入它的每个玩家的焦点送回菜单打开时焦点所在的位置——除非玩家在此期间已将其移动到别处。已经关闭时为无操作。 |
void FitInWindow(bool bInFitInWindow) | 可调用 | 按 UMG 对该调用的命名。立即重新放置已打开的菜单。 |
bool GetCloseOnClickOutside() | 纯函数 | Get Close on Click Outside |
bool GetFitInWindow() | 纯函数 | Get Fit in Window |
TSubclassOf<UDreamUserWidget> GetMenuClass() | 纯函数 | Get Menu Class |
FVector2D GetMenuPosition() | 纯函数 | 菜单的位置,在此锚点自身的本地空间中——UMG 的 GetMenuPosition。 |
FVector2D GetMenuSize() | 纯函数 | Get Menu Size |
EDreamMenuPlacement GetPlacement() | 纯函数 | 菜单相对于此锚点打开的位置——UMG 的 Placement,从生效的样式而不是旁边的字段读取,因此由项目样式表驱动的锚点会给出它实际使用的位置。 |
FDreamMenuAnchorStyle GetStyle() | 纯函数 | Get Style |
bool HasOpenSubMenus() | 纯函数 | 此菜单内部的任何东西是否有它自己的菜单打开——UMG 的 HasOpenSubMenus。 |
bool IsOpen() | 纯函数 | Is Open |
void Open(bool bFocusMenu) | 可调用 | 把菜单放到屏幕上,由样式定位。已经打开时为无操作。 |
void SetCloseOnClickOutside(bool bInCloseOnClickOutside) | 可调用 | 决定菜单打开时在其他位置点击会做什么,而不仅仅是下一次打开会做什么——一个只在第二次显示时才开始在外部点击时关闭的菜单,看起来会像一个似乎不起作用的开关。 |
void SetMenuClass(TSubclassOf<UDreamUserWidget> InMenuClass) | 可调用 | 此锚点打开哪个菜单。实例在首次打开时构建并保留,因此之后更改类会丢弃旧实例,而不是让锚点永远打开之前的菜单。菜单打开期间更改会先关闭它:替换玩家正在阅读的菜单的内容不是它能悄悄做到的事。 |
void SetMenuSize(FVector2D InMenuSize) | 可调用 | 立即重新放置已打开的菜单,这样新尺寸就不会只在下次打开时才显现。 |
void SetPlacement(EDreamMenuPlacement InPlacement) | 可调用 | 编辑此实例的样式并立即重新放置已打开的菜单。参见 UDreamBorder::SetPadding。 |
void SetStyle(FDreamMenuAnchorStyle InStyle) | 可调用 | 此实例的整个外观,被替换并推送。注意事项参见 UDreamButton::SetStyle。 |
bool ShouldOpenDueToClick() | 纯函数 | 在锚点上的点击是否应打开菜单——UMG 的 ShouldOpenDueToClick,也是包装锚点的按钮在调用 Open 之前必须问的问题:菜单已经弹出时落下的点击正是将其关闭的那次点击,再次打开会让菜单无法通过点击打开它的东西来关闭。 |
void ToggleOpen(bool bFocusOnOpen) | 可调用 | Toggle Open |
事件
| 事件 | 签名 | 描述 |
|---|---|---|
OnMenuOpenChanged | void DreamMenuAnchorOpenChangedEvent__DelegateSignature(bool bIsOpen) | 打开和关闭,由锚点宣布。在动作之后触发,绝不在动作期间触发。在 Open 返回之前又关闭的打开——移入菜单的焦点运行了一个关闭它的处理器——两者都不会宣布。 |
与 UMG 对比
UMG 类中所有面向蓝图的成员,以及它们去了哪里。adopt:相同名称,相同含义。map:在此处以另一名称或另一类型存在。reject:有意缺席,并给出原因。
| UMG | 成员 | 状态 | 此处 | 说明 |
|---|---|---|---|---|
UMenuAnchor | MenuClass | adopt | MenuClass | TSubclassOf。更改它会丢弃已保留的实例,并先关闭已打开的菜单。 |
UMenuAnchor | OnGetMenuContentEvent | reject | 在 UMG 4.26 中已弃用,改用 OnGetUserMenuContentEvent,即下面的那个。 | |
UMenuAnchor | OnGetUserMenuContentEvent | adopt | OnGetUserMenuContentEvent | 单播,返回 UDreamWidget*。只在尚无菜单且槽位中没有编写任何内容时询问一次,并且保留其返回的内容——每次打开都重建会丢弃玩家在菜单中留下的任何状态,并泄漏上一个菜单。优先级低于编写的内容,高于 MenuClass;如果处理程序没有返回任何内容,则让类有机会处理。 |
UMenuAnchor | Placement | map | FDreamMenuAnchorStyle::Placement | 放在样式中,因为项目希望每个菜单都以相同方式打开;枚举是 EDreamMenuPlacement,与 UDreamLayoutContainerMenuAnchor 共享,以便两条路径以相同方式放置菜单。GetPlacement 返回解析后的值。 |
UMenuAnchor | bFitInWindow | adopt | bFitInWindow | 针对根控件进行钳制,根控件是整个层级布局所在的矩形,也是此处最接近 Slate 窗口的东西。UDreamLayoutContainerMenuAnchor::FitMenuInWindow 是被调用而非复制,因此无论由两个锚点中的哪一个打开,菜单都会落在同一位置。默认关闭,而 UMG 和面板的对应项默认开启:为每个现有锚点开启钳制会移动有人特意定位的菜单。 |
UMenuAnchor | ShouldDeferPaintingAfterWindowContent | reject | Slate 将菜单绘制到窗口的延迟层中,使其绘制在所有内容之上。此处没有 Slate 窗口:菜单被提升到弹出层(UDreamUIPopupLayer),这就是同一问题的答案。 | |
UMenuAnchor | UseApplicationMenuStack | map | UDreamLayoutContainerMenuAnchor::bUseApplicationMenuStack | 此处应用程序的菜单栈是弹出层上每个玩家的栈(UDreamUIPopupLayer::Push):菜单在打开时被提升到玩家的屏幕根节点上,位于所有内容之上且不被任何内容裁剪,通过点击其外部、Back 或其锚点消失来关闭,并且它会跟随锚点。此控件始终在那里打开其菜单。面板的写法具有 UMG 的开关,默认关闭,而 UMG 的默认开启,因此在它存在之前保存的锚点会继续原地绘制其菜单。 |
UMenuAnchor | ShowMenuBackground | reject | 应用程序菜单栈是否在菜单后面绘制自己的背景。没有栈,就没有自己的背景——菜单的外观是 FDreamMenuAnchorStyle::Background。 | |
UMenuAnchor | OnMenuOpenChanged | adopt | OnMenuOpenChanged | 在移动之后触发,绝不在移动期间触发。 |
UMenuAnchor | SetPlacement | adopt | SetPlacement | 编辑此实例的样式,并立即重新放置已打开的菜单。 |
UMenuAnchor | FitInWindow | adopt | FitInWindow | 命名与 UMG 对该调用的命名一致;立即重新放置已打开的菜单。 |
UMenuAnchor | ToggleOpen | adopt | ToggleOpen | 将 UMG 的 bFocusOnOpen 传递到 Open。 |
UMenuAnchor | Open | adopt | Open | bFocusMenu 将焦点给予菜单内第一个可导航的事物(UUISelectable::FindDefaultSelectableIn,然后是事件系统的默认选择)——与 UDreamTabView::FocusActivePage 相同的调用和相同的规则,包括当菜单中没有任何可导航内容时不改变焦点。该参数有默认值且位于最后,因此每个现有的 Open() 仍然表示它原来的含义。 |
UMenuAnchor | Close | adopt | Close | |
UMenuAnchor | IsOpen | adopt | IsOpen | |
UMenuAnchor | ShouldOpenDueToClick | adopt | ShouldOpenDueToClick | 包装锚点的按钮在调用 Open 之前询问的问题,这样关闭菜单的那次点击不会重新打开它。 |
UMenuAnchor | GetMenuPosition | adopt | GetMenuPosition | 弹出层在此锚点本地空间中的锚定位置;弹出层在被提升之前先相对于锚点放置,因此无论哪种方式该数值都成立。 |
UMenuAnchor | HasOpenSubMenus | adopt | HasOpenSubMenus | 遍历弹出层的子树(UDreamWidget::CollectChildrenWidgets)以查找此类的另一个已打开锚点,因为这里子菜单就是这样——没有应用程序范围的菜单栈可供查询。 |
UMenuAnchor | SetStyle | adopt | SetStyle | UMenuAnchor 没有样式结构体;这是该系列在运行时替换外观的写法。 |