# Bim3dEditor

**Repository Path**: nzwm/bim3d-editor

## Basic Information

- **Project Name**: Bim3dEditor
- **Description**: 基于 webgpu/webgl/three.js  的开源 CAD 转 3D 编辑器。 内置智慧家装、BIM建模、数字孪生，智慧城市、web游戏, WebGPU示例。
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://mengyusong.github.io/bim3d-editor/
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 182
- **Created**: 2026-08-28
- **Last Updated**: 2026-08-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Bim3d-Editor

<p align="center">
  <strong>基于 Vue 3 + Three.js 的在线 CAD 转 3D 编辑与可视化平台</strong><br>
  作者：songmy · 开源贡献：1093697597(QQ)
</p>

---

**Bim3d-Editor** 是一套集 **CAD 解析编辑** 与 **自由 3D 建模** 能力于一体的 Web 端解决方案。  
它结合了 Vue.js 的响应式开发体验与 Three.js 强大的 WebGL/WebGPU 渲染能力，适用于：

- 科技城市可视化
- 数字孪生与智慧园区
- 智能家装设计
- Web 3D 游戏原型
- 数字工业与设备仿真
- 星地计算与地理信息展示
- WebGPU 高性能渲染实验
- WebGPU 游戏开发

---

## 功能特性

- **CAD 解析与编辑**：解析 CAD 数据并在浏览器中完成二维/三维编辑
- **自由 3D 建模**：基于 Three.js 场景图提供模型创建、变换与组织能力
- **WebGL / WebGPU 双渲染**：底层渲染抽象，兼容主流浏览器并支持高性能实验
- **BVH 加速拾取与碰撞**：集成 [three-mesh-bvh](https://github.com/gkjohnson/three-mesh-bvh)，提升大场景的射线拾取与碰撞检测性能
- **Web / 桌面双端**：同一套 Vue 3 代码，既可通过浏览器访问，也可打包为 Electron 桌面应用
- **统一工程化**：pnpm workspace + Turborepo 多包管理，类型检查、Lint 全链路覆盖

> 说明：项目仍在积极迭代中，各功能模块持续演进，欢迎参与共建。

---

## 在线预览

- 最新开发版：https://mengyusong.github.io/bim3d-editor/
- 稳定版通道：[v1.0-alpha](https://gitee.com/songmy1093697597/bim3d-editor/releases/tag/v1.0-alpha)

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://gitee.com/songmy1093697597/bim3d-editor)

---

## 技术栈

本项目采用 **Monorepo** 架构管理，推荐提前熟悉以下工具：

| 技术                                              | 版本       | 说明                                             |
| ------------------------------------------------- | ---------- | ------------------------------------------------ |
| [pnpm](https://pnpm.io/)                          | ^10.15.1   | 高效、节省磁盘空间的包管理器                     |
| [Turborepo](https://turbo.build/)                 | ^2.10.11   | 任务编排与增量构建，统一管理 dev/build/lint      |
| [Vue 3](https://cn.vuejs.org/)                    | ^3.5.40    | 渐进式 JavaScript 框架（Composition API + `<script setup>`） |
| [TypeScript](https://www.typescriptlang.org/)     | ~6.0.0     | 提供强类型支持，提升代码可维护性                 |
| [Vite](https://vitejs.cn/)                        | ^8.1.5     | 极速的前端构建工具                               |
| [Pinia](https://pinia.vuejs.org/zh/)              | ^4.0.3     | 直观、类型安全的状态管理                         |
| [Three.js](https://threejs.org/)                  | ^0.185.1   | 跨浏览器的 3D 图形库（WebGL / WebGPU）           |
| [three-mesh-bvh](https://github.com/gkjohnson/three-mesh-bvh) | ^0.9.14 | 网格 BVH 加速，优化拾取与碰撞检测         |
| [Tailwind CSS](https://tailwindcss.com/)           | ^4.3.3     | 实用优先的 CSS 框架（Vite 插件方式集成）         |
| [Electron](https://www.electronjs.org/)           | ^43.4.1    | 桌面端外壳，通过 vite-plugin-electron 集成       |
| [electron-builder](https://www.electron.build/)   | ^26.15.3   | 桌面应用打包                                   |
| [vue-tsc](https://github.com/vuejs/language-tools) | ^3.3.7    | Vue 单文件组件类型检查                           |
| [ESLint](https://eslint.org/)                     | ^10.7.0    | 代码规范检查（vue-eslint-parser）                |
| [oxlint](https://oxc.rs/docs/guide/usage/linter.html) | ~1.74.0 | 高性能 Rust 语法检查器                         |
| [Prettier](https://prettier.io/)                  | 3.9.5      | 统一代码风格                                     |

---

## 项目结构

```
bim3d-editor/
├── apps/                       # 应用层（Monorepo 工作区）
│   ├── bim3d/                  # Web 端 3D 编辑器（Vue 3 + Three.js）
│   │   ├── src/
│   │   │   ├── assets/         # 全局样式（含 Tailwind 入口）
│   │   │   ├── components/     # 业务组件
│   │   │   └── stores/         # Pinia 状态管理
│   │   └── vite.config.ts      # Vite + Electron 插件配置
│   └── web/                    # Electron 桌面端应用
│       ├── electron/
│       │   ├── main/           # Electron 主进程
│       │   └── preload/        # 预加载脚本（contextBridge 安全桥接）
│       ├── src/                # 渲染进程（与 bim3d 同构）
│       └── dist-electron/      # 构建产物
├── packages/                   # 共享包（预留）
├── pnpm-workspace.yaml         # pnpm 工作区定义
├── turbo.json                  # Turborepo 任务编排
├── eslint.config.ts            # ESLint 扁平配置
└── package.json                # 根工程（pnpm + turbo 统一入口）
```

---

## 环境要求

- Node.js `^22.18.0 || >=24.12.0`（见各应用 `engines` 字段）
- pnpm `^10.15.1`（推荐启用 [Corepack](https://nodejs.org/api/corepack.html)）
- 现代浏览器（Chrome / Edge / Firefox 等，支持 WebGL）

---

## 快速开始

```bash
# 1. 克隆项目
git clone https://gitee.com/songmy1093697597/bim3d-editor.git
cd bim3d-editor

# 2. 安装依赖
pnpm install

# 3. 启动开发服务（所有应用）
pnpm dev
```

也可以单独进入某个应用开发：

```bash
# 仅运行 Web 端编辑器
cd apps/bim3d && pnpm dev

# 运行 Electron 桌面端
cd apps/web && pnpm dev
```

---

## 常用脚本

在仓库根目录执行（Turborepo 会递归到各子应用）：

| 命令             | 说明                                             |
| ---------------- | ------------------------------------------------ |
| `pnpm dev`       | 启动所有应用的开发服务（HMR 热更新）             |
| `pnpm build`     | 构建所有应用（含 `vue-tsc` 类型检查）            |
| `pnpm lint`      | 对所有应用执行 Lint（oxlint + ESLint）           |
| `pnpm format`    | 使用 Prettier 统一格式化 `ts / tsx / md` 文件    |

子应用内可用脚本（以 `apps/bim3d` 为例）：

| 命令                    | 说明                                    |
| ----------------------- | --------------------------------------- |
| `pnpm dev`              | 启动 Vite 开发服务器                    |
| `pnpm build`            | 并行执行类型检查与打包                  |
| `pnpm preview`          | 本地预览构建产物                        |
| `pnpm type-check`       | 运行 `vue-tsc` 类型检查                 |
| `pnpm lint`             | 依次执行 oxlint 与 ESLint 并自动修复    |
| `pnpm format`           | 使用 Prettier 格式化 `src/` 源码        |

---

## 桌面端（Electron）

`apps/web` 提供了 Electron 桌面封装，特点：

- 使用 `vite-plugin-electron` 统一构建主进程 / 预加载脚本与渲染进程
- 预加载脚本通过 `contextBridge` 安全暴露 IPC API，保持 `contextIsolation` 安全模型
- 支持单实例锁、外部链接浏览器打开、Windows 应用模型 ID 等桌面能力
- 可通过 `electron-builder` 打包分发安装包

桌面端与 Web 端共享同一套 Vue 3 渲染代码，可低成本实现「一套代码，多端运行」。

---

## 参与贡献

我们欢迎任何形式的贡献，包括但不限于：

- 提交 Issue 或 PR
- 完善文档
- 分享使用案例

请阅读[贡献指南](https://gitee.com/songmy1093697597/bim3d-editor)了解开发流程。

---

## 更新日志

[更新日志](https://gitee.com/songmy1093697597/bim3d-editor/releases)会随每个版本发布同步更新。

### 版本历史

- **v0.1.0 / v1.0-alpha**：初始原型，搭建 Monorepo 工程与双端应用骨架

---

## 开源协议

本项目基于 [MIT License](https://gitee.com/songmy1093697597/bim3d-editor) 开源。