Experimental path reordering, closes #13 (#98)

Author: sameer

Cargo.lock

@@ -92,6 +92,9 @@ struct Opt {
     ///
     /// Useful to print the label of layer on SVG generated by Inkscape
     extra_attribute_name: Option<String>,
+    #[arg(long)]
+    /// Reorder paths to minimize travel time
+    optimize_path_order: bool,
 }
 
 fn main() -> io::Result<()> {
@@ -168,6 +171,7 @@ fn main() -> io::Result<()> {
         }
 
         settings.conversion.extra_attribute_name = opt.extra_attribute_name;
+        settings.conversion.optimize_path_order = opt.optimize_path_order;
 
         if let Version::Unknown(ref unknown) = settings.version {
             error!(

cli/src/main.rs

@@ -12,6 +12,8 @@ serde = ["dep:serde", "dep:serde_repr", "g-code/serde"]
 
 [dependencies]
 g-code.workspace = true
+rand = "0.8"
+rustc-hash = "1"
 rust_decimal = { version = "1", default-features = false }
 lyon_geom = "=1.0.6"
 euclid = "0.22"

lib/Cargo.toml

@@ -12,7 +12,12 @@ use uom::si::{
 };
 
 use self::units::CSS_DEFAULT_DPI;
-use crate::{Machine, turtle::*};
+use crate::{
+    Machine, Turtle, tsp,
+    turtle::{
+        DpiConvertingTurtle, GCodeTurtle, PreprocessTurtle, StrokeCollectingTurtle, Terrarium,
+    },
+};
 
 #[cfg(feature = "serde")]
 mod length_serde;
@@ -36,6 +41,9 @@ pub struct ConversionConfig {
     pub origin: [Option<f64>; 2],
     /// Set extra attribute to add when printing node name
     pub extra_attribute_name: Option<String>,
+    /// Reorder paths to minimize travel time
+    #[cfg_attr(feature = "serde", serde(default))]
+    pub optimize_path_order: bool,
 }
 
 const fn zero_origin() -> [Option<f64>; 2] {
@@ -50,6 +58,7 @@ impl Default for ConversionConfig {
             dpi: 96.0,
             origin: zero_origin(),
             extra_attribute_name: None,
+            optimize_path_order: false,
         }
     }
 }
@@ -160,7 +169,7 @@ pub fn svg2program<'a, 'input: 'a>(
             dpi: config.dpi,
         }),
         _config: config,
-        options,
+        options: options.clone(),
         name_stack: vec![],
         viewport_dim_stack: vec![],
     };
@@ -169,7 +178,43 @@ pub fn svg2program<'a, 'input: 'a>(
         .terrarium
         .push_transform(origin_transform);
     conversion_visitor.begin();
-    visit::depth_first_visit(doc, &mut conversion_visitor);
+
+    if config.optimize_path_order {
+        // Collect strokes in machine space
+        let strokes = {
+            let mut collect_visitor = ConversionVisitor {
+                terrarium: Terrarium::new(DpiConvertingTurtle {
+                    inner: StrokeCollectingTurtle::default(),
+                    dpi: config.dpi,
+                }),
+                _config: config,
+                options,
+                name_stack: vec![],
+                viewport_dim_stack: vec![],
+            };
+            collect_visitor.terrarium.push_transform(origin_transform);
+            collect_visitor.begin();
+            visit::depth_first_visit(doc, &mut collect_visitor);
+            collect_visitor.end();
+            collect_visitor.terrarium.pop_transform();
+            collect_visitor.terrarium.turtle.inner.into_strokes()
+        };
+
+        // Optimize order
+        let strokes = tsp::minimize_travel_time(strokes);
+
+        // Replay reordered strokes into the g-code turtle
+        let turtle = &mut conversion_visitor.terrarium.turtle;
+        for stroke in strokes {
+            turtle.move_to(stroke.start_point());
+            for cmd in stroke.commands() {
+                cmd.apply(turtle);
+            }
+        }
+    } else {
+        visit::depth_first_visit(doc, &mut conversion_visitor);
+    }
+
     conversion_visitor.end();
     conversion_visitor.terrarium.pop_transform();
 

lib/src/converter/mod.rs

@@ -7,6 +7,8 @@ mod machine;
 /// Operations that are easier to implement while/after G-Code is generated, or would
 /// otherwise over-complicate SVG conversion
 mod postprocess;
+/// Reorders strokes to minimize pen-up travel using TSP heuristics
+mod tsp;
 /// Provides an interface for drawing lines in G-Code
 /// This concept is referred to as [Turtle graphics](https://en.wikipedia.org/wiki/Turtle_graphics).
 mod turtle;