bim_xg/bim_engine
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
33f1c72791e971320d93a5166342f67f6286377c
bim_engine/docs/INDEX.md
yuding 89ae01ffd7 feat: upgrade iflow-engine-base to v1.0.5, add pause/resume rendering API 
- Update iflow-engine-base from 1.0.1 to 1.0.5
- Change default engine version from v1 to v2
- Add pauseRendering() and resumeRendering() methods
- Add switch model feature in demos
- Update model URLs in demos
- Add new documentation files
2026-01-23 16:27:04 +08:00

4.2 KiB
Raw Blame History

iflow-engine SDK 文档索引

🤖 AI 代码助手入口文件 - 请从此文件开始了解项目结构

项目概述

项目 内容
名称 iflow-engine
版本 1.0.1
描述 BIM 3D 引擎 SDK，支持 Vue2、Vue3、React 和原生 HTML
类型 技术项目 / SDK
语言 TypeScript
构建工具 Vite
核心依赖 Three.js, iflow-engine-base

快速导航

文档 说明 适合人群
ARCHITECTURE.md 架构设计、设计模式、模块依赖 架构师、核心开发
GETTING_STARTED.md 快速开始、安装、基础用法 新用户、集成开发
MODULES/_INDEX.md 所有模块的详细文档索引 所有开发者

模块概览

src/
├── bim-engine.ts          # 主入口类 BimEngine
├── index.ts               # 导出文件
├── core/                  # 核心基础设施
├── managers/              # 管理器层（业务逻辑）
├── components/            # UI 组件层
├── services/              # 全局服务（主题、国际化）
├── themes/                # 主题预设和类型
├── locales/               # 国际化文案
├── types/                 # 公共类型定义
└── utils/                 # 工具函数

核心模块

模块 路径 职责 文档
BimEngine src/bim-engine.ts 主入口类，整合所有功能 详情
core src/core/ 事件系统、管理器基类、注册表 详情
managers src/managers/ 15 个管理器，处理业务逻辑 详情
components src/components/ 20+ 个 UI 组件 详情
services src/services/ 主题管理、国际化服务 详情

架构分层

┌─────────────────────────────────────┐
│   BimEngine (主引擎)                 │  ← 用户 API 入口
├─────────────────────────────────────┤
│  ManagerRegistry (单例注册表)        │  ← 全局状态管理
├─────────────────────────────────────┤
│ 管理器层 (15个Manager类)             │  ← 业务逻辑
├─────────────────────────────────────┤
│ 组件层 (20+ UI组件)                  │  ← 视图渲染
├─────────────────────────────────────┤
│ 服务层 (LocaleManager, ThemeManager) │  ← 横切关注点
├─────────────────────────────────────┤
│ 核心基础设施                         │  ← 事件、基类
│ (EventEmitter, BaseManager)         │
└─────────────────────────────────────┘

关键设计模式

模式 应用位置 说明
单例模式 ManagerRegistry, LocaleManager, ThemeManager 全局唯一实例
观察者模式 EventEmitter, 服务订阅 事件驱动通信
模板方法 BaseManager, BaseDialogManager 统一生命周期
工厂模式 BimEngine 初始化 创建管理器实例

公开 API 统计

类别 数量
管理器类 15 个
UI 组件 20+ 个
事件类型 30+ 个
主题属性 70+ 个
国际化键 200+ 个

技术栈

  • 语言: TypeScript 5.x
  • 构建: Vite 7.x
  • 3D 引擎: Three.js 0.182.x
  • 核心 SDK: iflow-engine-base 1.0.x

相关链接

文档生成时间: 2026-01-23 文档版本: 1.0.0