Files
ViewDesignEngine/docs/index.md
T
茂之钳 486a0fe011
CI / Build & Test (push) Failing after 35s
CI / Release Build (push) Failing after 33s
Build & Test / build-and-test (push) Has been cancelled
Build & Test / python-bindings (push) Has been cancelled
docs: reorganize documentation — developer-friendly structure
New structure:
- docs/index.md — main navigation
- docs/getting-started.md — 5-minute quick start
- docs/guides/module-manual.md — all 11 modules with file listing
- docs/guides/api-usage.md — API reference with code examples
- docs/guides/ — architecture, building, testing, contributing
- docs/reference/ — competitive analysis, gap analysis, versioning
- docs/api/ — Doxygen generated HTML
- docs/archive/ — historical development plans

Old development plans archived. Clean 4-directory layout.
2026-07-27 13:32:20 +08:00

2.4 KiB

ViewDesignEngine 文档

v1.0.0-beta.1 · C++17 B-Rep 几何引擎 · Apache 2.0

快速导航

你想做什么? 去看
快速上手编译运行 快速入门
了解每个模块能做什么 模块说明书
学习如何使用 API API 使用手册
查看代码示例 教程 + examples/
了解架构和贡献 架构概览 · 贡献指南
了解与竞品的差距 竞品分析 · 严谨差距分析
查看 API 详细定义 Doxygen API 文档
了解版本号规则 版本管理规范
查看更新历史 CHANGELOG

项目简介

ViewDesignEngine 是一个 C++17 全栈 B-Rep 几何引擎,对标 Parasolid/ACIS。

11 模块 · 129 源文件 · 0 编译错误 · Apache 2.0

核心能力

领域 能力
B-Rep 拓扑建模、SSI布尔、容错建模、直接建模、钣金、FFD
曲面 NURBS、G0-G3连续、Sweep/Loft/Net、曲面分析
网格 Delaunay、QEM、MC、FEA网格、逆向工程
格式 STEP/IGES/XT/SAT/JT/IFC/glTF/STL/OBJ/PLY/3MF
CAM 3轴/5轴加工、HSM、刀库、8种后处理器
工程图 投影/剖视、HLR、自动标注、GD&T、PMI/MBD
装配 约束求解、干涉检查、运动仿真、大装配LOD

目录结构

docs/
├── index.md              ← 你在这里
├── getting-started.md    ← 5分钟快速上手
├── api/                  ← Doxygen 生成的 API 文档
├── guides/               ← 开发者指南
│   ├── module-manual.md  ← 模块功能说明书
│   ├── api-usage.md      ← API 使用手册
│   ├── architecture.md   ← 架构概览
│   ├── building.md       ← 构建指南
│   ├── testing.md        ← 测试指南
│   └── contributing.md   ← 贡献指南
├── reference/            ← 参考资料
│   ├── 27-竞品分析.md
│   ├── 30-严谨差距分析.md
│   ├── API-REFERENCE.md
│   └── VERSIONING.md
└── archive/              ← 历史开发计划