docs(plan): add api doc restructure task board

This commit is contained in:
2026-04-09 23:40:43 +08:00
parent 20b5c22a6a
commit 681452c70e
25 changed files with 898 additions and 15 deletions

View File

@@ -4,7 +4,7 @@
**类型**: `module`
**描述**: 提供 `GameObject`/`Component` 组合式对象模型,以及相机、灯光、网格渲染、音频等场景组件的 public API。
**描述**: 提供 `GameObject`/`Component` 组合式对象模型,以及相机、灯光、网格渲染、体积渲染、音频等场景组件的 public API。
## 概览
@@ -23,7 +23,7 @@
- 生命周期由 `GameObject``Scene` 驱动,运行时直接 `AddComponent<T>()` 并不会自动补发 `Awake``Start``OnEnable`
- 序列化职责分层:`GameObject::Serialize()` 只写对象基础字段和 `Transform`,完整场景保存由 `Scene::SerializeToString()` 负责组件和父子关系。
- `ComponentFactoryRegistry` 只负责把序列化文本里的组件类型名还原为内建组件实例,`Transform` 不走这条路径。
- 渲染组件链路当前是显式拆分的:`MeshFilterComponent` 负责 mesh 的运行时路径缓存、项目 `AssetRef` 与句柄绑定,`MeshRendererComponent` 负责材质槽的运行时路径缓存、项目 `AssetRef`、句柄以及渲染附加状态;对项目资产来说,正式持久化协议都优先是 `AssetRef`,而不是普通项目路径。
- 渲染组件链路当前是显式拆分的:`MeshFilterComponent` 负责 mesh 的运行时路径缓存、项目 `AssetRef` 与句柄绑定,`MeshRendererComponent` 负责材质槽的运行时路径缓存、项目 `AssetRef`、句柄以及渲染附加状态;`VolumeRendererComponent` 则为体对象持有 `VolumeField`、体材质以及阴影参与标记。对项目资产来说,正式持久化协议都优先是 `AssetRef`,而不是普通项目路径。
## 适用场景
@@ -52,13 +52,15 @@
- [LightComponent](LightComponent/LightComponent.md) - `LightComponent.h`,基础灯光参数。
- [MeshFilterComponent](MeshFilterComponent/MeshFilterComponent.md) - `MeshFilterComponent.h`mesh 资源绑定、序列化路径和资产引用恢复。
- [MeshRendererComponent](MeshRendererComponent/MeshRendererComponent.md) - `MeshRendererComponent.h`,材质槽和渲染附加参数。
- [VolumeRendererComponent](VolumeRendererComponent/VolumeRendererComponent.md) - `VolumeRendererComponent.h`,体积资源、体积材质与阴影标志绑定。
- [TransformComponent](TransformComponent/TransformComponent.md) - `TransformComponent.h`,局部/世界变换与层级矩阵。
- [VolumeRendererComponent](VolumeRendererComponent/VolumeRendererComponent.md) - `VolumeRendererComponent.h`,体数据、体材质和阴影标记组件。
## 推荐阅读顺序
1. 先读 [GameObject-Component Lifecycle And Serialization](../../_guides/Components/GameObject-Component-Lifecycle-And-Serialization.md),建立整体心智模型。
2. 再读 [GameObject](GameObject/GameObject.md) 和 [TransformComponent](TransformComponent/TransformComponent.md),理解对象树和变换树的关系。
3. 如果关注渲染资源绑定,再读 [MeshFilterComponent](MeshFilterComponent/MeshFilterComponent.md)[MeshRendererComponent](MeshRendererComponent/MeshRendererComponent.md),理解几何、材质和渲染提取之间的分工。
3. 如果关注渲染资源绑定,再读 [MeshFilterComponent](MeshFilterComponent/MeshFilterComponent.md)[MeshRendererComponent](MeshRendererComponent/MeshRendererComponent.md) 和 [VolumeRendererComponent](VolumeRendererComponent/VolumeRendererComponent.md),理解几何对象、体对象、材质和渲染提取之间的分工。
4. 最后按功能阅读其余组件页,例如 [CameraComponent](CameraComponent/CameraComponent.md)、[AudioSourceComponent](AudioSourceComponent/AudioSourceComponent.md)。
## 相关文档