Merge branch 'george-steel/expose-trim-after'

5 files changed, 70 insertions, 108 deletions

diff --git a/lib/elements/element.py b/lib/elements/element.py
index 96949ca3..84141d4f 100644
--- a/lib/elements/element.py
+++ b/lib/elements/element.py
@@ -342,10 +342,22 @@ class EmbroideryElement(object):
         return self.strip_control_points(path[0])
 
     @property
+    @param('trim_after',
+           _ ('Trim After'),
+           tooltip=_('Add a TRIM command after stitching this object.'),
+           type='boolean',
+           default=False,
+           sort_index=52)
     def trim_after(self):
         return self.get_boolean_param('trim_after', False)
 
     @property
+    @param('stop_after',
+           _ ('Stop After'),
+           tooltip=_('Add a STOP command after stitching this object.'),
+           type='boolean',
+           default=False,
+           sort_index=53)
     def stop_after(self):
         return self.get_boolean_param('stop_after', False)
 
diff --git a/lib/elements/empty_d_object.py b/lib/elements/empty_d_object.py
index 8f3b08de..6f010488 100644
--- a/lib/elements/empty_d_object.py
+++ b/lib/elements/empty_d_object.py
@@ -10,8 +10,8 @@ from .validation import ObjectTypeWarning
 
 
 class EmptyD(ObjectTypeWarning):
-    name = _("Empty D-Attribute")
-    description = _("There is an invalid path object in the document, the d-attribute is missing.")
+    name = _("Empty Path")
+    description = _("There is an invalid object in the document without geometry information.")
     steps_to_solve = [
         _('* Run Extensions > Ink/Stitch > Troubleshoot > Cleanup Document...')
     ]
diff --git a/lib/elements/fill_stitch.py b/lib/elements/fill_stitch.py
index a5248952..f4a21f90 100644
--- a/lib/elements/fill_stitch.py
+++ b/lib/elements/fill_stitch.py
@@ -113,8 +113,8 @@ class FillStitch(EmbroideryElement):
     @property
     @param('guided_fill_strategy', _('Guided Fill Strategy'), type='dropdown', default=0,
            options=[_("Copy"), _("Parallel Offset")], select_items=[('fill_method', 2)], sort_index=3,
-           tooltip=_('Copy (the default) will fill the shape with shifted copies of the line.' +
-                     'Parallel offset will ensure that each line is always a consistent distance from its neighbor.' +
+           tooltip=_('Copy (the default) will fill the shape with shifted copies of the line. '
+                     'Parallel offset will ensure that each line is always a consistent distance from its neighbor. '
                      'Sharp corners may be introduced.'))
     def guided_fill_strategy(self):
         return self.get_int_param('guided_fill_strategy', 0)
@@ -216,7 +216,7 @@ class FillStitch(EmbroideryElement):
     @property
     @param('staggers',
            _('Stagger rows this many times before repeating'),
-           tooltip=_('Length of the cycle by which successive stitch rows are staggered.'
+           tooltip=_('Length of the cycle by which successive stitch rows are staggered. '
                      'Fractional values are allowed and can have less visible diagonals than integer values.'),
            type='int',
            sort_index=6,
@@ -272,6 +272,8 @@ class FillStitch(EmbroideryElement):
             return shgeo.MultiPolygon([valid_shape])
         if isinstance(valid_shape, shgeo.LineString):
             return shgeo.MultiPolygon([])
+        if shape.area == 0:
+            return shgeo.MultiPolygon([])
 
         polygons = []
         for polygon in valid_shape.geoms:
@@ -713,12 +715,17 @@ class FillStitch(EmbroideryElement):
 
         # for an uncaught exception, give a little more info so that they can create a bug report
         message = ""
-        message += _("Error during autofill!  This means that there is a problem with Ink/Stitch.")
+        message += _("Error during autofill! This means it is a bug in Ink/Stitch.")
         message += "\n\n"
         # L10N this message is followed by a URL: https://github.com/inkstitch/inkstitch/issues/new
-        message += _("If you'd like to help us make Ink/Stitch better, please paste this whole message into a new issue at: ")
-        message += "https://github.com/inkstitch/inkstitch/issues/new\n\n"
-        message += version.get_inkstitch_version() + "\n\n"
+        message += _("If you'd like to help please\n"
+                     "- copy the entire error message below\n"
+                     "- save your SVG file and\n"
+                     "- create a new issue at")
+        message += " https://github.com/inkstitch/inkstitch/issues/new\n\n"
+        message += _("Include the error description and also (if possible) the svg file.")
+        message += '\n\n\n'
+        message += version.get_inkstitch_version() + '\n'
         message += traceback.format_exc()
 
         self.fatal(message)
diff --git a/lib/elements/satin_column.py b/lib/elements/satin_column.py
index 3a183ab0..0850d313 100644
--- a/lib/elements/satin_column.py
+++ b/lib/elements/satin_column.py
@@ -15,23 +15,11 @@ from shapely.ops import nearest_points
 from ..i18n import _
 from ..stitch_plan import StitchGroup
 from ..svg import line_strings_to_csp, point_lists_to_csp
-from ..utils import Point, cache, collapse_duplicate_point, cut
+from ..utils import Point, cache, cut, cut_multiple
 from .element import EmbroideryElement, param, PIXELS_PER_MM
 from .validation import ValidationError, ValidationWarning
 
 
-class SatinHasFillError(ValidationError):
-    name = _("Satin column has fill")
-    description = _("Satin column: Object has a fill (but should not)")
-    steps_to_solve = [
-        _("* Select this object."),
-        _("* Open the Fill and Stroke panel"),
-        _("* Open the Fill tab"),
-        _("* Disable the Fill"),
-        _("* Alternative: open Params and switch this path to Stroke to disable Satin Column mode")
-    ]
-
-
 class TooFewPathsError(ValidationError):
     name = _("Too few subpaths")
     description = _("Satin column: Object has too few subpaths.  A satin column should have at least two subpaths (the rails).")
@@ -185,7 +173,7 @@ class SatinColumn(EmbroideryElement):
     @param(
         'pull_compensation_percent',
         _('Pull compensation percentage'),
-        tooltip=_('Additional pull compensation which varries as a percentage of stitch width. '
+        tooltip=_('Additional pull compensation which varies as a percentage of stitch width. '
                   'Two values separated by a space may be used for an aysmmetric effect.'),
         unit='% (each side)',
         type='float',
@@ -390,24 +378,6 @@ class SatinColumn(EmbroideryElement):
     @cache
     def flattened_rungs(self):
         """The rungs, as LineStrings."""
-        rungs = []
-        for rung in self._raw_rungs:
-            # make sure each rung intersects both rails
-            if not rung.intersects(self.flattened_rails[0]) or not rung.intersects(self.flattened_rails[1]):
-                # the rung does not intersect both rails
-                # get nearest points on rungs
-                start = nearest_points(rung, self.flattened_rails[0])[1]
-                end = nearest_points(rung, self.flattened_rails[1])[1]
-                # extend from the nearest points just a little bit to make sure that we get an intersection
-                rung = shaffinity.scale(shgeo.LineString([start, end]), 1.01, 1.01)
-                rungs.append(rung)
-            else:
-                rungs.append(rung)
-        return tuple(rungs)
-
-    @property
-    @cache
-    def _raw_rungs(self):
         return tuple(shgeo.LineString(self.flatten_subpath(rung)) for rung in self.rungs)
 
     @property
@@ -431,21 +401,18 @@ class SatinColumn(EmbroideryElement):
         for rail in self.rails:
             points = self.strip_control_points(rail)
 
-            # ignore the start and end
-            points = points[1:-1]
+            if len(points) > 2:
+                # Don't bother putting rungs at the start and end.
+                points = points[1:-1]
+            else:
+                # But do include one at the start if we wouldn't add one otherwise.
+                # This avoids confusing other parts of the code.
+                points = points[:-1]
 
             rung_endpoints.append(points)
 
         rungs = []
         for start, end in zip(*rung_endpoints):
-            # Expand the points just a bit to ensure that shapely thinks they
-            # intersect with the rails even with floating point inaccuracy.
-            start = Point(*start)
-            end = Point(*end)
-            start, end = self.offset_points(start, end, (0.01, 0.01), (0, 0))
-            start = list(start)
-            end = list(end)
-
             rungs.append([[start, start, start], [end, end, end]])
 
         return rungs
@@ -498,39 +465,22 @@ class SatinColumn(EmbroideryElement):
             indices_by_length = sorted(list(range(num_paths)), key=lambda index: paths[index].length, reverse=True)
             return indices_by_length[:2]
 
-    def _cut_rail(self, rail, rung):
-        for segment_index, rail_segment in enumerate(rail[:]):
-            if rail_segment is None:
-                continue
-
-            intersection = rail_segment.intersection(rung)
-
-            # If there are duplicate points in a rung-less satin, then
-            # intersection will be a GeometryCollection of multiple copies
-            # of the same point.  This reduces it that to a single point.
-            intersection = collapse_duplicate_point(intersection)
-
-            if not intersection.is_empty:
-                cut_result = cut(rail_segment, rail_segment.project(intersection))
-                rail[segment_index:segment_index + 1] = cut_result
-
-                if cut_result[1] is None:
-                    # if we were exactly at the end of one of the existing rail segments,
-                    # stop here or we'll get a spurious second intersection on the next
-                    # segment
-                    break
-
     @property
     @cache
     def flattened_sections(self):
         """Flatten the rails, cut with the rungs, and return the sections in pairs."""
 
-        rails = [[rail] for rail in self.flattened_rails]
+        rails = list(self.flattened_rails)
         rungs = self.flattened_rungs
 
-        for rung in rungs:
-            for rail in rails:
-                self._cut_rail(rail, rung)
+        for i, rail in enumerate(rails):
+            cut_points = []
+
+            for rung in rungs:
+                point_on_rung, point_on_rail = nearest_points(rung, rail)
+                cut_points.append(rail.project(point_on_rail))
+
+            rails[i] = cut_multiple(rail, cut_points)
 
         for rail in rails:
             for i in range(len(rail)):
@@ -554,19 +504,15 @@ class SatinColumn(EmbroideryElement):
         return sections
 
     def validation_warnings(self):
-        for rung in self._raw_rungs:
+        for rung in self.flattened_rungs:
             for rail in self.flattened_rails:
                 intersection = rung.intersection(rail)
                 if intersection.is_empty:
                     yield DanglingRungWarning(rung.interpolate(0.5, normalized=True))
 
     def validation_errors(self):
-        # The node should have exactly two paths with no fill.  Each
-        # path should have the same number of points, meaning that they
-        # will both be made up of the same number of bezier curves.
-
-        if self.get_style("fill") is not None:
-            yield SatinHasFillError(self.shape.centroid)
+        # The node should have exactly two paths with the same number of points - or it should
+        # have two rails and at least one rung
 
         if len(self.rails) < 2:
             yield TooFewPathsError(self.shape.centroid)
@@ -574,7 +520,7 @@ class SatinColumn(EmbroideryElement):
             if len(self.rails[0]) != len(self.rails[1]):
                 yield UnequalPointsError(self.flattened_rails[0].interpolate(0.5, normalized=True))
         else:
-            for rung in self._raw_rungs:
+            for rung in self.flattened_rungs:
                 for rail in self.flattened_rails:
                     intersection = rung.intersection(rail)
                     if not intersection.is_empty and not isinstance(intersection, shgeo.Point):
@@ -732,14 +678,10 @@ class SatinColumn(EmbroideryElement):
 
         for path_list in path_lists:
             if len(path_list) in (2, 4):
-                # Add the rung just after the start of the satin.
-                rung_start = path_list[0].interpolate(0.1)
-                rung_end = path_list[1].interpolate(0.1)
+                # Add the rung at the start of the satin.
+                rung_start = path_list[0].coords[0]
+                rung_end = path_list[1].coords[0]
                 rung = shgeo.LineString((rung_start, rung_end))
-
-                # make it a bit bigger so that it definitely intersects
-                rung = shaffinity.scale(rung, 1.1, 1.1)
-
                 path_list.append(rung)
 
     def _path_list_to_satins(self, path_list):
@@ -781,7 +723,7 @@ class SatinColumn(EmbroideryElement):
 
         # don't contract beyond the midpoint, or we'll start expanding
         if offset_total < -distance:
-            scale = distance / offset_total
+            scale = -distance / offset_total
             offset_a = offset_a * scale
             offset_b = offset_b * scale
 
@@ -931,6 +873,7 @@ class SatinColumn(EmbroideryElement):
         # center line between the bezier curves.
 
         inset_prop = -np.array([self.center_walk_underlay_position, 100-self.center_walk_underlay_position]) / 100
+
         # Do it like contour underlay, but inset all the way to the center.
         forward, back = self.plot_points_on_rails(
             self.center_walk_underlay_stitch_length,
diff --git a/lib/elements/utils.py b/lib/elements/utils.py
index dafde759..f7ee8dbc 100644
--- a/lib/elements/utils.py
+++ b/lib/elements/utils.py
@@ -6,11 +6,11 @@
 from ..commands import is_command
 from ..marker import has_marker
 from ..svg.tags import (EMBROIDERABLE_TAGS, SVG_IMAGE_TAG, SVG_PATH_TAG,
-                        SVG_POLYLINE_TAG, SVG_TEXT_TAG)
-from .fill_stitch import FillStitch
+                        SVG_POLYGON_TAG, SVG_POLYLINE_TAG, SVG_TEXT_TAG)
 from .clone import Clone, is_clone
 from .element import EmbroideryElement
 from .empty_d_object import EmptyDObject
+from .fill_stitch import FillStitch
 from .image import ImageObject
 from .marker import MarkerObject
 from .polyline import Polyline
@@ -27,7 +27,8 @@ def node_to_elements(node, clone_to_element=False):  # noqa: C901
         # clone_to_element: get an actual embroiderable element once a clone has been defined as a clone
         return [Clone(node)]
 
-    elif node.tag == SVG_PATH_TAG and not node.get('d', ''):
+    elif ((node.tag == SVG_PATH_TAG and not node.get('d', None)) or
+          (node.tag in [SVG_POLYLINE_TAG, SVG_POLYGON_TAG] and not node.get('points', None))):
         return [EmptyDObject(node)]
 
     elif has_marker(node):
@@ -36,18 +37,17 @@ def node_to_elements(node, clone_to_element=False):  # noqa: C901
     elif node.tag in EMBROIDERABLE_TAGS or is_clone(node):
         element = EmbroideryElement(node)
 
-        if element.get_boolean_param("satin_column") and element.get_style("stroke"):
-            return [SatinColumn(node)]
-        else:
-            elements = []
-            if element.get_style("fill", "black") and not element.get_style('fill-opacity', 1) == "0":
-                elements.append(FillStitch(node))
-            if element.get_style("stroke"):
-                if not is_command(element.node):
-                    elements.append(Stroke(node))
-            if element.get_boolean_param("stroke_first", False):
-                elements.reverse()
-            return elements
+        elements = []
+        if element.get_style("fill", "black") and not element.get_style('fill-opacity', 1) == "0":
+            elements.append(FillStitch(node))
+        if element.get_style("stroke"):
+            if element.get_boolean_param("satin_column"):
+                elements.append(SatinColumn(node))
+            elif not is_command(element.node):
+                elements.append(Stroke(node))
+        if element.get_boolean_param("stroke_first", False):
+            elements.reverse()
+        return elements
 
     elif node.tag == SVG_IMAGE_TAG:
         return [ImageObject(node)]