package
utility for working with polygons (arrays of vec2s)
npm install polygonGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
nodejs
npm install polygon
Create a new polygon:
var p = new Polygon([
Vec2(0, 0),
Vec2(10, 0),
Vec2(0, 10)
]);
You can pass an array of Vec2s, arrays [x, y], or objects { x: 10, y: 20 }
each(function(prev, current, next, idx) {})point(idx) - returns the point at index idx. note: this will wrap in both directionsdedupe(returnNew) - ensure all of the points are uniqueinsert(vec2, index) - insert vec2 at the specified indexremove(vecOrIndex) - remove the specified vec2 or numeric index from this polygonclean(returnNew) - removes contiguous points that are the samewinding() - returns the direction in which a polygon is wound (true === clockwise)rewind(bool) - rewinds the polygon in the specified direction (true === clockwise)area() - computes the area of the polygonclosestPointTo(vec2) - finds the closest point in this polygon to vec2center() - returns a Vec2 at the center of the AABBscale(amount, origin, returnNew) - scales this polygon around origin (default is this.center()) and will return a new polygon if requested with returnNewcontainsPoint(vec2) - returns true if vec2 is inside the polygoncontainsPolygon(poly) - returns true if poly is completely contained in this polygonaabb() - returns an object {x:_, y:_, w:_, h:_} representing the axis-aligned bounding box of this polygyonoffset(amount) - performs an offset/buffering operation on this polygon and returns a new oneline(index) - return an array [startpoint, endpoint] representing the line at the specified indexlines(function(start, end, index) {}) - iterate over the lines in this polygonselfIntersections - find self-intersections and return them as a new polygonpruneSelfIntersections - remove self intersections from this polygon. returns an array of polygonsMIT
lengthclone - return a new instance of this polygonrotate(rads, vec2, returnNew) - rotate by origin vec2 (default this.center()) by radians rads and return a clone if returnNew is specifiedtranslate(vec2, returnNew) - translate by vec2 and return a clone if returnNew is specifiedequal(poly) - return true if this polygon has the same components and the incoming polycontains(thing) - works with an array of vec2's, an object containing a .position and .radius, an object populated with x1,y1,x2,y2, an object populated with x,y,w,h, and an object populated with x,y,width,height. See the tests for more infounion(polygon) returns a new polygon representing the boolean union of this and the incoming polygoncut(polygon) returns a new polygon representing the boolean cut of polygon from thistoArray() convert this polygon into an array of arrays ([[x, y]])Estimated unpacked size across 28 packages.
136.6 kB
Includes dependencies.
7 direct · 1 outdated
^1.6.0
1.6.1
^0.2.1
0.2.1
~0.2.0
1.0.0
^1.1.0
1.1.1
^1.0.0
1.0.0
~1.0.0
1.0.1
1.3.1