OpenVoronoi 技术文档

1. 安装指南

1.1 从PPA安装

如果你使用的是基于Debian的Linux发行版（如Ubuntu），可以通过PPA（Personal Package Archive）来安装OpenVoronoi。以下是安装步骤：

sudo add-apt-repository ppa:anders-e-e-wallin/cam
sudo apt-get update
sudo apt-get install openvoronoi

1.2 从源码安装

如果你想从源码编译安装OpenVoronoi，可以按照以下步骤进行：

git clone git://github.com/aewallin/openvoronoi.git
cd openvoronoi
mkdir bld
cd bld
cmake ../src
make
sudo make install

2. 项目的使用说明

OpenVoronoi是一个用于计算二维Voronoi图的开源库，支持点、线段和圆弧作为输入。以下是项目的主要使用场景和功能：

• Voronoi图计算：OpenVoronoi可以计算点、线段和圆弧的Voronoi图。目前，点和线段的Voronoi图计算已经实现，圆弧的支持正在开发中。
• 偏移生成：OpenVoronoi主要用于CNC铣削工具路径计算中的二维偏移生成。
• 实验性功能：项目中还包含一个实验性的近似中轴过滤器（medial_axis.hpp），用于生成中轴。

3. 项目API使用文档

OpenVoronoi的核心算法是用C++编写的，并通过Boost Python提供了Python绑定。以下是一些常用的API接口：

3.1 C++ API

• VoronoiDiagram类：用于创建和管理Voronoi图。

  VoronoiDiagram vd;
  vd.insert(point);
  vd.insert(line_segment);
  vd.insert(arc);
  

• Offset类：用于生成偏移路径。

  Offset offset(vd);
  offset.generate(offset_distance);
  

3.2 Python API

• VoronoiDiagram类：与C++ API类似，用于创建和管理Voronoi图。

  import openvoronoi as ov
  vd = ov.VoronoiDiagram()
  vd.insert(point)
  vd.insert(line_segment)
  vd.insert(arc)
  

• Offset类：用于生成偏移路径。

  offset = ov.Offset(vd)
  offset.generate(offset_distance)
  

4. 项目安装方式

4.1 依赖项

在安装OpenVoronoi之前，需要确保系统中安装了以下依赖项：

• 必需依赖项：

  • cmake
  • libqd-dev
  • Boost graph library
  • graphviz

• 可选依赖项：

  • git
  • python
  • Boost python
  • doxygen
  • asymptote
  • lyx
  • libvtk
  • python-vtk
  • truetype-tracer
  • randompolygon

4.2 安装步骤

1. 克隆仓库：

   git clone git://github.com/aewallin/openvoronoi.git
   

2. 创建构建目录：

   cd openvoronoi
   mkdir bld
   cd bld
   

3. 配置项目：

   cmake ../src
   

4. 编译项目：

   make
   

5. 安装项目：

   sudo make install
   

5. 测试

OpenVoronoi项目包含C++和Python的测试用例，位于src/test/目录下。可以使用CTest来运行这些测试：

make test

或者直接使用ctest命令：

ctest

你还可以通过指定测试名称来运行特定的测试：

ctest -R ttt

6. 文档

OpenVoronoi的文档可以通过Doxygen生成：

make doc

此外，项目中还包含一个关于算法和求解器的白皮书，位于doc/目录下，可以通过CMake生成PDF文件。

7. 贡献

如果你有兴趣为OpenVoronoi项目贡献代码，请遵循以下步骤：

1. Fork项目的GitHub仓库。
2. 创建一个特性分支。
3. 提交你的更改并进行测试。
4. 创建一个Pull Request，并简要描述你的更改。
5. 确保代码风格与现有代码一致，并遵守LGPL许可证。

8. 其他Voronoi图代码

OpenVoronoi并不是唯一的Voronoi图计算库，以下是一些其他相关的项目：

• CGAL：提供了Voronoi图的计算功能。
• LEDA：包含Voronoi图的计算模块。
• Boost.Polygon.Voronoi：Boost库中的Voronoi图计算模块。
• Voro++：用于三维Voronoi单元计算的库。
• Triangle：主要用于有限元分析的网格生成器，也可以用于生成Voronoi图。

9. 参考文献

OpenVoronoi的算法和实现参考了多篇学术论文，具体参考文献请参考项目的README文件。

---

通过本文档，你应该能够顺利安装、使用并理解OpenVoronoi项目的核心功能。如果你有任何问题或建议，欢迎通过项目的邮件列表或GitHub仓库进行讨论。