Javascript-Voronoi 技术文档

1. 安装指南

由于 Javascript-Voronoi 是一个纯 JavaScript 库，因此不需要复杂的安装过程。只需将核心文件 rhill-voronoi-core.js 或其压缩版 rhill-voronoi-core.min.js 下载到您的项目中，并在 HTML 文件中通过 <script> 标签引入即可。

<script src="path/to/rhill-voronoi-core.js"></script>

或者使用压缩版：

<script src="path/to/rhill-voronoi-core.min.js"></script>

2. 项目的使用说明

Javascript-Voronoi 库的核心是 Voronoi 对象，该对象用于计算二维空间中的 Voronoi 图。以下是基本使用方法：

var voronoi = new Voronoi();
var bbox = {xl: 0, xr: 800, yt: 0, yb: 600}; // 定义边界框
var sites = [ {x: 200, y: 200}, {x: 50, y: 250}, {x: 400, y: 100} ]; // 定义点集

var diagram = voronoi.compute(sites, bbox); // 计算 Voronoi 图

计算完成后，diagram 对象将包含以下属性：

• diagram.vertices: Voronoi 图中的所有顶点。
• diagram.edges: Voronoi 图中的所有边。
• diagram.cells: Voronoi 图中的所有单元。
• diagram.execTime: 计算 Voronoi 图所需的时间（毫秒）。

3. 项目API使用文档

以下是 Voronoi 对象及其相关公共对象的主要API：

Voronoi 对象

• new Voronoi(): 创建一个新的 Voronoi 对象。
• compute(sites, bbox): 计算给定点集和边界框的 Voronoi 图。
• recycle(diagram): 回收已计算的 Voronoi 图以优化性能。

公共对象

• Voronoi.Vertex: 表示 Voronoi 图中的顶点，具有 x 和 y 属性。
• Voronoi.Edge: 表示 Voronoi 图中的边，具有 lSite、rSite、va 和 vb` 属性。
• Voronoi.Cell: 表示 Voronoi 图中的单元，具有 site 和 halfedges 属性。
• Voronoi.Halfedge: 表示 Voronoi 图中的半边，具有 site、edge、getStartpoint() 和 getEndpoint() 方法。

4. 项目安装方式

如前所述，Javascript-Voronoi 是一个纯 JavaScript 库，可以通过以下两种方式集成到您的项目中：

• 直接下载核心文件 rhill-voronoi-core.js 或其压缩版 rhill-voronoi-core.min.js，然后在 HTML 文件中通过 <script> 标签引入。
• 使用包管理工具（如 npm 或 yarn）安装，尽管这通常不是必需的，因为库本身不依赖 Node.js 或其他环境。

请注意，本库不包含任何渲染代码，渲染部分需要用户根据自身需求自行实现。