UnrealImGuiTools 使用教程

UnrealImGuiTools 使用教程

UnrealImGuiTools A set of tools and utilities for use with Unreal Engine projects using ImGui. 项目地址: https://gitcode.com/gh_mirrors/un/UnrealImGuiTools

1. 项目介绍

UnrealImGuiTools 是一个为使用 ImGui 的 Unreal Engine 项目提供工具和实用程序的插件。该插件包含了一系列工具，旨在帮助开发者更快速、更轻松地编写游戏特定的工具窗口。插件本身不包含 ImGui，但依赖于 segross 的 UnrealImGui 插件。所有相关项目均基于 MIT 许可证发布。

主要功能

• ImGui 工具集成：提供了一个框架，使得编写自定义 ImGui 工具窗口更加便捷。
• 编辑器按钮菜单：在 Unreal Engine 编辑器的主工具栏中添加了一个按钮菜单，用于交互 ImGui 工具和插件。
• CVars 支持：在编辑器外（如独立构建）通过 CVars 与插件进行交互。
• 内存调试器：提供详细的内存信息，补充现有的内存调试工具。
• 加载调试器：跟踪同步和异步类加载，帮助消除加载卡顿。
• Actor 组件调试器：用于探索、分析和调试 AActors 和 UActorComponents。

2. 项目快速启动

2.1 安装

1. 克隆仓库：

   git clone https://github.com/nakdeyes/UnrealImGuiTools.git
   

2. 添加到 Unreal Engine 项目： 将克隆的仓库中的 UnrealImGuiTools 文件夹复制到你的 Unreal Engine 项目的 Plugins 目录下。

3. 启用插件： 打开 Unreal Engine 编辑器，导航到 编辑器首选项 -> 插件，找到 UnrealImGuiTools 插件并启用它。

2.2 使用示例

以下是一个简单的示例，展示如何在游戏中创建一个自定义的 ImGui 工具窗口。

#include "ImGuiToolsModule.h"
#include "ImGuiModule.h"

void FMyCustomTool::DrawImGuiWindow()
{
    if (ImGui::Begin("My Custom Tool"))
    {
        ImGui::Text("Hello from My Custom Tool!");
    }
    ImGui::End();
}

void FMyCustomTool::RegisterTool()
{
    FImGuiToolsModule::Get().RegisterTool("MyCustomTool", this, &FMyCustomTool::DrawImGuiWindow);
}

void FMyCustomTool::UnregisterTool()
{
    FImGuiToolsModule::Get().UnregisterTool("MyCustomTool");
}

2.3 配置 CVars

在独立构建中，可以通过 CVars 控制插件的行为。例如：

imgui.tools.enabled true
imgui.tools.toggle_tool_vis MyCustomTool

3. 应用案例和最佳实践

3.1 内存调试

在开发过程中，内存管理是一个重要的环节。使用 Memory Debugger 工具可以实时查看内存使用情况，帮助开发者识别和解决内存泄漏问题。

3.2 加载调试

加载调试器可以帮助开发者跟踪和优化游戏中的同步加载操作，减少卡顿现象。通过记录和分析加载事件，可以找到并消除不必要的同步加载。

3.3 Actor 组件调试

在调试复杂的 Actor 和组件时，Actor Component Debugger 提供了一个直观的界面，帮助开发者快速定位问题。

4. 典型生态项目

4.1 UnrealImGui

UnrealImGui 是 UnrealImGuiTools 的主要依赖插件，提供了在 Unreal Engine 中集成 ImGui 的基础支持。

4.2 Dear ImGui

Dear ImGui 是一个即时模式的图形用户界面库，广泛用于游戏开发和实时应用程序中。UnrealImGuiTools 利用 Dear ImGui 提供的强大功能，为 Unreal Engine 项目提供了丰富的工具和实用程序。

通过这些工具和插件的结合，开发者可以更高效地进行 Unreal Engine 项目的开发和调试。

UnrealImGuiTools A set of tools and utilities for use with Unreal Engine projects using ImGui. 项目地址: https://gitcode.com/gh_mirrors/un/UnrealImGuiTools