4.9 KiB
SimpleCADAPI
CADDesigner 论文成果
本仓库是以下论文工作的项目产物：
CADDesigner: Conceptual CAD Model Generation with a General-Purpose Agent
Computer-Aided Design 2026 接收
SimpleCADAPI 是一个基于 OCP 的 Python CAD SDK，提供清晰的函数式建模操作和可重放的模型图。它在 OpenCascade 几何内核之上提供精简的公共 API，可用于创建实体、应用特征、添加语义标签、查询拓扑、导出制造文件，以及将记录的模型转换为 FreeCAD 工作流。
当前测试版本：simplecadapi==2.0.1b1。
核心能力
- 基于 OCP 的
Vertex、Edge、Wire、Face和Solid类型。 - 支持基本体、轮廓、拉伸、旋转、放样、扫掠、布尔运算、变换、阵列、圆角、倒角和抽壳等函数式建模操作。
- 通过
GraphSession、export_model_json(...)、import_model_json(...)和replay_model_json(...)记录并重放建模过程。 - 通过
var(...)、算术表达式和可序列化表达式图定义参数。 - 使用 QL 选择器定位几何、查询拓扑并稳定选择特征。
- 通过
apply_tag(shape, tag)和list_tags(shape)管理语义标签。 - 支持 STEP/STL 导出，以及 FreeCAD 脚本和
.FCStd转换。
安装
使用 pip：
pip install simplecadapi
使用 uv：
uv add simplecadapi
从本仓库进行本地开发：
uv sync --group dev
快速开始
from pathlib import Path
import simplecadapi as scad
out = Path("out")
out.mkdir(exist_ok=True)
base = scad.make_box_rsolid(60.0, 36.0, 8.0, bottom_face_center=(0.0, 0.0, 0.0))
hole = scad.make_cylinder_rsolid(5.0, 14.0, bottom_face_center=(0.0, 0.0, -3.0))
part = scad.cut_rsolid(base, hole)
part = scad.apply_tag(part, "role.demo.bracket")
print("volume", round(part.get_volume(), 3))
print("tags", scad.list_tags(part))
scad.export_step(part, str(out / "bracket.step"))
scad.export_stl(part, str(out / "bracket.stl"))
可重放建模
当模型需要检查、序列化、重放或转换到其他 CAD 环境时，请使用 GraphSession：
import simplecadapi as scad
with scad.GraphSession() as session:
body = scad.make_box_rsolid(40.0, 24.0, 10.0, bottom_face_center=(0.0, 0.0, 0.0))
cutter = scad.make_cylinder_rsolid(4.0, 16.0, bottom_face_center=(0.0, 0.0, -3.0))
drilled = scad.cut_rsolid(body, cutter)
model_json = scad.export_model_json(session)
rebuilt = scad.replay_model_json(model_json)
print("recorded_nodes", session.graph.node_count)
print("replayed_outputs", len(rebuilt))
FreeCAD 转换
可以把记录的模型 JSON 转换为 FreeCAD Python 脚本：
script = scad.translator.freecad_translator.translate_model_json_to_freecad_script(model_json)
如果系统中存在 FreeCAD 或 FreeCADCmd，也可以直接生成 .FCStd 文件：
scad.translator.freecad_translator.translate_model_json_to_fcstd(model_json, "bracket.FCStd")
文档
- 公共 API 参考：
docs/api/ - 核心类型与建模说明：
docs/core/ - 序列化与重放：
docs/core/serialization/README.md - 操作图 JSON 规范：
docs/core/operation_graph_json_spec.md - 示例索引：
examples/README.md
发布 Agent Skill
仓库中的 skills/simplecadapi/ 是精简版 Agent Skill。它包含生成的 API 和建模参考文档，但不包含 SDK 源代码。
在干净的工作区中更新项目版本和文档，然后生成并验证发布产物：
uv sync --group dev
uv run skill-pack --refresh-docs --archive
uv run python -m pytest test/test_skill_pack.py
该命令会刷新生成文档、重建 skills/simplecadapi/，并生成 skills/simplecadapi.tar.gz。发布前检查 Skill 内容和归档文件：
git diff -- skills/simplecadapi docs
tar -tzf skills/simplecadapi.tar.gz
发布时提交生成的 skills/simplecadapi/ 目录和更新后的 docs/。归档文件已被 Git 忽略；请将 skills/simplecadapi.tar.gz 附加到对应的 GitHub Release，或上传到目标 Agent Skills 注册中心。
开发
uv sync --group dev
uv run python -m pytest test tests
python3 -m compileall src/simplecadapi
许可证
本项目采用 GNU Affero 通用公共许可证第 3 版（AGPL-3.0），详见 LICENSE。
社区交流
由于群聊人数过多，无法直接扫码入群。请扫描下方二维码添加杜鹏老师微信，由杜鹏老师邀请加入 CADDesigner 技术交流群：
