OctaneGUI 开源项目安装与使用指南-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00034/article/details/137950823

OctaneGUI 开源项目安装与使用指南

OctaneGUI OctaneGUI is a renderer agnostic multi-window multi-platform UI library for C++. 项目地址: https://gitcode.com/gh_mirrors/oc/OctaneGUI

项目概述

OctaneGUI 是一个针对 C++ 设计的渲染器中立的多窗口跨平台用户界面库。其核心目标是简化高性能应用程序的创建过程，并且能够容易地集成到具有自定义渲染流水线的其他框架之中。支持多种窗口系统（如 SDL2, SFML）和渲染技术（如 OpenGL, Metal），并通过事件驱动的UI系统来实现交互。

1. 目录结构及介绍

以下是 OctaneGUI 项目的主要目录结构及其简介：

Source/OctaneGUI: 核心UI库的源代码所在地。
Apps: 包含示例应用和前端演示程序的目录。
Frontends: 特定于平台或框架的前端实现集合。
Scripts: 脚本文件夹，用于自动化构建、编译等任务。
CMakeLists.txt: CMake构建系统的主配置文件。
LICENSE: 许可证文件，OctaneGUI遵循MIT协议。
README.md: 项目的主要说明文档。

2. 启动文件介绍

OctaneGUI的应用通常不直接有一个单一的启动文件，而是通过CMake构建系统生成对应的可执行文件。不过，对于开发者来说，理解和修改Apps目录下的示例是个好起点。例如，一个简单的应用入口点可能在某个示例应用的.cpp文件中，它负责初始化OctaneGUI库和加载UI定义。

下面是一个简化的启动流程概念示例：

#include "Interface.h"
#include "OctaneGUI/OctaneGUI.h"

int main(int argc, char** argv) {
    // 初始化OctaneGUI库并设置界面JSON定义
    const char* stream = R"(...JSON字符串省略...)";
    OctaneGUI::Application app;
    Interface::Initialize(app);
    std::unordered_map<std::string, OctaneGUI::ControlList> windowControls;
    app.Initialize(stream, windowControls);

    // 注册控制事件
    // 示例中省略了更多注册事件的细节

    // 运行应用
    return app.Run();
}

实际启动逻辑会在CMake构建后由生成的可执行文件处理。

3. 配置文件介绍

OctaneGUI主要依赖于JSON格式的配置文件来定义UI布局和行为。这些配置并非独立的“配置文件”，而是作为字符串嵌入在应用程序源码中或者从外部文件加载。例如，上述代码片段中的Stream变量就包含了UI布局的JSON数据。该JSON数据定义了主题、窗口属性以及其中的控件（如按钮）。

JSON配置示例

{
    "Theme": "/Themes/Dark.json",
    "Windows": [
        {
            "Title": "Hello",
            "Width": 300,
            "Height": 200,
            "Body": {
                "Controls": [
                    {
                        "ID": "Container",
                        "Type": "VerticalContainer",
                        "Controls": [
                            {
                                "ID": "Button",
                                "Type": "TextButton",
                                "Text": {"Text": "Hello Friends"}
                            }
                        ]
                    }
                ]
            }
        }
    ]
}

此JSON定义了一个基本的窗口，包含一个带有文本“Hello Friends”的按钮。开发者可以通过C++代码注册按钮的点击事件。

开发过程中，还需关注CMakeLists.txt文件来正确设置构建选项，并可能根据需要调整Scripts目录中的脚本来适应特定的构建需求。确保遵循项目文档中的说明进行编译和配置。

OctaneGUI OctaneGUI is a renderer agnostic multi-window multi-platform UI library for C++. 项目地址: https://gitcode.com/gh_mirrors/oc/OctaneGUI