ViewSCAD 使用教程

ViewSCAD 使用教程

1. 项目介绍

ViewSCAD 是一个在 Jupyter Notebook 中渲染 3D 对象的模块，支持使用 OpenSCAD 语言或 SolidPython 模块描述的几何对象。它提供了一个完全在 Jupyter Notebook 中进行 CAD 设计的流程。

主要功能

• Jupyter 渲染：在 Jupyter Notebook 中实时渲染 3D 对象。
• 支持 OpenSCAD 和 SolidPython：支持使用 OpenSCAD 语言或 SolidPython 模块描述的几何对象。
• 交互式设计：通过双击渲染对象，可以选择面、边和顶点，并获取它们的索引，便于进一步操作。

2. 项目快速启动

安装

首先，确保你已经安装了 OpenSCAD 和 Jupyter Notebook。然后使用 pip 安装 ViewSCAD：

pip install viewscad

如果你使用的是 Jupyter Lab，还需要安装 pythreejs 扩展：

jupyter labextension install @jupyter-widgets/jupyterlab-manager

使用示例

以下是一个简单的示例，展示如何在 Jupyter Notebook 中使用 ViewSCAD 渲染一个 SolidPython 对象：

from viewscad import Renderer
from solid import cube

# 创建一个渲染器实例
r = Renderer()

# 创建一个 SolidPython 对象
c = cube([1, 2, 3])

# 渲染对象
r.render(c)

你也可以直接渲染 OpenSCAD 代码：

openscad_code = """
cube([1, 2, 3]);
"""

r.render(openscad_code)

3. 应用案例和最佳实践

案例1：在 Jupyter Notebook 中进行 CAD 设计

ViewSCAD 非常适合在 Jupyter Notebook 中进行 CAD 设计。你可以实时查看设计效果，并进行交互式调整。

from viewscad import Renderer
from solid import sphere, cylinder, union

r = Renderer()

# 创建一个球体和一个圆柱体
s = sphere(r=1)
c = cylinder(h=2, r1=0.5, r2=0.5)

# 将它们组合在一起
combined = union()(s, c)

# 渲染组合对象
r.render(combined)

案例2：生成 STL 文件

你可以通过添加 outfile 参数，直接生成 STL 文件：

r.render(combined, outfile='my_design.stl')

4. 典型生态项目

SolidPython

SolidPython 是一个用于生成 OpenSCAD 代码的 Python 库。ViewSCAD 与 SolidPython 结合使用，可以在 Jupyter Notebook 中进行高效的 CAD 设计。

pythreejs

pythreejs 是一个用于在 Jupyter Notebook 中渲染 3D 图形的库。ViewSCAD 依赖于 pythreejs 进行 3D 对象的渲染。

OpenSCAD

OpenSCAD 是一个开源的 3D CAD 建模工具，ViewSCAD 使用 OpenSCAD 的可执行文件来渲染几何对象。

通过这些工具的结合，你可以在 Jupyter Notebook 中实现从设计到渲染再到导出的完整 CAD 工作流程。