Fornjot CAD Kernel 使用指南

Fornjot CAD Kernel 使用指南

fornjot Early-stage b-rep CAD kernel, written in the Rust programming language. 项目地址: https://gitcode.com/gh_mirrors/fo/fornjot

1. 项目目录结构及介绍

Fornjot 是一个以 Rust 语言编写的早期边界表示（b-rep）CAD 内核，其项目结构精心设计，支持模块化。下面是其关键目录及其简要描述：

• src: 核心源代码所在，进一步分为多个子目录。

  • fj: 全面的API，重导出以下所有crate。
  • fj-math: 供Fornjot其他部分使用的数学基础库。
  • fj-interop: 用于与其他crate交互的基础类型，无需直接依赖。
  • fj-core: 包含核心原语和处理这些原始数据的代码。
  • fj-export: 导出Fornjot模型至外部数据格式的库。
  • fj-viewer: 显示Fornjot模型的应用程序。
  • fj-window: 简化的窗口抽象层，为与fj-viewer配合使用而设。

• examples/models: 示例模型目录，提供现成的代码实例，用作快速入门的起点。

• .gitignore, .rustfmt.toml, Cargo.lock, Cargo.toml: Git忽略文件、Rust格式化配置、锁定文件以及Crate元数据文件，定义了项目的构建依赖和配置。

• LICENSE.md: 许可证文件，表明该项目遵循 Zero-Clause BSD License（0BSD）。

• README.md: 项目的主要说明文档，包含简介、状态、使用方法、社区参与等信息。

• 其它配置和脚本文件如justfile、rust-toolchain.toml等，提供了构建和管理环境的工具。

2. 项目的启动文件介绍

Fornjot作为一个库，并没有直接的传统“启动文件”。然而，通过示例模型如cuboid来演示使用Fornjot的方式。运行这些示例，实际上就是执行特定命令来编译和运行目标库的示例应用程序，例如：

cargo run -p cuboid

这里，cuboid是位于examples/models下的一个示例，它展示了一个基本模型的创建与显示过程。

3. 项目的配置文件介绍

• Cargo.toml: 这是Rust项目的核心配置文件，列出项目的依赖项、版本信息、作者详情、构建指令等。它对于Fornjot的构建至关重要，因为定义了所需的依赖关系和库的发布信息。

• rust-toolchain.toml: 指定了Rust编译器的版本要求，确保团队成员或贡献者可以一致地使用相同版本的工具链进行开发。

• .rustfmt.toml: 控制代码风格的配置文件，保证代码的一致性和可读性。

• .gitignore: 列出了在Git版本控制中应被忽略的文件或目录，减少不必要的版本控制负担。

综上所述，Fornjot项目通过精心设计的目录结构和配置文件，不仅保证了代码的清晰组织，还便于开发者理解和参与贡献。通过示例模型的学习和应用，用户可以迅速上手使用这一基于Rust的CAD内核技术。

fornjot Early-stage b-rep CAD kernel, written in the Rust programming language. 项目地址: https://gitcode.com/gh_mirrors/fo/fornjot