replace remove overlap with simplify

Doodle3D · Apr 11, 2017 · f2e6c98 · f2e6c98
1 parent b653341
commit f2e6c98
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -320,11 +320,11 @@ when given path with holes, outline must be clockwise and holes must be counter-
 `Note: destructive`
 
 
-**[Remove Overlap](https://sourceforge.net/p/jsclipper/wiki/documentation/#clipperlibclippersimplifypolygons)**
+**[Simplify](https://sourceforge.net/p/jsclipper/wiki/documentation/#clipperlibclippersimplifypolygons)**
 ```javascript
-Shape = Shape.removeOverlap()
+Shape = Shape.simplify(fillType: String)
 ```
-unions all self intersecting shapes. Only works with closed shapes.
+Simplifies shape using filltype. Only works for closed shapes.
 
 
 **Sperate Shapes**

diff --git a/src/index.d.ts b/src/index.d.ts
@@ -65,7 +65,7 @@ export default class Shape {
     pointInPath(index: number, point: Point | PointLower, capitalConversion: boolean, integerConversion?: boolean): boolean;
 
     fixOrientation(): this;
-    removeOverlap(): Shape | this;
+    simplify(fillType: string): Shape | this;
     separateShapes(): Shape[];
     round(): Shape;
     removeDuplicates(): Shape;

diff --git a/src/index.js b/src/index.js
@@ -233,8 +233,13 @@ export default class Shape {
   }
 
   removeOverlap() {
+    console.warn(`Shape.removeOverlap is being depricated, use Shape.simplify('pftNonZero') instead`);
+    this.simplify('pftNonZero');
+  }
+
+  simplify(fillType) {
     if (this.closed) {
-      const shape = ClipperLib.Clipper.SimplifyPolygons(this.paths, ClipperLib.PolyFillType.pftNonZero);
+      const shape = ClipperLib.Clipper.SimplifyPolygons(this.paths, ClipperLib.PolyFillType[fillType]);
       return new Shape(shape, true);
     } else {
       return this;