Index: action_details.html
===================================================================
--- action_details.html (revision 31737)
+++ action_details.html (revision 31738)
@@ -2687,7 +2687,7 @@
- A polygon is a pcb layer object, that is: if it's fullpoly, it may have multiple islands. The result is zero or more polygon layer objects, each with a single island, created on the current layer.
+ A polygon is a pcb layer object, that is: if it's fullpoly, it may have multiple islands. The code operates on the clipped shape of the input polygons, not on the 'as drawn shape'. The result is zero or more polygon layer objects, each with a single island, created on the current layer.
The rest of the arguments will build a flat list of polygon objects to work on and need to address at least two polygons. Each argument may be one of:
@@ -2721,7 +2721,13 @@
to address polygons, if multiple polygons are selected or found at the time, the order they end up added to the operation object list is undefined.
- Input polygons are unchanged, new polygons are created on the current layer.
+ Input polygons are unchanged, new polygons are created on the current layer.
+
+ Demo video:
+
+ PolyBool(sub) mini-howto.
+
+
PolyCombine
Index: action_reference.html
===================================================================
--- action_reference.html (revision 31737)
+++ action_reference.html (revision 31738)
@@ -13,7 +13,7 @@
-This is pcb-rnd 2.2.1 (svn r31696) an interactive printed circuit board editor , Revision: 31736
+This is pcb-rnd 2.2.1 (svn r31696) an interactive printed circuit board editor , Revision: 31737
Action | Description | Syntax | Plugin
| About | Present the about box | About() | dialogs plugin |
Index: action_src/polybool.html
===================================================================
--- action_src/polybool.html (nonexistent)
+++ action_src/polybool.html (revision 31738)
@@ -0,0 +1,31 @@
+The boolean operation argument is one of these:
+
+ - unite: calculate the union of the polygons
+
- isect: calculate the intersection of all polygons; the result is the area where all argument polygons are present
+
- sub: subtract subsequent polygons from the first polygon
+
+
+A polygon is a pcb layer object, that is: if it's fullpoly, it may have
+multiple islands. The code operates on the clipped shape of the input polygons,
+not on the 'as drawn shape'. The result is zero or more polygon layer objects,
+each with a single island, created on the current layer.
+
+The rest of the arguments will build a flat list of polygon objects to
+work on and need to address at least two polygons. Each argument may be
+one of:
+
+ - object: the user needs to click an object using the GUI
+
- selected: all selected polygons are appended to the list
+
- found: all found (green highlight) polygons are appended to the list
+
- ipdath: address a specific polygon
+
+
+Note: for the sub operation the first polygon is special, so order
+of attributes matter. When using selected or found to address
+polygons, if multiple polygons are selected or found at the time, the order
+they end up added to the operation object list is undefined.
+
+Input polygons are unchanged, new polygons are created on the current layer.
+
+Demo video: PolyBool(sub) mini-howto.
+