Files
bim_engine/docs/MODULES/模块索引.md

134 lines
4.1 KiB
Markdown
Raw Normal View History

# 模块文档索引
## 模块列表
| 模块 | 路径 | 职责 | 文档 |
|------|------|------|------|
| **core** | `src/core/` | 核心基础设施:事件系统、管理器基类、注册表 | [核心模块.md](核心模块.md) |
2026-03-16 16:13:36 +08:00
| **managers** | `src/managers/` | 15 个管理器,处理业务逻辑和组件协调(仅 3D | [管理器模块.md](管理器模块.md) |
| **components** | `src/components/` | 3 个引擎组件 + 20+ UI 组件 | [组件模块.md](组件模块.md) |
| **services** | `src/services/` | 全局服务:国际化、主题管理 | [服务模块.md](服务模块.md) |
| **settings** | `src/managers/setting-dialog-manager.ts` | 设置系统:渲染、显示、环境配置 | [设置系统.md](设置系统.md) |
## Core 模块
提供 SDK 的核心基础设施。
| 类 | 文件 | 职责 |
|-----|------|------|
| EventEmitter | `event-emitter.ts` | 事件发布/订阅系统 |
2026-03-16 16:13:36 +08:00
| ManagerRegistry | `manager-registry.ts` | 实例级注册表,隔离每个引擎实例的 Manager 与事件 |
| BaseManager | `base-manager.ts` | Manager 抽象基类 |
| BaseDialogManager | `base-dialog-manager.ts` | 对话框 Manager 基类 |
[查看详情 →](核心模块.md)
## Managers 模块
处理业务逻辑,协调组件交互。
### 核心管理器
| 管理器 | 职责 |
|--------|------|
| EngineManager | 3D 引擎管理 |
2026-04-20 10:38:42 +08:00
| ToolbarManager | 底部工具栏管理(传统线性布局,当前未使用) |
| **RadialToolbarManager** | **径向工具栏管理(当前主交互入口)** |
| DialogManager | 对话框管理 |
2026-04-20 10:38:42 +08:00
| ButtonGroupManager | 按钮组管理(通用,当前未使用) |
| RightKeyManager | 右键菜单管理 |
### 功能管理器
| 管理器 | 职责 | 文档 |
|--------|------|------|
| ComponentDetailManager | 构件详情弹窗管理 | |
| ConstructTreeManagerBtn | 构件树管理 | |
| MeasureDialogManager | 测量对话框管理 | |
| SectionPlaneDialogManager | 平面剖切管理 | |
| SectionAxisDialogManager | 轴向剖切管理 | |
| SectionBoxDialogManager | 剖切盒管理 | |
| SettingDialogManager | 设置系统管理 | [设置系统.md](设置系统.md) |
| WalkControlManager | 漫游控制管理 | |
| WalkPathDialogManager | 漫游路径管理 | |
| WalkPlanViewDialogManager | 漫游平面图管理 | |
| MapDialogManager | 地图管理 | |
[查看详情 →](管理器模块.md)
## Components 模块
纯 UI 组件,不包含业务逻辑。
2026-03-16 16:13:36 +08:00
### 引擎组件
| 组件 | 职责 |
|------|------|
| Engine | 3D 视口容器(包装 iflow-engine-base |
| Engine2d | 2D 图纸视口(包装 createEngine2d |
| Engine720 | 720° 全景视口(包装 createEngine720 |
### 核心 UI 组件
| 组件 | 职责 |
|------|------|
| BimDialog | 通用对话框 |
| BimTree | 树形控件 |
| BimMenu | 菜单组件 |
| BimButtonGroup | 按钮组 |
2026-04-20 10:38:42 +08:00
| **RadialToolbar** | **径向工具栏(圆形扇形菜单,当前主交互入口)** |
### 面板组件
| 组件 | 职责 |
|------|------|
| MeasurePanel | 测量面板 |
| SectionPlanePanel | 平面剖切面板 |
| SectionAxisPanel | 轴向剖切面板 |
| SectionBoxPanel | 剖切盒面板 |
| WalkControlPanel | 漫游控制面板 |
| WalkPathPanel | 漫游路径面板 |
| WalkPlanViewPanel | 漫游平面图面板 |
| MapPanel | 地图面板 |
### 展示组件
| 组件 | 职责 |
|------|------|
| BimCollapse | 折叠面板 |
| BimTab | 标签页 |
| BimDescription | 描述列表 |
[查看详情 →](组件模块.md)
## Services 模块
提供全局服务。
| 服务 | 职责 |
|------|------|
| LocaleManager | 国际化服务,多语言支持 |
| ThemeManager | 主题管理服务,明暗切换 |
[查看详情 →](服务模块.md)
## 类型定义
| 文件 | 内容 |
|------|------|
| `types/component.ts` | 组件接口 IBimComponent |
2026-03-16 16:13:36 +08:00
| `types/events.ts` | 事件类型 EngineEvents含 3D/2D/720 事件) |
| `types/measure.ts` | 测量类型定义 |
| `locales/types.ts` | 国际化类型 |
| `themes/types.ts` | 主题配置类型 |
## 工具函数
| 文件 | 内容 |
|------|------|
| `utils/icon-manager.ts` | 图标管理器,提供 40+ SVG 图标 |
---
2026-03-16 16:13:36 +08:00
**文档更新时间**: 2026-03-10