Immediate Mode GUI (ImGui) Gem

即时模式 GUI （ImGui） Gem 提供第三方库 Dear ImGui ，该库可用于创建运行时即时模式菜单和覆盖层，以便在 Open 3D Engine （O3DE） 中调试和分析信息。您可以使用它来访问现有的 O3DE 工具，或为您的组件或其他游戏代码设置您自己的 ImGui 菜单。

ImGui 的一大优点是，当 ImGui 游戏覆盖层不可见时，几乎没有开销，这是默认状态。它在使用时也非常轻便。

访问 ImGui 菜单

在宿主平台上: 可以通过在编辑器、游戏或服务器启动器中按~键或home键来访问 ImGui。

在移动平台上: 在部署到设备之前，编辑相应平台的系统配置（例如 Android = system_android_android.cfg）以包含 imgui_EnableImGui=1

在编辑器上: 通过 Console variable （控制台变量） 窗口将imgui_EnableImGui变量设置为 1

如果渲染处于活动状态，则服务器启动器支持 ImGui。ImGui 要求 ‘rhi’ cvar 不能为 null。

您可以使用键盘、鼠标或控制器来浏览 ImGui 菜单。

键盘导航

对于键盘，使用箭头键导航菜单，使用 空格键 激活或选择一个选项。

游戏控制器导航

您可以使用 imgui_EnableController CVAR 来启用游戏控制器输入支持，或使用imgui_EnableControllerMouse CVAR 来模拟带有游戏控制器的鼠标输入。

使用游戏控制器时，支持以下输入：

使用游戏控制器模拟鼠标输入时，支持以下输入：

您可以使用“imgui_ControllerMouseSensitivity”调整灵敏度。

离散输入模式

当 ImGui 可见时，输入将同时发送到 ImGui 和 O3DE 游戏/编辑器。有时，在任何给定时间只控制 ImGui 或游戏/编辑器是更可取的。为了实现这一点，ImGui Gem 支持离散输入模式。

默认情况下，discrete input 模式处于关闭状态。它可以在 ImGui O3DE 菜单中打开，也可以使用 CVAR imgui_DiscreteInputMode.

启用此模式后，ImGui 将获得第 2 种可见性状态，此时，当通过游戏控制器上的 HOME 按钮或 L3/R3 切换 ImGui 可见性时，它将在三种状态之间切换，而不仅仅是打开和关闭。

1. ImGui 已关闭 - ImGui 不可见。
2. 所有输入都转到 ImGui - ImGui 可见并接收所有输入。
3. 所有输入都转到游戏 - ImGui 可见，但输入将转到游戏。这允许 ImGui 分析工具和其他工具在与 O3DE 交互时在屏幕上可见。

您可以查看 ImGui 主菜单栏的右上角，以查看 ImGui 输入的当前状态。您还可以与此菜单交互以获取一些输入提示。

在组件中使用 ImGui

您将需要：

1. 确保 ImGui Gem 在您的项目中处于活动状态。请参阅 O3DE 指南 在项目中添加 Gem .
2. 注册 ImGui::ImGuiUpdateListenerBus::Handler 或使用ImGuiLYCommonMenu类作为基础。
3. 在处理程序中执行 ImGui 操作。

        void MyImGuiComponent::OnImGuiUpdate()
        {
            // .. do imgui stuff ...
        }

O3DE ImGui 工具示例

O3DE 附带了许多 ImGui 工具，因此您看到的选项将取决于项目中活动的特定 Gem。

• 调试 PhysX
• 多人游戏助手

CVARs

ImGui 在运行时通过控制台或将它们放置在配置中使用以下控制台变量 （CVAR）。有关配置 CVAR 的更多信息，请参阅通用 CVAR 指南 。