docs: 重构 API 文档 - components 和 scene 模块

- components: 修复英文标题为中文,添加缺失组件文档
  - 新增 camera-component, light-component, audio-source-component, audio-listener-component 类总览
  - 修复 get-position.md 格式
  - 更新 components.md 模块总览
- scene: 修复方法文档格式,新增缺失方法
  - 修复 find.md, create-game-object.md 英文标题
  - 新增 FindByID, SerializeToString, DeserializeFromString 方法文档
  - 更新 scene.md 类总览方法列表
This commit is contained in:
2026-03-26 01:50:27 +08:00
parent 7c3f304688
commit f5a34f8adc
46 changed files with 781 additions and 157 deletions

View File

@@ -0,0 +1,40 @@
# Scene::DeserializeFromString
从字符串反序列化场景。
```cpp
void DeserializeFromString(const std::string& data);
```
从 JSON 格式的字符串数据恢复场景的完整状态,包括所有 GameObject、组件和层级结构。
**参数:**
- `data` - JSON 格式的序列化数据
**线程安全:** ❌ (非线程安全,应在主线程调用)
**注意:**
- 此操作会清空当前场景的所有数据
- 反序列化后的 GameObject 引用可能与原始引用不同
**示例:**
```cpp
#include <XCEngine/Scene/Scene.h>
using namespace XCEngine::Components;
void Example(Scene* scene) {
std::string data = R"({
"name": "GameScene",
"gameObjects": [...]
})";
scene->DeserializeFromString(data);
}
```
## 相关文档
- [Scene 总览](scene.md) - 返回类总览
- [Save](save.md) - 保存到文件
- [SerializeToString](serialize-to-string.md) - 序列化为字符串