docs: complete documentation polish — CHANGELOG v3.1-v3.5, README update, plan cleanup, v3.6 ideas
This commit is contained in:
@@ -1,5 +1,52 @@
|
||||
# 更新日志
|
||||
|
||||
## [3.5.0] — 2026-07-24
|
||||
|
||||
### 性能+实战
|
||||
- 布尔运算缓存加速(mesh_cache + AABB 预检)
|
||||
- 测量工具:distance / surface_area / volume / centroid
|
||||
- 实战零件示例:法兰(flange)+ 齿轮(gear)
|
||||
- 参数特征树:FeatureNode 递归求值 + FeatureHistory undo/redo
|
||||
- 装配约束:Coincident / Concentric / Tangent / Distance / Parallel / Perpendicular / Angle
|
||||
|
||||
## [3.4.0] — 2026-07-24
|
||||
|
||||
### 制造就绪
|
||||
- B-Rep 布尔集成面分割(质量大幅提升)
|
||||
- CAM 刀具路径:offset_contour + contour_toolpath + pocket_toolpath + G-code 导出
|
||||
- NURBS 曲面-曲面求交(递归细分 + Newton 精化)
|
||||
|
||||
## [3.3.0] — 2026-07-24
|
||||
|
||||
### 工业强化
|
||||
- B-Rep face splitting(split_face_by_plane)
|
||||
- WebGL 3D 查看器(viewer/index.html,拖放 GLB/STL)
|
||||
- 教程文档 3 篇(快速开始 / SDF / B-Rep)
|
||||
- 模糊测试(SDF / Boolean / Format round-trip)
|
||||
- DEB 打包(packaging/build-deb.sh)
|
||||
|
||||
## [3.2.0] — 2026-07-24
|
||||
|
||||
### CI/CD + 3MF + 装配体
|
||||
- CI/CD 配置(.gitea/workflows/build.yml)
|
||||
- Python 绑定(pyproject.toml + setup.py)
|
||||
- 3MF 格式导入/导出(零外部依赖 ZIP 实现)
|
||||
- B-Rep 装配体树(Assembly + AssemblyNode)
|
||||
- 性能基准修复 + 基线报告
|
||||
|
||||
## [3.1.0] — 2026-07-24
|
||||
|
||||
### 文档 + 示例 + NURBS 操作
|
||||
- Doxygen API 文档(76 头文件,483 页 HTML)
|
||||
- Gitea Wiki(12 页在线 API 参考)
|
||||
- Markdown API 参考手册(6942 行)
|
||||
- 3D 打印示例(08_3d_print)
|
||||
- B-Rep 制造示例(09_brep_fab)
|
||||
- Python SDF 优化示例
|
||||
- NURBS 高级操作(offset / trim / blend / ruled / coons / extrude)
|
||||
- Marching Cubes SEGFAULT 修复
|
||||
|
||||
|
||||
## [3.0.0] — 2026-07-24
|
||||
|
||||
### 全线测试通过(476+ / 476+)
|
||||
|
||||
@@ -142,7 +142,7 @@ auto result = brep_union(a, b); // 布尔并
|
||||
## 工程指标
|
||||
|
||||
- **语言**: C++17,零外部运行时依赖(仅 header-only Eigen + GTest)
|
||||
- **测试**: 476+ 用例,100% 通过
|
||||
- **测试**: 500+ 用例,100% 通过
|
||||
- **编译**: GCC 11+ / Clang 16+,零错误零警告
|
||||
- **格式支持**: STEP、IGES、glTF/GLB、STL、OBJ、PLY
|
||||
|
||||
|
||||
+48
-35
@@ -1,40 +1,53 @@
|
||||
# ViewDesignEngine 工程文档
|
||||
# ViewDesignEngine 文档目录
|
||||
|
||||
## 文档索引
|
||||
> 版本 3.5.0 | 最后更新 2026-07-24
|
||||
|
||||
| 编号 | 文档 | 说明 |
|
||||
## 开发计划
|
||||
|
||||
| 文档 | 版本 | 状态 |
|
||||
|------|------|------|
|
||||
| **第一阶段:需求分析** | | |
|
||||
| 01 | [市场调研与竞品分析](01-需求分析/01-市场调研与竞品分析.md) | 7 个引擎对标 |
|
||||
| 02 | [需求规格说明书](01-需求分析/02-需求规格说明书.md) | 16 类功能需求(含差异化功能) |
|
||||
| 03 | [用例文档](01-需求分析/03-用例文档.md) | 6 个核心用例 |
|
||||
| 04 | [功能差距分析](01-需求分析/04-功能差距分析.md) | 41 项差距,5 级优先级 |
|
||||
| 05 | [核心竞争力与差异化功能](01-需求分析/05-核心竞争力与差异化功能.md) | 14 项独有/首创功能 |
|
||||
| **第二阶段:概要设计** | | |
|
||||
| 06 | [系统架构设计](02-概要设计/01-系统架构设计.md) | 7 层模块架构 |
|
||||
| 07 | [模块划分](02-概要设计/02-模块划分.md) | 7 个模块详细清单 |
|
||||
| 08 | [接口定义](02-概要设计/03-接口定义.md) | 接口 + C API |
|
||||
| **第三阶段:详细设计** | | |
|
||||
| 09 | [数据结构设计](03-详细设计/01-数据结构设计.md) | 半边网格/NURBS/BVH |
|
||||
| 10 | [核心算法设计](03-详细设计/02-核心算法设计.md) | 算法伪代码 |
|
||||
| 11 | [类设计](03-详细设计/03-类设计.md) | 工厂/策略/访问者模式 |
|
||||
| **第四阶段:编码实现** | | |
|
||||
| 12 | [编码规范](04-编码实现/01-编码规范.md) | C++17 规范 |
|
||||
| 13 | [目录结构](04-编码实现/02-目录结构.md) | 工程目录树 |
|
||||
| **第五阶段:测试验证** | | |
|
||||
| 14 | [测试计划](05-测试验证/01-测试计划.md) | CI + 性能基准 |
|
||||
| 15 | [测试用例](05-测试验证/02-测试用例.md) | 8 组测试用例 |
|
||||
| **第六阶段:部署维护** | | |
|
||||
| 16 | [构建指南](06-部署维护/01-构建指南.md) | 三平台构建 |
|
||||
| 17 | [API 参考](06-部署维护/02-API参考.md) | 全部 API 签名 |
|
||||
| [v3.0 开发计划](00-开发计划.md) | v0.1 → v3.0 | ✅ 完成 |
|
||||
| [v3.1 开发计划](10-v3.1-开发计划.md) | v3.1 | ✅ 完成 |
|
||||
| [v3.2 开发计划](11-v3.2-开发计划.md) | v3.2 | ✅ 完成 |
|
||||
| [v3.3 开发计划](12-v3.3-开发计划.md) | v3.3 | ✅ 完成 |
|
||||
| [v3.4 开发计划](13-v3.4-开发计划.md) | v3.4 | ✅ 完成 |
|
||||
| [v3.5 开发计划](14-v3.5-开发计划.md) | v3.5 | ✅ 完成 |
|
||||
|
||||
## 杀手功能(竞品无人支持)
|
||||
## API 参考
|
||||
|
||||
| 功能 | 阶段 | 说明 |
|
||||
|------|------|------|
|
||||
| 2D 草图约束求解器 | v2.0 | 开源唯一,商业 CAD 核心资产 |
|
||||
| SDF 隐式建模 | v1.5 | 程序化建模/有机形态 |
|
||||
| 可微分几何 | v2.0 | AI+CAD 交叉领域 |
|
||||
| 惰性求值几何管线 | v1.0 | TensorFlow 式的几何计算图 |
|
||||
| Python 原生绑定 | v0.5 | pip install 即用 |
|
||||
| 二进制序列化 | v0.5 | 比 OBJ/STL 快 10x |
|
||||
| 文档 | 说明 |
|
||||
|------|------|
|
||||
| [API-REFERENCE.md](API-REFERENCE.md) | Markdown API 参考手册(6942 行) |
|
||||
| [Gitea Wiki](http://git.hdtime.space:3000/hm/ViewDesignEngine/wiki) | 在线 Wiki(12 页,含首页介绍) |
|
||||
| `docs/api/html/index.html` | Doxygen HTML 文档(483 页,本地生成) |
|
||||
|
||||
## 教程
|
||||
|
||||
| 文档 | 说明 |
|
||||
|------|------|
|
||||
| [01-快速开始](tutorial/01-quickstart.md) | 5 分钟上手 |
|
||||
| [02-SDF 建模](tutorial/02-sdf-modeling.md) | SDF 隐式建模教程 |
|
||||
| [03-B-Rep 建模](tutorial/03-brep-modeling.md) | B-Rep 工业建模教程 |
|
||||
|
||||
## 部署与构建
|
||||
|
||||
| 文档 | 说明 |
|
||||
|------|------|
|
||||
| [构建指南](06-部署维护/01-构建指南.md) | CMake 构建说明 |
|
||||
| [API 参考](06-部署维护/02-API参考.md) | 旧版 API 文档 |
|
||||
| [packaging/](../packaging/build-deb.sh) | DEB 打包脚本 |
|
||||
| [Doxyfile](../Doxyfile) | Doxygen 配置文件 |
|
||||
|
||||
## 其他
|
||||
|
||||
| 文档 | 说明 |
|
||||
|------|------|
|
||||
| [benchmark-report.md](benchmark-report.md) | 性能基准报告 |
|
||||
| [gen_api_ref_v2.py](gen_api_ref_v2.py) | API 参考生成脚本 |
|
||||
| [mainpage.h](mainpage.h) | Doxygen 主页源码 |
|
||||
|
||||
## 外部链接
|
||||
|
||||
- [Gitea 仓库](http://git.hdtime.space:3000/hm/ViewDesignEngine)
|
||||
- [Gitea Wiki](http://git.hdtime.space:3000/hm/ViewDesignEngine/wiki)
|
||||
- [CHANGELOG](../CHANGELOG.md)
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# ViewDesignEngine v3.1+ 开发计划
|
||||
|
||||
> 制定: 2026-07-24 | 状态: 执行中
|
||||
> 制定: 2026-07-24 | 状态: ✅ 完成
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# ViewDesignEngine v3.2 工程实用化计划
|
||||
|
||||
> 制定: 2026-07-24 | 状态: 执行中
|
||||
> 制定: 2026-07-24 | 状态: ✅ 完成
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# ViewDesignEngine v3.3 工业级强化计划
|
||||
|
||||
> 制定: 2026-07-24 | 状态: 执行中
|
||||
> 制定: 2026-07-24 | 状态: ✅ 完成
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# ViewDesignEngine v3.4 制造就绪计划
|
||||
|
||||
> 制定: 2026-07-24 | 状态: 执行中
|
||||
> 制定: 2026-07-24 | 状态: ✅ 完成
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# ViewDesignEngine v3.5 性能+实战计划
|
||||
|
||||
> 制定: 2026-07-24 | 状态: 执行中
|
||||
> 制定: 2026-07-24 | 状态: ✅ 完成
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
# ViewDesignEngine v3.6 计划
|
||||
|
||||
> 制定: 2026-07-24 | 状态: 计划中
|
||||
|
||||
已完成 v3.0 → v3.5 六个版本迭代,覆盖:格式互操作、SDF 建模、工业强化、制造就绪、性能实战。
|
||||
|
||||
## 建议方向
|
||||
|
||||
### 🎓 教育与社区
|
||||
- 视频教程系列(B站/YouTube)
|
||||
- 交互式 Playground(WebAssembly 编译)
|
||||
- 社区论坛 / 讨论区
|
||||
|
||||
### 🔬 高级几何
|
||||
- 曲面光顺(fairing)
|
||||
- 等距分析(curvature map)
|
||||
- 有限元网格(tetrahedral meshing)
|
||||
- 点云配准增强(全局 ICP + 特征匹配)
|
||||
|
||||
### 🏭 制造集成
|
||||
- CNC 后处理器(Haas/Fanuc/Siemens)
|
||||
- 3D 打印切片集成
|
||||
- 成本估算(材料体积 × 单价)
|
||||
- 工程图生成(DXF 导出)
|
||||
|
||||
### 🚀 性能突破
|
||||
- GPU 加速(CUDA/OpenCL)
|
||||
- 分布式布尔运算
|
||||
- SIMD 向量化
|
||||
- 内存池分配器
|
||||
|
||||
### 📱 跨平台
|
||||
- WebAssembly 构建目标
|
||||
- iOS/Android 绑定
|
||||
- Unity/Unreal 插件
|
||||
|
||||
---
|
||||
|
||||
下一步由你定。
|
||||
Reference in New Issue
Block a user