[docs][refactor]: 拆分重复模块文档并提升框架架构为全局入口
- 技能系统/相机系统/内存对象管理 README 改为概览+导航 - 框架架构.md 由通用框架子目录提升为全局入口 - 更新日期、过时改进点和文档关联路径 - 10-架构说明.md 拆分通用框架与框架架构链接 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -8,8 +8,6 @@
|
||||
|
||||
管理多相机注册、相机堆栈排序、渲染顺序控制,为 UI、场景、特效等提供分层渲染能力。
|
||||
|
||||
---
|
||||
|
||||
## 核心类
|
||||
|
||||
| 类 | 职责 |
|
||||
@@ -18,82 +16,6 @@
|
||||
| `HFMainCamera` | 主相机,管理 CameraStack |
|
||||
| `AbsHFCameraItem` | 相机项抽象基类,子类实现具体相机逻辑 |
|
||||
|
||||
---
|
||||
|
||||
## 创建自定义相机
|
||||
|
||||
继承 `AbsHFCameraItem`,实现 `CameraItem` 和 `Weight` 属性:
|
||||
|
||||
```csharp
|
||||
public class UIOverlayCamera : AbsHFCameraItem
|
||||
{
|
||||
[SerializeField] private Camera uiCamera;
|
||||
[SerializeField] private int weight = 10;
|
||||
|
||||
public override Camera CameraItem => uiCamera;
|
||||
public override int Weight => weight;
|
||||
|
||||
protected override void OnInitialize()
|
||||
{
|
||||
base.OnInitialize();
|
||||
uiCamera.clearFlags = CameraClearFlags.Depth;
|
||||
uiCamera.depth = 100;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 相机堆栈架构
|
||||
|
||||
```text
|
||||
HFMainCamera (主相机)
|
||||
│
|
||||
├── CameraStack (相机堆栈)
|
||||
│ ├── CameraItem1 (Weight=10)
|
||||
│ ├── CameraItem2 (Weight=20)
|
||||
│ └── CameraItem3 (Weight=5)
|
||||
│
|
||||
└── 按 Weight 排序 → 渲染顺序控制
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 管理相机
|
||||
|
||||
```csharp
|
||||
public class CameraController : MonoBehaviour
|
||||
{
|
||||
void Start()
|
||||
{
|
||||
HFCameraManager cameraMgr = HFCameraManager.Instance;
|
||||
|
||||
UIOverlayCamera uiCamera = GetComponent<UIOverlayCamera>();
|
||||
cameraMgr.AddCamera(uiCamera);
|
||||
|
||||
Camera mainCam = cameraMgr.mainCamera.MainCamera;
|
||||
}
|
||||
|
||||
void OnDestroy()
|
||||
{
|
||||
UIOverlayCamera uiCamera = GetComponent<UIOverlayCamera>();
|
||||
HFCameraManager.Instance.RemoveCamera(uiCamera);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 常用 API
|
||||
|
||||
| 方法 | 说明 |
|
||||
|-----|------|
|
||||
| `AddCamera(AbsHFCameraItem)` | 添加相机到堆栈 |
|
||||
| `RemoveCamera(AbsHFCameraItem)` | 从堆栈移除相机 |
|
||||
| `GetCamera(string cameraName)` | 获取指定名称相机 |
|
||||
|
||||
---
|
||||
|
||||
## 使用规则
|
||||
|
||||
- 相机项必须继承 `AbsHFCameraItem`。
|
||||
@@ -101,14 +23,11 @@ public class CameraController : MonoBehaviour
|
||||
- 添加和移除相机需成对出现,避免残留。
|
||||
- UI 相机通常使用 `CameraClearFlags.Depth` 和较高 depth。
|
||||
|
||||
---
|
||||
## 详细文档
|
||||
|
||||
## 相关模块
|
||||
|
||||
- [UI 窗口系统](../UI窗口系统/README.md)
|
||||
- [资源管理](../资源管理/README.md)
|
||||
|
||||
---
|
||||
- [使用指南](使用指南.md) — 自定义相机、堆栈管理、API 详情与示例
|
||||
- [UI 窗口系统](../UI窗口系统/README.md) — UI 与相机的协作
|
||||
- [资源管理](../资源管理/README.md) — 相机资源加载
|
||||
|
||||
## 文档关联
|
||||
|
||||
@@ -117,6 +36,8 @@ public class CameraController : MonoBehaviour
|
||||
| 文档 | 关联原因 |
|
||||
|---|---|
|
||||
| [modules/模块索引.md](../../模块索引.md) | 模块索引是项目知识总入口 |
|
||||
| [modules/frameworks/相机系统/使用指南.md](使用指南.md) | 本模块的详细 API 与使用说明 |
|
||||
| [modules/frameworks/UI窗口系统/README.md](../UI窗口系统/README.md) | UI 窗口系统常与相机系统协作 |
|
||||
| [modules/frameworks/资源管理/README.md](../资源管理/README.md) | 相机资源加载依赖资源管理 |
|
||||
| [rules/10-架构说明.md](../../../rules/10-架构说明.md) | 架构说明定义总体分层和依赖方向 |
|
||||
| [rules/30-模块登记规则.md](../../../rules/30-模块登记规则.md) | 模块登记规则定义分类和状态口径 |
|
||||
|
||||
Reference in New Issue
Block a user