JSketcher 开源项目教程

1. 项目介绍

JSketcher 是一个用纯 JavaScript 编写的参数化 2D 和 3D CAD 建模器。它最初由 xibyte 开发，用于创建 3D 打印模型。JSketcher 提供了一套丰富的工具，用于可视化、选择/交互 3D 几何体，并跟踪和存储模型历史。其核心是一个 2D 约束求解器，该求解器完全用 JavaScript/TypeScript 实现，并用于 3D CAD 和 2D 草图绘制。JSketcher 还使用 OpenCascade 进行实体建模操作。

主要组件和功能

• 几何约束求解器：允许解决应用于草图的几何约束系统。
• 2D 草图绘制器：允许设计 2D 草图并应用几何约束，使用 HTML5 Canvas 进行渲染。
• 3D 布尔引擎：使用 OpenCascade 对 BREP 对象执行布尔运算。
• 特征历史：逐步构建 3D 模型，并使用比较步骤来传播边/面 ID，以提供稳定和健壮的模型。
• 导出为 STL、DWG 和 SVG 格式：支持将项目导出为多种格式。
• 浏览器本地存储：支持将项目保存在浏览器本地存储中。

2. 项目快速启动

安装 Node.js

首先，确保你已经安装了 Node.js。如果没有安装，可以从 Node.js 官网 下载并安装。

克隆项目

使用 Git 克隆 JSketcher 项目到本地：

git clone https://github.com/xibyte/jsketcher.git

安装依赖

进入项目目录并安装依赖：

cd jsketcher
npm install

启动项目

安装完成后，启动项目：

npm start

访问项目

启动后，打开浏览器并访问 http://localhost:3000，即可看到 JSketcher 的界面。

3. 应用案例和最佳实践

3D 打印模型设计

JSketcher 最初是为 3D 打印模型设计而开发的。用户可以通过创建参数化 2D 草图，然后将其转换为 3D 模型，最终导出为 STL 文件进行 3D 打印。

2D 参数化草图设计

JSketcher 也适用于 2D 参数化草图设计。用户可以创建复杂的 2D 草图，并应用各种几何约束，最终导出为 DWG 或 SVG 格式。

最佳实践

• 使用几何约束：在设计草图时，尽量使用几何约束来确保模型的稳定性和可维护性。
• 导出为多种格式：根据需求，选择合适的导出格式，如 STL 用于 3D 打印，DWG 或 SVG 用于 2D 设计。
• 利用特征历史：通过特征历史功能，可以逐步构建复杂的 3D 模型，并随时回溯和修改。

4. 典型生态项目

OpenCascade

JSketcher 使用 OpenCascade 进行实体建模操作。OpenCascade 是一个开源的 3D CAD 内核，提供了丰富的几何和拓扑操作功能。

Three.js

JSketcher 使用 Three.js 进行 3D 渲染。Three.js 是一个基于 WebGL 的 3D 图形库，提供了强大的 3D 渲染能力。

TypeScript

JSketcher 使用 TypeScript 进行开发。TypeScript 是 JavaScript 的超集，提供了静态类型检查和更强大的面向对象编程能力。

通过这些生态项目的结合，JSketcher 能够提供一个功能强大且易于使用的参数化 2D 和 3D 建模环境。