dotSCAD 项目使用教程
1. 项目的目录结构及介绍
dotSCAD 项目的目录结构如下:
dotSCAD/
├── src/
│ ├── voxel/
│ │ └── vx_circle.scad
│ ├── line2d.scad
│ └── ...
├── examples/
│ ├── example1.scad
│ └── ...
├── LICENSE
├── README.md
└── ...
目录结构介绍
- src/: 包含所有模块和函数的源代码文件。每个文件通常对应一个模块或函数。
- voxel/: 包含与体素相关的模块和函数。
- line2d.scad: 一个示例模块文件,用于绘制二维线段。
- examples/: 包含使用 dotSCAD 库的示例代码。
- LICENSE: 项目的许可证文件,采用 LGPL-3.0 许可证。
- README.md: 项目的介绍和使用说明。
2. 项目的启动文件介绍
dotSCAD 项目没有传统意义上的“启动文件”,因为它是一个库项目,主要用于提供模块和函数供其他 OpenSCAD 项目使用。用户可以通过 use <模块路径>
的方式引入所需的模块。
例如,使用 line2d
模块的示例代码如下:
use <line2d.scad>
line2d(p1 = [0, 0], p2 = [5, 0], width = 1);
3. 项目的配置文件介绍
dotSCAD 项目没有专门的配置文件。用户可以通过设置 OPENSCADPATH
环境变量来指定 dotSCAD 库的路径,以便在 OpenSCAD 中使用。
设置 OPENSCADPATH
在 OpenSCAD 中,可以通过以下方式设置 OPENSCADPATH
:
- 打开 OpenSCAD。
- 进入
Edit
->Preferences
->Advanced
。 - 在
Environment Variables
中添加OPENSCADPATH
,并将其值设置为 dotSCAD 项目的src
目录路径。
例如:
OPENSCADPATH=/path/to/dotSCAD/src
设置完成后,OpenSCAD 将会从 src
目录中搜索模块和函数。
总结
dotSCAD 是一个用于简化 OpenSCAD 编程的库项目,通过模块化的方式提供了丰富的功能。用户可以通过设置 OPENSCADPATH
环境变量来使用该库,并通过 use <模块路径>
的方式引入所需的模块。