Recent changes to documentation

documentation modified by Timo Kähkönen

Timo Kähkönen — Fri, 08 Sep 2017 10:47:16 -0000

--- v306
+++ v307
@@ -25,7 +25,7 @@
 * it's numerically robust
 * it's free to use in both freeware and commercial applications

-**Current Javascript Clipper version:** 6.4.2.1 (C# 6.4.2)
+**Current Javascript Clipper version:** 6.4.2.2 (C# 6.4.2)

 **Original C# version's Author & copyright:**
 Angus Johnson. Copyright © 2010-2017
@@ -51,7 +51,7 @@

 The ZIP package contains the Clipper library's source code as minified and unminified. The library was initially written in Delphi Pascal, but was then made available also in C++, C# and Python. The library's source code in each language is about 5000 lines. Javascript implementation is longer, about 7625 lines due to JSBN library and some helper functions.

-Demo applications and examples are not included in the distribution package. They can be accessed here. The sample applications show how Clipper can be used with **SVG** and **Canvas**.
+Demo applications and examples are not included in the distribution package. They can be accessed here. The sample applications show how Clipper can be used with **SVG** and **Canvas**.

 **Download Link:**

documentation modified by Timo Kähkönen

Timo Kähkönen — Sun, 03 Sep 2017 15:38:13 -0000

--- v305
+++ v306
@@ -2111,6 +2111,6 @@

 Texts and images have been copied (with permission) from the original Clipper Documentation, with some modifications to fit the Javascript environment.

-Clipper Documentation is copyright 2010-2016 Angus Johnson.
+Clipper Documentation is copyright 2010-2017 Angus Johnson.

 Modifications copyright 2013-2017 Timo.

documentation modified by Timo Kähkönen

Timo Kähkönen — Sun, 03 Sep 2017 15:37:55 -0000

--- v304
+++ v305
@@ -25,14 +25,14 @@
 * it's numerically robust
 * it's free to use in both freeware and commercial applications

-**Current Javascript Clipper version:** 6.2.1.2 (C# 6.2.1)
+**Current Javascript Clipper version:** 6.4.2.1 (C# 6.4.2)

 **Original C# version's Author & copyright:**
-Angus Johnson. Copyright © 2010-2016
+Angus Johnson. Copyright © 2010-2017
 License, terms and conditions: Boost Software License

 **Javascript Clipper's Author & copyright:**
-Timo Kähkönen. Copyright © 2012-2016
+Timo Kähkönen. Copyright © 2012-2017
 License, terms and conditions: Boost Software License

 Javascript Clipper uses implementation of Tom Wu's JSBN library, which has BSD license.
@@ -49,9 +49,9 @@

 **Distribution package contents:**

-The ZIP package contains the Clipper library's source code as minified and unminified. The library was initially written in Delphi Pascal, but was then made available also in C++, C# and Python. The library's source code in each language is about 5000 lines. Javascript implementation is longer, about 6200 lines due to JSBN library and some helper functions.
-
-Demo applications and examples are not included in the distribution package. They can be accessed here. The sample applications show how Clipper can be used with **SVG** and **Canvas**.
+The ZIP package contains the Clipper library's source code as minified and unminified. The library was initially written in Delphi Pascal, but was then made available also in C++, C# and Python. The library's source code in each language is about 5000 lines. Javascript implementation is longer, about 7625 lines due to JSBN library and some helper functions.
+
+Demo applications and examples are not included in the distribution package. They can be accessed here. The sample applications show how Clipper can be used with **SVG** and **Canvas**.

 **Download Link:**

@@ -2113,4 +2113,4 @@

 Clipper Documentation is copyright 2010-2016 Angus Johnson.

-Modifications copyright 2013-2016 Timo.
+Modifications copyright 2013-2017 Timo.

documentation modified by Timo Kähkönen

Timo Kähkönen — Sun, 27 Nov 2016 16:44:10 -0000

--- v303
+++ v304
@@ -2111,6 +2111,6 @@

 Texts and images have been copied (with permission) from the original Clipper Documentation, with some modifications to fit the Javascript environment.

-Clipper Documentation is copyright 2010-2014 Angus Johnson.
-
-Modifications copyright 2013-2014 Timo.
+Clipper Documentation is copyright 2010-2016 Angus Johnson.
+
+Modifications copyright 2013-2016 Timo.

documentation modified by Timo Kähkönen

Timo Kähkönen — Sun, 27 Nov 2016 16:43:32 -0000

--- v302
+++ v303
@@ -25,7 +25,7 @@
 * it's numerically robust
 * it's free to use in both freeware and commercial applications

-**Current Javascript Clipper version:** 6.2.1.1 (C# 6.2.1)
+**Current Javascript Clipper version:** 6.2.1.2 (C# 6.2.1)

 **Original C# version's Author & copyright:**
 Angus Johnson. Copyright © 2010-2016
@@ -51,7 +51,7 @@

 The ZIP package contains the Clipper library's source code as minified and unminified. The library was initially written in Delphi Pascal, but was then made available also in C++, C# and Python. The library's source code in each language is about 5000 lines. Javascript implementation is longer, about 6200 lines due to JSBN library and some helper functions.

-Demo applications and examples are not included in the distribution package. They can be accessed here. The sample applications show how Clipper can be used with **SVG** and **Canvas**.
+Demo applications and examples are not included in the distribution package. They can be accessed here. The sample applications show how Clipper can be used with **SVG** and **Canvas**.

 **Download Link:**

documentation modified by Timo Kähkönen

Timo Kähkönen — Sun, 27 Nov 2016 16:42:11 -0000

--- v301
+++ v302
@@ -69,31 +69,31 @@
 ## Preprocessor defines

 -Boolean use_int32
-Boolean use_xyz
-Boolean use_lines
-Boolean use_deprecated
-
-####
-
-**use_int32:**
+Boolean ClipperLib.use_int32
+Boolean ClipperLib.use_xyz
+Boolean ClipperLib.use_lines
+Boolean ClipperLib.use_deprecated
+

+####
+
+ClipperLib.use_int32:
Not implemented in Javascript.

-use_xyz:
+ClipperLib.use_xyz:
Adds a 'Z' member to IntPoint with only a minor cost to perfomance. For more details see Clipper's Clipper.ZFillFunction property. (Disabled by default)

-use_lines:
+ClipperLib.use_lines:
Enables open path (line) clipping. If line clipping is disabled, there's generally a very small (ie ~5%) improvement in performance. (Enabled by default)

-use_deprecated:
+ClipperLib.use_deprecated:
Enables code developed with versions of Clipper prior to version 6 to compile without changes. This exposes compatibility code that will be removed in a future update. (Enabled by default)

Usage:



-var use_xyz = true;

-var use_lines = true;

-var use_deprecated = true;

+ClipperLib.use_xyz = true;

+ClipperLib.use_lines = true;

+ClipperLib.use_deprecated = true;

####

@@ -802,19 +802,17 @@

####

-This property is only exposed if the Preprocessor directive use_xyz has been defined. (If it is defined, a Z member will be added to the IntPoint structure.) When a custom callback function is assigned it will be called during clipping operations so custom Z values can be assigned intersection vertices.

-Vertices in the solution of clipping operations more often than not correspond to input (subject or clip) vertices, but those vertices created at edge intersections do not. While the X and Y coordinates for these 'intersection' vertices are obviously defined by the points of intersection, there's no obvious way to assign their Z values. It really depends on the needs of the library user. While there are 4 vertices directly influencing an intersection vertex (ie the vertices on each end of the 2 intersecting edges), in an attempt to keep things simple only the vertices bounding one edge will be passed to the callback function.

-The CurvesDemo application in the Curves directory in the distribution zip package shows how the Z member together with the callback function can be used to flatten curved paths (defined by control points) and after clipping, to 'de-flatten' or reconstruct curved paths in the clipping solution.
+This property is only exposed when the pre-processor directive use_xyz has been defined. If this is the case, a 'Z' member will be included in the IntPoint structure where users can store custom data. While most vertices in a clipping solution will correspond to input (subject and clip) vertices, there will also be new vertices wherever edges intersect. This property assigns a custom callback function to the Clipper object so that custom 'Z' values can be assigned to these intersection vertices. (Note that 'Z' values in the solution at non-intersecting vertices will simply be copied from matching input vertices along with the X and Y values.)
+
+It is up to the library user to assign 'Z' values for new intersection vertices (otherwise these values will remain 0). The four vertices that define the intersecting line segments will be passed to the callback function (together with the new intersection vertex) to aid the user in determining appropriate Z values.

Usage:



 var cpr = new ClipperLib.Clipper();

-cpr.ZFillFunction = function (vert1, vert2, intersectPt) { / function body / };

+cpr.ZFillFunction = function (bot1, top1, bot2, top2, pt) { / function body / };

 // or

-var ClipCallback = function (vert1, vert2, intersectPt) { / function body / };

+var ClipCallback = function (bot1, top1, bot2, top2, pt) { / function body / };

 cpr.ZFillFunction = ClipCallback;

####
@@ -1220,10 +1218,13 @@
### ClipperLib.Clipper.ZFillCallback()



-void ZFillCallback(IntPoint Z1, IntPoint Z2, IntPoint pt);

-

-####
-
+void ZFillCallback(IntPoint bot1, IntPoint top1, IntPoint bot2, IntPoint top2, IntPoint pt);
+
+####
+
+If the use_xyz pre-processor directive is enabled, then the IntPoint class will have an extra 'Z' member and the Clipper class's ZFillFunction property will be exposed so it can be assigned a custom callback function.
+
+This custom callback procedure requires five IntPoint parameters: the first 2 parameters are the vertices that define one line segment involved in the intersection and the next two parameters the other line segment. (Since the Clipper library has been developed in an environment that uses an inverted Y axis display, e1bot and e2bot will always have Y values greater than or equal to their corresponding e1top and e2top Y values.) The last IntPoint parameter contain the actual coordinates at the intersection. This last parameter is passed by reference so that its Z member can be assigned with a custom value.

See also:
Clipper.ZFillFunction

documentation modified by Timo

Timo — Sun, 20 Nov 2016 18:06:09 -0000

--- v300
+++ v301
@@ -32,7 +32,7 @@
 License, terms and conditions: Boost Software License

 **Javascript Clipper's Author & copyright:**
-Timo. Copyright © 2012-2016
+Timo Kähkönen. Copyright © 2012-2016
 License, terms and conditions: Boost Software License

 Javascript Clipper uses implementation of Tom Wu's JSBN library, which has BSD license.

documentation modified by Timo

Timo — Sat, 19 Nov 2016 21:21:31 -0000

--- v299
+++ v300
@@ -25,14 +25,14 @@
 * it's numerically robust
 * it's free to use in both freeware and commercial applications

-**Current Javascript Clipper version:** 6.1.3.2 (C# 6.1.3a)
+**Current Javascript Clipper version:** 6.2.1.1 (C# 6.2.1)

 **Original C# version's Author & copyright:**
-Angus Johnson. Copyright © 2010-2014
+Angus Johnson. Copyright © 2010-2016
 License, terms and conditions: Boost Software License

 **Javascript Clipper's Author & copyright:**
-Timo. Copyright © 2012-2014
+Timo. Copyright © 2012-2016
 License, terms and conditions: Boost Software License

 Javascript Clipper uses implementation of Tom Wu's JSBN library, which has BSD license.

documentation modified by Timo

Timo — Sat, 01 Feb 2014 19:31:00 -0000

--- v298
+++ v299
@@ -25,7 +25,7 @@
 * it's numerically robust
 * it's free to use in both freeware and commercial applications

-**Current Javascript Clipper version:** 6.1.3.1 (C# 6.1.3)
+**Current Javascript Clipper version:** 6.1.3.2 (C# 6.1.3a)

 **Original C# version's Author & copyright:**
 Angus Johnson. Copyright © 2010-2014
@@ -51,7 +51,7 @@

 The ZIP package contains the Clipper library's source code as minified and unminified. The library was initially written in Delphi Pascal, but was then made available also in C++, C# and Python. The library's source code in each language is about 5000 lines. Javascript implementation is longer, about 6200 lines due to JSBN library and some helper functions.

-Demo applications and examples are not included in the distribution package. They can be accessed here. The sample applications show how Clipper can be used with **SVG** and **Canvas**.
+Demo applications and examples are not included in the distribution package. They can be accessed here. The sample applications show how Clipper can be used with **SVG** and **Canvas**.

 **Download Link:**

documentation modified by Timo

Timo — Tue, 21 Jan 2014 19:16:39 -0000

--- v297
+++ v298
@@ -588,7 +588,7 @@
 var poly = [{X:10,Y:10},{X:110,Y:10},{X:110,Y:110},{X:10,Y:110}];
 var pt = new ClipperLib.IntPoint(50,50);
 var inpoly = ClipperLib.Clipper.PointInPolygon(pt, poly);
-// inpoly is -1 (note! correct answer is 1, we are waiting bug fix)
+// inpoly is 1, which means that pt is in polygon

####