feat(示例): 添加自定义模块示例和文档
新增HelloModule示例展示如何创建自定义模块，包含： 1. 模块配置类实现 2. 模块初始化器实现 3. 自动注册机制 4. JSON配置支持 5. 场景中使用模块的示例 同时更新模块系统文档，详细说明自定义模块开发流程
This commit is contained in:
parent
867013f6eb
commit
b55d279611
|
|
@ -1,5 +1,6 @@
|
|||
#pragma once
|
||||
|
||||
#include <array>
|
||||
#include <extra2d/core/color.h>
|
||||
#include <extra2d/core/math_types.h>
|
||||
#include <extra2d/core/types.h>
|
||||
|
|
@ -7,7 +8,6 @@
|
|||
#include <extra2d/graphics/texture.h>
|
||||
#include <glm/mat4x4.hpp>
|
||||
#include <vector>
|
||||
#include <array>
|
||||
|
||||
#include <glad/glad.h>
|
||||
|
||||
|
|
@ -52,7 +52,8 @@ public:
|
|||
void end();
|
||||
|
||||
// 批量绘制接口 - 用于自动批处理
|
||||
void drawBatch(const Texture& texture, const std::vector<SpriteData>& sprites);
|
||||
void drawBatch(const Texture &texture,
|
||||
const std::vector<SpriteData> &sprites);
|
||||
|
||||
// 立即绘制（不缓存）
|
||||
void drawImmediate(const Texture &texture, const SpriteData &data);
|
||||
|
|
|
|||
|
|
@ -1,17 +1,18 @@
|
|||
#include <extra2d/app/application.h>
|
||||
#include <extra2d/config/config_module.h>
|
||||
#include <extra2d/config/module_registry.h>
|
||||
#include <extra2d/graphics/render_module.h>
|
||||
#include <extra2d/graphics/render_config.h>
|
||||
#include <extra2d/graphics/render_module.h>
|
||||
#include <extra2d/graphics/vram_manager.h>
|
||||
#include <extra2d/platform/iinput.h>
|
||||
#include <extra2d/platform/input_module.h>
|
||||
#include <extra2d/platform/platform_init_module.h>
|
||||
#include <extra2d/platform/window_module.h>
|
||||
#include <extra2d/services/camera_service.h>
|
||||
#include <extra2d/services/event_service.h>
|
||||
#include <extra2d/services/scene_service.h>
|
||||
#include <extra2d/services/timer_service.h>
|
||||
#include <extra2d/services/event_service.h>
|
||||
#include <extra2d/services/camera_service.h>
|
||||
|
||||
|
||||
#include <chrono>
|
||||
#include <thread>
|
||||
|
|
@ -37,10 +38,6 @@ Application& Application::get() {
|
|||
return instance;
|
||||
}
|
||||
|
||||
Application::~Application() {
|
||||
shutdown();
|
||||
}
|
||||
|
||||
bool Application::init() {
|
||||
AppConfig cfg;
|
||||
return init(cfg);
|
||||
|
|
@ -57,7 +54,8 @@ bool Application::init(const AppConfig& config) {
|
|||
register_input_module();
|
||||
register_render_module();
|
||||
|
||||
auto* configInit = ModuleRegistry::instance().getInitializer(get_config_module_id());
|
||||
auto *configInit =
|
||||
ModuleRegistry::instance().getInitializer(get_config_module_id());
|
||||
if (configInit) {
|
||||
auto *cfgInit = dynamic_cast<ConfigModuleInitializer *>(configInit);
|
||||
if (cfgInit) {
|
||||
|
|
@ -79,7 +77,8 @@ bool Application::init(const std::string& configPath) {
|
|||
register_input_module();
|
||||
register_render_module();
|
||||
|
||||
auto* configInit = ModuleRegistry::instance().getInitializer(get_config_module_id());
|
||||
auto *configInit =
|
||||
ModuleRegistry::instance().getInitializer(get_config_module_id());
|
||||
if (configInit) {
|
||||
auto *cfgInit = dynamic_cast<ConfigModuleInitializer *>(configInit);
|
||||
if (cfgInit) {
|
||||
|
|
@ -151,7 +150,8 @@ bool Application::initModules() {
|
|||
}
|
||||
}
|
||||
|
||||
auto* windowInit = ModuleRegistry::instance().getInitializer(get_window_module_id());
|
||||
auto *windowInit =
|
||||
ModuleRegistry::instance().getInitializer(get_window_module_id());
|
||||
if (!windowInit || !windowInit->isInitialized()) {
|
||||
return false;
|
||||
}
|
||||
|
|
@ -166,13 +166,15 @@ bool Application::initModules() {
|
|||
return false;
|
||||
}
|
||||
|
||||
auto* renderInit = ModuleRegistry::instance().getInitializer(get_render_module_id());
|
||||
auto *renderInit =
|
||||
ModuleRegistry::instance().getInitializer(get_render_module_id());
|
||||
if (renderInit) {
|
||||
auto *renderModule = dynamic_cast<RenderModuleInitializer *>(renderInit);
|
||||
if (renderModule) {
|
||||
renderModule->setWindow(window_);
|
||||
|
||||
auto* renderConfig = ModuleRegistry::instance().getModuleConfig(get_render_module_id());
|
||||
auto *renderConfig =
|
||||
ModuleRegistry::instance().getModuleConfig(get_render_module_id());
|
||||
if (renderConfig && !renderInit->initialize(renderConfig)) {
|
||||
return false;
|
||||
}
|
||||
|
|
@ -187,11 +189,12 @@ bool Application::initModules() {
|
|||
|
||||
auto cameraService = ServiceLocator::instance().getService<ICameraService>();
|
||||
if (cameraService && window_) {
|
||||
window_->onResize([this, cameraService](int width, int height) {
|
||||
window_->onResize([cameraService](int width, int height) {
|
||||
cameraService->updateViewport(width, height);
|
||||
cameraService->applyViewportAdapter();
|
||||
|
||||
auto sceneService = ServiceLocator::instance().getService<ISceneService>();
|
||||
auto sceneService =
|
||||
ServiceLocator::instance().getService<ISceneService>();
|
||||
if (sceneService) {
|
||||
auto currentScene = sceneService->getCurrentScene();
|
||||
if (currentScene) {
|
||||
|
|
@ -232,6 +235,12 @@ void Application::shutdown() {
|
|||
running_ = false;
|
||||
}
|
||||
|
||||
Application::~Application() {
|
||||
if (initialized_) {
|
||||
shutdown();
|
||||
}
|
||||
}
|
||||
|
||||
void Application::run() {
|
||||
if (!initialized_) {
|
||||
return;
|
||||
|
|
@ -294,10 +303,13 @@ void Application::mainLoop() {
|
|||
|
||||
const auto &appConfig = ConfigManager::instance().appConfig();
|
||||
|
||||
auto* renderConfig = ModuleRegistry::instance().getModuleConfig(get_render_module_id());
|
||||
auto* renderModuleConfig = dynamic_cast<const RenderModuleConfig*>(renderConfig);
|
||||
auto *renderConfig =
|
||||
ModuleRegistry::instance().getModuleConfig(get_render_module_id());
|
||||
auto *renderModuleConfig =
|
||||
dynamic_cast<const RenderModuleConfig *>(renderConfig);
|
||||
|
||||
if (renderModuleConfig && !renderModuleConfig->vsync && renderModuleConfig->targetFPS > 0) {
|
||||
if (renderModuleConfig && !renderModuleConfig->vsync &&
|
||||
renderModuleConfig->targetFPS > 0) {
|
||||
double frameEndTime = getTimeSeconds();
|
||||
double frameTime = frameEndTime - currentTime;
|
||||
double target = 1.0 / static_cast<double>(renderModuleConfig->targetFPS);
|
||||
|
|
@ -310,12 +322,11 @@ void Application::mainLoop() {
|
|||
ConfigManager::instance().update(deltaTime_);
|
||||
}
|
||||
|
||||
void Application::update() {
|
||||
ServiceLocator::instance().updateAll(deltaTime_);
|
||||
}
|
||||
void Application::update() { ServiceLocator::instance().updateAll(deltaTime_); }
|
||||
|
||||
void Application::render() {
|
||||
auto* renderInit = ModuleRegistry::instance().getInitializer(get_render_module_id());
|
||||
auto *renderInit =
|
||||
ModuleRegistry::instance().getInitializer(get_render_module_id());
|
||||
RenderBackend *renderer = nullptr;
|
||||
if (renderInit) {
|
||||
auto *renderModule = dynamic_cast<RenderModuleInitializer *>(renderInit);
|
||||
|
|
@ -348,12 +359,11 @@ void Application::render() {
|
|||
window_->swap();
|
||||
}
|
||||
|
||||
IInput& Application::input() {
|
||||
return *window_->input();
|
||||
}
|
||||
IInput &Application::input() { return *window_->input(); }
|
||||
|
||||
RenderBackend &Application::renderer() {
|
||||
auto* renderInit = ModuleRegistry::instance().getInitializer(get_render_module_id());
|
||||
auto *renderInit =
|
||||
ModuleRegistry::instance().getInitializer(get_render_module_id());
|
||||
if (renderInit) {
|
||||
auto *renderModule = dynamic_cast<RenderModuleInitializer *>(renderInit);
|
||||
if (renderModule && renderModule->getRenderer()) {
|
||||
|
|
@ -392,12 +402,10 @@ void Application::enterScene(Ptr<Scene> scene) {
|
|||
}
|
||||
}
|
||||
|
||||
ConfigManager& Application::config() {
|
||||
return ConfigManager::instance();
|
||||
}
|
||||
ConfigManager &Application::config() { return ConfigManager::instance(); }
|
||||
|
||||
const AppConfig &Application::getConfig() const {
|
||||
return ConfigManager::instance().appConfig();
|
||||
}
|
||||
|
||||
}
|
||||
} // namespace extra2d
|
||||
|
|
|
|||
|
|
@ -966,9 +966,222 @@ window_->onResize([this, cameraService](int width, int height) {
|
|||
## 示例
|
||||
|
||||
完整示例请参考：
|
||||
- [examples/hello_module/](../../examples/hello_module/) - **Hello World 自定义模块示例**
|
||||
- [examples/basic/main.cpp](../../examples/basic/main.cpp) - 基础示例（场景图、输入事件、视口适配）
|
||||
- [Extra2D/src/platform/window_module.cpp](../../Extra2D/src/platform/window_module.cpp) - Window 模块实现
|
||||
- [Extra2D/src/platform/input_module.cpp](../../Extra2D/src/platform/input_module.cpp) - Input 模块实现
|
||||
- [Extra2D/src/graphics/render_module.cpp](../../Extra2D/src/graphics/render_module.cpp) - Render 模块实现
|
||||
- [Extra2D/src/scene/node.cpp](../../Extra2D/src/scene/node.cpp) - Node 实现
|
||||
- [Extra2D/src/scene/shape_node.cpp](../../Extra2D/src/scene/shape_node.cpp) - ShapeNode 实现
|
||||
|
||||
---
|
||||
|
||||
## Hello World 自定义模块示例
|
||||
|
||||
### 示例概述
|
||||
|
||||
`examples/hello_module/` 目录包含一个完整的自定义模块示例，展示如何：
|
||||
|
||||
1. 定义模块配置数据结构
|
||||
2. 实现 `IModuleConfig` 接口
|
||||
3. 实现 `IModuleInitializer` 接口
|
||||
4. 使用自动注册机制
|
||||
5. 支持 JSON 配置
|
||||
|
||||
### 文件结构
|
||||
|
||||
```
|
||||
examples/hello_module/
|
||||
├── hello_module.h # 模块头文件（配置类 + 初始化器类）
|
||||
├── hello_module.cpp # 模块实现
|
||||
├── main.cpp # 示例入口
|
||||
└── config.json # 配置文件示例
|
||||
```
|
||||
|
||||
### 核心代码解析
|
||||
|
||||
#### 1. 配置数据结构
|
||||
|
||||
```cpp
|
||||
struct HelloModuleConfigData {
|
||||
std::string greeting = "Hello, Extra2D!";
|
||||
int repeatCount = 1;
|
||||
bool enableLogging = true;
|
||||
};
|
||||
```
|
||||
|
||||
#### 2. 配置类实现
|
||||
|
||||
```cpp
|
||||
class HelloModuleConfig : public IModuleConfig {
|
||||
public:
|
||||
HelloModuleConfigData config;
|
||||
|
||||
ModuleInfo getModuleInfo() const override {
|
||||
ModuleInfo info;
|
||||
info.name = "HelloModule";
|
||||
info.version = "1.0.0";
|
||||
info.priority = ModulePriority::User; // 用户自定义模块
|
||||
return info;
|
||||
}
|
||||
|
||||
std::string getConfigSectionName() const override {
|
||||
return "hello"; // 对应 config.json 中的 "hello" 节
|
||||
}
|
||||
|
||||
bool validate() const override {
|
||||
return !config.greeting.empty() && config.repeatCount > 0;
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
#### 3. 初始化器实现
|
||||
|
||||
```cpp
|
||||
class HelloModuleInitializer : public IModuleInitializer {
|
||||
public:
|
||||
bool initialize(const IModuleConfig* config) override {
|
||||
const HelloModuleConfig* cfg = dynamic_cast<const HelloModuleConfig*>(config);
|
||||
if (!cfg || !cfg->validate()) {
|
||||
return false;
|
||||
}
|
||||
|
||||
config_ = cfg->config;
|
||||
initialized_ = true;
|
||||
|
||||
// 执行模块初始化逻辑
|
||||
E2D_LOG_INFO("HelloModule initialized: {}", config_.greeting);
|
||||
return true;
|
||||
}
|
||||
|
||||
void shutdown() override {
|
||||
E2D_LOG_INFO("HelloModule shutdown");
|
||||
initialized_ = false;
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
#### 4. 自动注册机制
|
||||
|
||||
```cpp
|
||||
namespace {
|
||||
struct HelloModuleAutoRegister {
|
||||
HelloModuleAutoRegister() {
|
||||
register_hello_module();
|
||||
}
|
||||
};
|
||||
|
||||
static HelloModuleAutoRegister s_autoRegister; // 程序启动时自动执行
|
||||
}
|
||||
```
|
||||
|
||||
### 配置文件示例
|
||||
|
||||
```json
|
||||
{
|
||||
"hello": {
|
||||
"greeting": "Hello from custom module!",
|
||||
"repeatCount": 3,
|
||||
"enableLogging": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 运行示例
|
||||
|
||||
```bash
|
||||
xmake run demo_hello_module
|
||||
```
|
||||
|
||||
### 预期输出
|
||||
|
||||
```
|
||||
[INFO] HelloModule initialized
|
||||
[INFO] Greeting: Hello, Extra2D!
|
||||
[INFO] Repeat Count: 1
|
||||
[INFO] Logging Enabled: true
|
||||
[INFO] [HelloModule] Hello, Extra2D!
|
||||
[INFO] HelloScene entered
|
||||
[INFO] [HelloModule] Hello, Extra2D! # 场景 onEnter() 调用
|
||||
[INFO] Scene calling HelloModule from onUpdate...
|
||||
[INFO] [HelloModule] Hello, Extra2D! # 场景每5秒调用
|
||||
[INFO] HelloModule shutdown - Goodbye!
|
||||
```
|
||||
|
||||
### 在场景中使用模块
|
||||
|
||||
模块初始化后，可以在场景中通过 `ModuleRegistry` 获取模块实例并调用其功能：
|
||||
|
||||
```cpp
|
||||
class HelloScene : public Scene {
|
||||
public:
|
||||
void onEnter() override {
|
||||
Scene::onEnter();
|
||||
|
||||
// 获取模块初始化器
|
||||
ModuleId helloId = get_hello_module_id();
|
||||
auto* initializer = ModuleRegistry::instance().getInitializer(helloId);
|
||||
|
||||
if (initializer) {
|
||||
// 转换为具体类型
|
||||
auto* helloInit = dynamic_cast<HelloModuleInitializer*>(initializer);
|
||||
if (helloInit) {
|
||||
// 调用模块功能
|
||||
helloInit->sayHello();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void onUpdate(float dt) override {
|
||||
Scene::onUpdate(dt);
|
||||
|
||||
time_ += dt;
|
||||
|
||||
// 每5秒调用一次模块功能
|
||||
if (time_ >= 5.0f) {
|
||||
ModuleId helloId = get_hello_module_id();
|
||||
auto* initializer = ModuleRegistry::instance().getInitializer(helloId);
|
||||
if (initializer) {
|
||||
auto* helloInit = dynamic_cast<HelloModuleInitializer*>(initializer);
|
||||
if (helloInit) {
|
||||
helloInit->sayHello();
|
||||
}
|
||||
}
|
||||
time_ = 0.0f;
|
||||
}
|
||||
}
|
||||
|
||||
private:
|
||||
float time_ = 0.0f;
|
||||
};
|
||||
```
|
||||
|
||||
### 模块使用流程总结
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ 1. 程序启动 │
|
||||
│ └── 静态变量 HelloModuleAutoRegister 自动注册模块 │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ 2. Application::init() │
|
||||
│ └── 遍历 ModuleRegistry 中所有已注册模块 │
|
||||
│ └── 按优先级顺序调用 initialize() │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ 3. 场景/其他代码使用模块 │
|
||||
│ └── ModuleRegistry::getInitializer(moduleId) │
|
||||
│ └── dynamic_cast 转换为具体类型 │
|
||||
│ └── 调用模块方法 │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
│
|
||||
▼
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ 4. Application::shutdown() │
|
||||
│ └── 按逆序调用所有模块的 shutdown() │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
|
|
|||
|
|
@ -0,0 +1,18 @@
|
|||
{
|
||||
"app": {
|
||||
"name": "HelloModule Example",
|
||||
"version": "1.0.0"
|
||||
},
|
||||
"window": {
|
||||
"title": "Hello Module Example",
|
||||
"width": 800,
|
||||
"height": 600,
|
||||
"mode": "windowed",
|
||||
"vsync": true
|
||||
},
|
||||
"hello": {
|
||||
"greeting": "Hello from custom module!",
|
||||
"repeatCount": 3,
|
||||
"enableLogging": true
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,183 @@
|
|||
#include "hello_module.h"
|
||||
#include <extra2d/config/module_registry.h>
|
||||
#include <extra2d/utils/logger.h>
|
||||
#include <nlohmann/json.hpp>
|
||||
|
||||
using json = nlohmann::json;
|
||||
|
||||
namespace extra2d {
|
||||
|
||||
static ModuleId s_helloModuleId = INVALID_MODULE_ID;
|
||||
|
||||
/**
|
||||
* @brief 获取Hello模块标识符
|
||||
*/
|
||||
ModuleId get_hello_module_id() {
|
||||
return s_helloModuleId;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief 从JSON加载配置
|
||||
*/
|
||||
bool HelloModuleConfig::loadFromJson(const void* jsonData) {
|
||||
if (!jsonData) return false;
|
||||
|
||||
try {
|
||||
const json& j = *static_cast<const json*>(jsonData);
|
||||
|
||||
if (j.contains("greeting")) {
|
||||
config.greeting = j["greeting"].get<std::string>();
|
||||
}
|
||||
if (j.contains("repeatCount")) {
|
||||
config.repeatCount = j["repeatCount"].get<int>();
|
||||
}
|
||||
if (j.contains("enableLogging")) {
|
||||
config.enableLogging = j["enableLogging"].get<bool>();
|
||||
}
|
||||
|
||||
return true;
|
||||
} catch (...) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief 保存配置到JSON
|
||||
*/
|
||||
bool HelloModuleConfig::saveToJson(void* jsonData) const {
|
||||
if (!jsonData) return false;
|
||||
|
||||
try {
|
||||
json& j = *static_cast<json*>(jsonData);
|
||||
j["greeting"] = config.greeting;
|
||||
j["repeatCount"] = config.repeatCount;
|
||||
j["enableLogging"] = config.enableLogging;
|
||||
return true;
|
||||
} catch (...) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief 构造函数
|
||||
*/
|
||||
HelloModuleInitializer::HelloModuleInitializer()
|
||||
: moduleId_(INVALID_MODULE_ID)
|
||||
, initialized_(false) {
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief 析构函数
|
||||
*/
|
||||
HelloModuleInitializer::~HelloModuleInitializer() {
|
||||
if (initialized_) {
|
||||
shutdown();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief 获取模块依赖列表
|
||||
*/
|
||||
std::vector<ModuleId> HelloModuleInitializer::getDependencies() const {
|
||||
return {};
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief 初始化模块
|
||||
*/
|
||||
bool HelloModuleInitializer::initialize(const IModuleConfig* config) {
|
||||
if (initialized_) {
|
||||
E2D_LOG_WARN("HelloModule already initialized");
|
||||
return true;
|
||||
}
|
||||
|
||||
if (!config) {
|
||||
E2D_LOG_ERROR("HelloModule config is null");
|
||||
return false;
|
||||
}
|
||||
|
||||
const HelloModuleConfig* helloConfig = dynamic_cast<const HelloModuleConfig*>(config);
|
||||
if (!helloConfig) {
|
||||
E2D_LOG_ERROR("Invalid HelloModule config type");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!helloConfig->validate()) {
|
||||
E2D_LOG_ERROR("HelloModule config validation failed");
|
||||
return false;
|
||||
}
|
||||
|
||||
config_ = helloConfig->config;
|
||||
|
||||
initialized_ = true;
|
||||
|
||||
E2D_LOG_INFO("HelloModule initialized");
|
||||
E2D_LOG_INFO(" Greeting: {}", config_.greeting);
|
||||
E2D_LOG_INFO(" Repeat Count: {}", config_.repeatCount);
|
||||
E2D_LOG_INFO(" Logging Enabled: {}", config_.enableLogging);
|
||||
|
||||
sayHello();
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief 关闭模块
|
||||
*/
|
||||
void HelloModuleInitializer::shutdown() {
|
||||
if (!initialized_) return;
|
||||
|
||||
if (config_.enableLogging) {
|
||||
E2D_LOG_INFO("HelloModule shutdown - Goodbye!");
|
||||
}
|
||||
|
||||
initialized_ = false;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief 执行问候操作
|
||||
*/
|
||||
void HelloModuleInitializer::sayHello() const {
|
||||
if (!config_.enableLogging) return;
|
||||
|
||||
for (int i = 0; i < config_.repeatCount; ++i) {
|
||||
E2D_LOG_INFO("[HelloModule] {}", config_.greeting);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief 注册Hello模块
|
||||
*/
|
||||
void register_hello_module() {
|
||||
if (s_helloModuleId != INVALID_MODULE_ID) {
|
||||
E2D_LOG_WARN("HelloModule already registered");
|
||||
return;
|
||||
}
|
||||
|
||||
s_helloModuleId = ModuleRegistry::instance().registerModule(
|
||||
makeUnique<HelloModuleConfig>(),
|
||||
[]() -> UniquePtr<IModuleInitializer> {
|
||||
auto initializer = makeUnique<HelloModuleInitializer>();
|
||||
initializer->setModuleId(s_helloModuleId);
|
||||
return initializer;
|
||||
}
|
||||
);
|
||||
|
||||
E2D_LOG_DEBUG("HelloModule registered with id: {}", s_helloModuleId);
|
||||
}
|
||||
|
||||
namespace {
|
||||
/**
|
||||
* @brief 自动注册器
|
||||
* 在程序启动时自动注册模块
|
||||
*/
|
||||
struct HelloModuleAutoRegister {
|
||||
HelloModuleAutoRegister() {
|
||||
register_hello_module();
|
||||
}
|
||||
};
|
||||
|
||||
static HelloModuleAutoRegister s_autoRegister;
|
||||
}
|
||||
|
||||
} // namespace extra2d
|
||||
|
|
@ -0,0 +1,148 @@
|
|||
#pragma once
|
||||
|
||||
#include <extra2d/config/module_config.h>
|
||||
#include <extra2d/config/module_initializer.h>
|
||||
#include <string>
|
||||
|
||||
namespace extra2d {
|
||||
|
||||
/**
|
||||
* @brief Hello模块配置数据结构
|
||||
*/
|
||||
struct HelloModuleConfigData {
|
||||
std::string greeting = "Hello, Extra2D!";
|
||||
int repeatCount = 1;
|
||||
bool enableLogging = true;
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Hello模块配置类
|
||||
*
|
||||
* 这是一个简单的自定义模块示例，展示如何：
|
||||
* 1. 定义模块配置数据结构
|
||||
* 2. 实现IModuleConfig接口
|
||||
* 3. 支持JSON配置加载/保存
|
||||
*/
|
||||
class HelloModuleConfig : public IModuleConfig {
|
||||
public:
|
||||
HelloModuleConfigData config;
|
||||
|
||||
/**
|
||||
* @brief 获取模块信息
|
||||
*/
|
||||
ModuleInfo getModuleInfo() const override {
|
||||
ModuleInfo info;
|
||||
info.id = 0;
|
||||
info.name = "HelloModule";
|
||||
info.version = "1.0.0";
|
||||
info.priority = ModulePriority::User;
|
||||
info.enabled = true;
|
||||
return info;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief 获取配置节名称
|
||||
*/
|
||||
std::string getConfigSectionName() const override {
|
||||
return "hello";
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief 验证配置有效性
|
||||
*/
|
||||
bool validate() const override {
|
||||
return !config.greeting.empty() && config.repeatCount > 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief 重置为默认配置
|
||||
*/
|
||||
void resetToDefaults() override {
|
||||
config = HelloModuleConfigData{};
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief 应用平台约束
|
||||
*/
|
||||
void applyPlatformConstraints(PlatformType platform) override {
|
||||
(void)platform;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief 从JSON加载配置
|
||||
*/
|
||||
bool loadFromJson(const void* jsonData) override;
|
||||
|
||||
/**
|
||||
* @brief 保存配置到JSON
|
||||
*/
|
||||
bool saveToJson(void* jsonData) const override;
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief Hello模块初始化器
|
||||
*
|
||||
* 负责模块的生命周期管理
|
||||
*/
|
||||
class HelloModuleInitializer : public IModuleInitializer {
|
||||
public:
|
||||
HelloModuleInitializer();
|
||||
~HelloModuleInitializer() override;
|
||||
|
||||
/**
|
||||
* @brief 获取模块标识符
|
||||
*/
|
||||
ModuleId getModuleId() const override { return moduleId_; }
|
||||
|
||||
/**
|
||||
* @brief 获取模块优先级
|
||||
*/
|
||||
ModulePriority getPriority() const override { return ModulePriority::User; }
|
||||
|
||||
/**
|
||||
* @brief 获取模块依赖列表
|
||||
*/
|
||||
std::vector<ModuleId> getDependencies() const override;
|
||||
|
||||
/**
|
||||
* @brief 初始化模块
|
||||
*/
|
||||
bool initialize(const IModuleConfig* config) override;
|
||||
|
||||
/**
|
||||
* @brief 关闭模块
|
||||
*/
|
||||
void shutdown() override;
|
||||
|
||||
/**
|
||||
* @brief 检查是否已初始化
|
||||
*/
|
||||
bool isInitialized() const override { return initialized_; }
|
||||
|
||||
/**
|
||||
* @brief 设置模块标识符
|
||||
*/
|
||||
void setModuleId(ModuleId id) { moduleId_ = id; }
|
||||
|
||||
/**
|
||||
* @brief 执行问候操作
|
||||
*/
|
||||
void sayHello() const;
|
||||
|
||||
private:
|
||||
ModuleId moduleId_ = INVALID_MODULE_ID;
|
||||
bool initialized_ = false;
|
||||
HelloModuleConfigData config_;
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief 获取Hello模块标识符
|
||||
*/
|
||||
ModuleId get_hello_module_id();
|
||||
|
||||
/**
|
||||
* @brief 注册Hello模块
|
||||
*/
|
||||
void register_hello_module();
|
||||
|
||||
} // namespace extra2d
|
||||
|
|
@ -0,0 +1,101 @@
|
|||
#include "hello_module.h"
|
||||
#include <extra2d/app/application.h>
|
||||
#include <extra2d/config/module_registry.h>
|
||||
#include <extra2d/scene/scene.h>
|
||||
#include <extra2d/services/scene_service.h>
|
||||
#include <extra2d/utils/logger.h>
|
||||
|
||||
using namespace extra2d;
|
||||
|
||||
/**
|
||||
* @brief 自定义场景类
|
||||
*
|
||||
* 展示如何在场景中使用自定义模块
|
||||
*/
|
||||
class HelloScene : public Scene {
|
||||
public:
|
||||
static Ptr<HelloScene> create() { return makeShared<HelloScene>(); }
|
||||
|
||||
void onEnter() override {
|
||||
Scene::onEnter();
|
||||
E2D_LOG_INFO("HelloScene entered");
|
||||
|
||||
setBackgroundColor(Color(0.1f, 0.1f, 0.2f, 1.0f));
|
||||
|
||||
ModuleId helloId = get_hello_module_id();
|
||||
auto *initializer = ModuleRegistry::instance().getInitializer(helloId);
|
||||
if (initializer) {
|
||||
auto *helloInit = dynamic_cast<HelloModuleInitializer *>(initializer);
|
||||
if (helloInit) {
|
||||
E2D_LOG_INFO("Scene calling HelloModule from onEnter...");
|
||||
helloInit->sayHello();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void onUpdate(float dt) override {
|
||||
Scene::onUpdate(dt);
|
||||
|
||||
time_ += dt;
|
||||
|
||||
if (time_ >= 5.0f) {
|
||||
ModuleId helloId = get_hello_module_id();
|
||||
auto *initializer = ModuleRegistry::instance().getInitializer(helloId);
|
||||
if (initializer) {
|
||||
auto *helloInit = dynamic_cast<HelloModuleInitializer *>(initializer);
|
||||
if (helloInit) {
|
||||
E2D_LOG_INFO("Scene calling HelloModule from onUpdate...");
|
||||
helloInit->sayHello();
|
||||
}
|
||||
}
|
||||
time_ = 0.0f;
|
||||
}
|
||||
}
|
||||
|
||||
private:
|
||||
float time_ = 0.0f;
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief 应用程序入口
|
||||
*/
|
||||
int main(int argc, char *argv[]) {
|
||||
(void)argc;
|
||||
(void)argv;
|
||||
|
||||
E2D_LOG_INFO("=== Hello Module Example ===");
|
||||
E2D_LOG_INFO("This example demonstrates how to create a custom module");
|
||||
E2D_LOG_INFO("");
|
||||
|
||||
Application &app = Application::get();
|
||||
|
||||
AppConfig appConfig;
|
||||
appConfig.appName = "HelloModule Example";
|
||||
appConfig.appVersion = "1.0.0";
|
||||
|
||||
if (!app.init(appConfig)) {
|
||||
E2D_LOG_ERROR("Failed to initialize application");
|
||||
return 1;
|
||||
}
|
||||
|
||||
E2D_LOG_INFO("");
|
||||
E2D_LOG_INFO("Application initialized successfully");
|
||||
E2D_LOG_INFO("HelloModule should have been auto-registered and initialized");
|
||||
E2D_LOG_INFO("");
|
||||
|
||||
auto scene = HelloScene::create();
|
||||
app.enterScene(scene);
|
||||
|
||||
E2D_LOG_INFO("Starting main loop...");
|
||||
E2D_LOG_INFO("Press ESC or close window to exit");
|
||||
E2D_LOG_INFO("");
|
||||
|
||||
app.run();
|
||||
|
||||
E2D_LOG_INFO("Application shutting down...");
|
||||
|
||||
app.shutdown();
|
||||
|
||||
E2D_LOG_INFO("Application shutdown complete");
|
||||
return 0;
|
||||
}
|
||||
26
xmake.lua
26
xmake.lua
|
|
@ -164,3 +164,29 @@ target("demo_basic")
|
|||
-- 构建后安装Shader文件
|
||||
after_build(install_shaders)
|
||||
target_end()
|
||||
|
||||
-- Hello Module 示例 - 展示如何创建自定义模块
|
||||
target("demo_hello_module")
|
||||
set_kind("binary")
|
||||
set_default(false)
|
||||
|
||||
add_deps("extra2d")
|
||||
add_files("examples/hello_module/*.cpp")
|
||||
add_includedirs("examples/hello_module")
|
||||
|
||||
-- 平台配置
|
||||
local plat = get_config("plat") or os.host()
|
||||
if plat == "mingw" or plat == "windows" then
|
||||
add_packages("glm", "nlohmann_json", "libsdl2")
|
||||
add_syslinks("opengl32", "glu32", "winmm", "imm32", "version", "setupapi")
|
||||
elseif plat == "linux" then
|
||||
add_packages("glm", "nlohmann_json", "libsdl2")
|
||||
add_syslinks("GL", "dl", "pthread")
|
||||
elseif plat == "macosx" then
|
||||
add_packages("glm", "nlohmann_json", "libsdl2")
|
||||
add_frameworks("OpenGL", "Cocoa", "IOKit", "CoreVideo")
|
||||
end
|
||||
|
||||
-- 构建后安装Shader文件
|
||||
after_build(install_shaders)
|
||||
target_end()
|
||||
|
|
|
|||
Loading…
Reference in New Issue