# hachure-fill

> Fill a polygon with lines

Latest version **0.5.2** (published 2023-09-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install hachure-fill
pnpm add hachure-fill
yarn add hachure-fill
bun add hachure-fill
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.2 |
| Published | 2023-09-27 |
| First published | 2020-05-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 29 |
| Author | Preet Shihn |
| Maintainers | shihn |
| Keywords | hachure, lines, polygon, plotter |

## Links

- npm: https://www.npmjs.com/package/hachure-fill
- Repository: https://github.com/pshihn/hachure-fill
- Homepage: https://github.com/pshihn/hachure-fill#readme
- Issues: https://github.com/pshihn/hachure-fill/issues
- npm.io page: https://npm.io/package/hachure-fill

## Recent versions

- 0.5.2 (latest) — 2023-09-27
- 0.5.1 — 2023-09-27
- 0.5.0 — 2023-09-27
- 0.4.0 — 2023-05-31
- 0.3.0 — 2023-05-31
- 0.2.0 — 2020-05-01
- 0.1.0 — 2020-05-01

## README

# hachure-fill

[Demo](https://hachure-fill.pages.dev/)

This package calculates the hachure lined to fill a polygon. The **angle** of the lines and the **gap** between lines can be configured.

The algorithm works on convex, concave, simple, complex polygons, and polygons with holes. 

![preview of a polygon](https://user-images.githubusercontent.com/833927/242424090-90e60c00-c87b-4033-ae63-c0f38fa5d291.png)


## Install

From npm

```
npm install --save hachure-fill
```

The package is distributed as an ES6 module. 

## Usage

### hachureFill(points: Point[], angle: number, gap: number): Line[];

The function takes in a polygon, which is represented as an array of points (each point being a an array of 2 numbers `[x, y]`). 

The **angle** sets the angle of the hachure lines in degrees. 

The  **gap** arguments sets the distance between each hachure line. 

The function returns an array of lines. Each line is an array of two points. 

```javascript
import { hachureFill } from 'hachure-fill';

// Polygon vertices
const vertices = [
  [10, 10],
  [200, 10],
  [100, 100],
  [300, 100],
  [60, 200]
];

// Lines filling the polygon 
// at an angle of 45 degrees. 
// Lines are 10px apart.
const lines = hachureFill(vertices, 45, 10);

// Draw lines...
```

### hachureFill(points: Point[][], angle: number, gap: number): Line[];

When dealing with Polygon with holes, you can provide an array of polygons. The outer polygon, and polygones represented each of the holes. 
The polygons need not be nested, but if they are, even-odd rules apply to fill the shape.

---
_Source: https://npm.io/package/hachure-fill · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._