npm

Join us for the "JavaScript Supply Chain Security" tech talk, presented by VP of Security, Adam Baldwin. 6/20 at 10am PT.Sign up here »

points-in-polygon

0.2.1 • Public • Published

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
  • Points in the resulting triangles are determined using co-project 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

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 for all his work on wonderful GIS algorithms (like 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.

install

npm i points-in-polygon

Downloadsweekly downloads

7

version

0.2.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability