Enable swap rail and reverse rail options for satin guide (#4083)

kaalleen · web-flow · commit 96261872c978 · 2025-12-14T14:04:24.000+01:00
diff --git a/lib/elements/stroke.py b/lib/elements/stroke.py
@@ -359,6 +359,19 @@ def reverse(self):
     def reverse_rails(self):
         return self.get_param('reverse_rails', 'automatic')
 
+    @property
+    @param(
+        'swap_satin_rails',
+        _('Swap rails'),
+        tooltip=_('Swaps the first and second rails of a satin ripple, '
+                  'affecting which side the thread finished on as well as any sided properties'),
+        type='boolean',
+        default='false',
+        select_items=[('stroke_method', 'ripple_stitch')],
+        sort_index=23)
+    def swap_rails(self):
+        return self.get_boolean_param('swap_satin_rails', False)
+
     @property
     @param('grid_size_mm',
            _('Grid size'),
@@ -367,7 +380,7 @@ def reverse_rails(self):
            default=0,
            unit='mm',
            select_items=[('stroke_method', 'ripple_stitch')],
-           sort_index=23)
+           sort_index=24)
     @cache
     def grid_size(self):
         return abs(self.get_float_param("grid_size_mm", 0))
@@ -379,7 +392,7 @@ def grid_size(self):
            type='boolean',
            default=False,
            select_items=[('stroke_method', 'ripple_stitch')],
-           sort_index=24)
+           sort_index=25)
     @cache
     def grid_first(self):
         return self.get_boolean_param("grid_first", False)
diff --git a/lib/stitches/ripple_stitch.py b/lib/stitches/ripple_stitch.py
@@ -252,6 +252,8 @@ def _get_staggered_stitches(stroke, lines, skip_start):
     random_seed = stroke.random_seed
     last_point = None
     for i, line in enumerate(lines):
+        if len(line) == 1:
+            continue
         connector = []
         if i != 0 and stroke.join_style == 0:
             if i % 2 == 0 or not stroke.flip_copies:
@@ -270,21 +272,10 @@ def _get_staggered_stitches(stroke, lines, skip_start):
                 line.reverse()
             stitched_line = running_stitch(line, stitch_length, tolerance, is_random, length_sigma, prng.join_args(random_seed, i))
         else:
-            if len(stitch_length) > 1:
-                points = list(
-                    apply_stagger(line, stitch_length, stroke.staggers, i, tolerance, is_random, length_sigma, prng.join_args(random_seed, i)).coords
-                )
-            else:
-                # uses the guided fill alforithm to stagger rows of stitches
-                points = list(apply_stitches(LineString(line), stitch_length, stroke.staggers, 0.5, i, tolerance).coords)
-
-            # simplifying the path in apply_stitches could have removed the start or end point
-            # we can simply add it again, the minimum stitch length value will take care to remove possible duplicates
-            points = [line[0]] + points + [line[-1]]
-
-            stitched_line = [InkstitchPoint(*point) for point in points]
-            if should_reverse and stroke.flip_copies:
-                stitched_line.reverse()
+            stitched_line = _stagger_line(
+                line, stitch_length, stroke.staggers, i, tolerance, is_random, length_sigma, prng.join_args(random_seed, i),
+                should_reverse, stroke.flip_copies
+            )
 
         stitched_line = connector + stitched_line
 
@@ -293,6 +284,25 @@ def _get_staggered_stitches(stroke, lines, skip_start):
     return stitches
 
 
+def _stagger_line(line, stitch_length, staggers, i, tolerance, is_random, length_sigma, random, should_reverse, flip_copies):
+    if len(stitch_length) > 1:
+        points = list(
+            apply_stagger(line, stitch_length, staggers, i, tolerance, is_random, length_sigma, random).coords
+        )
+    else:
+        # uses the guided fill alforithm to stagger rows of stitches
+        points = list(apply_stitches(LineString(line), stitch_length, staggers, 0.5, i, tolerance).coords)
+
+    # simplifying the path in apply_stitches could have removed the start or end point
+    # we can simply add it again, the minimum stitch length value will take care to remove possible duplicates
+    points = [line[0]] + points + [line[-1]]
+
+    stitched_line = [InkstitchPoint(*point) for point in points]
+    if should_reverse and flip_copies:
+        stitched_line.reverse()
+    return stitched_line
+
+
 def apply_stagger(line, stitch_length, num_staggers, row_num, tolerance, is_random, stitch_length_sigma, random_seed):
     if num_staggers == 0:
         num_staggers = 1  # sanity check to avoid division by zero.
@@ -591,6 +601,8 @@ def _get_start_rotation(line):
 
 def generate_satin_guide_helper_lines(stroke, outline, guide_line):
     anchor_line = stroke.get_anchor_line()
+    guide_line.node.set('inkstitch:reverse_rails', stroke.reverse_rails)
+    guide_line.node.set('inkstitch:swap_satin_rails', stroke.swap_rails)
     if anchor_line:
         # position, rotation and scale defined by anchor line
         outline0 = InkstitchPoint(*anchor_line.coords[0])
