Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rastapasta/points-in-polygon
🖼️ Process all points inside any 2D polygon
https://github.com/rastapasta/points-in-polygon
geometry-library node-js node-module polygon polygon-points rasterization triangulation
Last synced: 2 months ago
JSON representation
🖼️ Process all points inside any 2D polygon
- Host: GitHub
- URL: https://github.com/rastapasta/points-in-polygon
- Owner: rastapasta
- Created: 2017-04-01T13:28:18.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-11-06T00:31:16.000Z (about 5 years ago)
- Last Synced: 2024-09-16T01:31:12.988Z (3 months ago)
- Topics: geometry-library, node-js, node-module, polygon, polygon-points, rasterization, triangulation
- Language: JavaScript
- Homepage:
- Size: 9.77 KB
- Stars: 8
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# points-in-polygon
A node.js library helping you to process all rasterized points in any 2D polygon.
## How does it work?
* Triangulation is done via [earcut](https://github.com/mapbox/earcut)
* Points in the resulting triangles are determined using co-project [points-in-triangle](https://github.com/rastapasta/points-in-triangle)
* All points in the polygon are iterated and passed to the callback.
## What is it for?
* Rendering: Draw any given polygon!
* GIS: Create height maps of 2D shape files!
## How to install
Install it into your project with
```
npm install --save points-in-polygon
```
## How to use it
```js
const pointsInPolygon = require('points-in-polygon');
// Format: [[[outerX,outerY],...],[[innerX,innerY],...],[[innerX,innerY],...]]
let polygon = [
// first element is defining the outer area of the polygon
[[0, 0], [10, 0], [10, 10], [0, 10]],
// following elements will define the inner cut out areas
[[3, 3], [6, 3], [6, 6], [3, 6]],
...
];
// triangulate, rasterize and calculate points inside the polygon
pointsInPolygon(polygon, (x, y) => console.log(x, y));
```
## Special thanks
* [mourner](https://github.com/mourner) for all his work on wonderful GIS algorithms (like [earcut](https://github.com/mapbox/earcut))
## License
#### The MIT License (MIT)
Copyright (c) 2017 Michael Straßburger
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.