feat(tree,menu,docs): 对接目录树三类数据并中文化文档
This commit is contained in:
122
docs/MODULES/模块索引.md
Normal file
122
docs/MODULES/模块索引.md
Normal file
@@ -0,0 +1,122 @@
|
||||
# 模块文档索引
|
||||
|
||||
## 模块列表
|
||||
|
||||
| 模块 | 路径 | 职责 | 文档 |
|
||||
|------|------|------|------|
|
||||
| **core** | `src/core/` | 核心基础设施:事件系统、管理器基类、注册表 | [核心模块.md](核心模块.md) |
|
||||
| **managers** | `src/managers/` | 15 个管理器,处理业务逻辑和组件协调 | [管理器模块.md](管理器模块.md) |
|
||||
| **components** | `src/components/` | 20+ 个 UI 组件 | [组件模块.md](组件模块.md) |
|
||||
| **services** | `src/services/` | 全局服务:国际化、主题管理 | [服务模块.md](服务模块.md) |
|
||||
|
||||
## Core 模块
|
||||
|
||||
提供 SDK 的核心基础设施。
|
||||
|
||||
| 类 | 文件 | 职责 |
|
||||
|-----|------|------|
|
||||
| EventEmitter | `event-emitter.ts` | 事件发布/订阅系统 |
|
||||
| ManagerRegistry | `manager-registry.ts` | 全局单例注册表 |
|
||||
| BaseManager | `base-manager.ts` | Manager 抽象基类 |
|
||||
| BaseDialogManager | `base-dialog-manager.ts` | 对话框 Manager 基类 |
|
||||
|
||||
[查看详情 →](核心模块.md)
|
||||
|
||||
## Managers 模块
|
||||
|
||||
处理业务逻辑,协调组件交互。
|
||||
|
||||
### 核心管理器
|
||||
|
||||
| 管理器 | 职责 |
|
||||
|--------|------|
|
||||
| EngineManager | 3D 引擎管理 |
|
||||
| ToolbarManager | 工具栏管理 |
|
||||
| DialogManager | 对话框管理 |
|
||||
| ButtonGroupManager | 按钮组管理 |
|
||||
| RightKeyManager | 右键菜单管理 |
|
||||
|
||||
### 功能管理器
|
||||
|
||||
| 管理器 | 职责 |
|
||||
|--------|------|
|
||||
| ComponentDetailManager | 构件详情弹窗管理 |
|
||||
| ConstructTreeManagerBtn | 构件树管理 |
|
||||
| MeasureDialogManager | 测量对话框管理 |
|
||||
| SectionPlaneDialogManager | 平面剖切管理 |
|
||||
| SectionAxisDialogManager | 轴向剖切管理 |
|
||||
| SectionBoxDialogManager | 剖切盒管理 |
|
||||
| WalkControlManager | 漫游控制管理 |
|
||||
| WalkPathDialogManager | 漫游路径管理 |
|
||||
| WalkPlanViewDialogManager | 漫游平面图管理 |
|
||||
| MapDialogManager | 地图管理 |
|
||||
|
||||
[查看详情 →](管理器模块.md)
|
||||
|
||||
## Components 模块
|
||||
|
||||
纯 UI 组件,不包含业务逻辑。
|
||||
|
||||
### 核心组件
|
||||
|
||||
| 组件 | 职责 |
|
||||
|------|------|
|
||||
| Engine | 3D 视口容器 |
|
||||
| BimDialog | 通用对话框 |
|
||||
| BimTree | 树形控件 |
|
||||
| BimMenu | 菜单组件 |
|
||||
| BimButtonGroup | 按钮组 |
|
||||
|
||||
### 面板组件
|
||||
|
||||
| 组件 | 职责 |
|
||||
|------|------|
|
||||
| MeasurePanel | 测量面板 |
|
||||
| SectionPlanePanel | 平面剖切面板 |
|
||||
| SectionAxisPanel | 轴向剖切面板 |
|
||||
| SectionBoxPanel | 剖切盒面板 |
|
||||
| WalkControlPanel | 漫游控制面板 |
|
||||
| WalkPathPanel | 漫游路径面板 |
|
||||
| WalkPlanViewPanel | 漫游平面图面板 |
|
||||
| MapPanel | 地图面板 |
|
||||
|
||||
### 展示组件
|
||||
|
||||
| 组件 | 职责 |
|
||||
|------|------|
|
||||
| BimCollapse | 折叠面板 |
|
||||
| BimTab | 标签页 |
|
||||
| BimDescription | 描述列表 |
|
||||
|
||||
[查看详情 →](组件模块.md)
|
||||
|
||||
## Services 模块
|
||||
|
||||
提供全局服务。
|
||||
|
||||
| 服务 | 职责 |
|
||||
|------|------|
|
||||
| LocaleManager | 国际化服务,多语言支持 |
|
||||
| ThemeManager | 主题管理服务,明暗切换 |
|
||||
|
||||
[查看详情 →](服务模块.md)
|
||||
|
||||
## 类型定义
|
||||
|
||||
| 文件 | 内容 |
|
||||
|------|------|
|
||||
| `types/component.ts` | 组件接口 IBimComponent |
|
||||
| `types/events.ts` | 事件类型 EngineEvents |
|
||||
| `types/measure.ts` | 测量类型定义 |
|
||||
| `locales/types.ts` | 国际化类型 |
|
||||
| `themes/types.ts` | 主题配置类型 |
|
||||
|
||||
## 工具函数
|
||||
|
||||
| 文件 | 内容 |
|
||||
|------|------|
|
||||
| `utils/icon-manager.ts` | 图标管理器,提供 40+ SVG 图标 |
|
||||
|
||||
---
|
||||
|
||||
**文档生成时间**: 2026-01-23
|
||||
Reference in New Issue
Block a user