Merge pull request #18 from plottertools/inversion-xy

Restore Invert X and Y

Author: tatarize

README.md

@@ -79,6 +79,8 @@ These parameters define the transformation between *vpype*'s and the target's co
 - `scale_y`: Apply a scaling factor on the Y axis. Use `-1` to invert the direction.
 - `offset_x`: Apply an offset to the X axis. This offset is expressed in the unit defined by `unit`.
 - `offset_y`: Apply an offset to the Y axis. This offset is expressed in the unit defined by `unit`.
+- `invert_x`: Invert or mirror all points right-to-left without changing the position within the document space.
+- `invert_y`: Invert or mirror all points top-to-bottom without changing the position within the document space.
 
 ### Output Format
 All of the options below default to an empty text which means no output is generated. However, if `segment_first` or `segment_last` is omitted the code from `segment` is used. If there is only one segment, `segment_first` takes priority over `segment_last`.
@@ -119,6 +121,8 @@ The segments accept a lot of values that may be useful statistics for various fo
 
 Note: `idx` and `idy` are properly guarded against compounding fractional rounding errors. Moving 0.1 units 1000 times results in a location 100 units away and not zero.
 
+### Information Control
+- `info`: prints text after file is written to inform the user of said information
 
 ## Output structure
 The gwrite command gives you access to write to a variety of formats that fit the given outline. We're writing generic ascii. Since gcode can have more flavors than a Baskin Robbins™, it's best to simply draw broad strokes as to what ascii output should look like. Here we define the various elements without any regard to the gcode it will largely be producing.
@@ -284,3 +288,4 @@ Which is valid JSON.
 # Thanks
 * abey76 - Helped with advice that largely pushes us towards the integration goals as well as his very solid suggestion to use .format() which greatly expands the expected formats.
 * theomega - Basically rewrote the thing into the dapper codebase you see today. Rather than the 4 hours I figured I'd kill on this.
+* ithinkido - For his many insightful comments and determination to make this project as good as it can be.

setup.py

@@ -5,7 +5,7 @@
 
 setup(
     name="vpype-gcode",
-    version="0.9.1",
+    version="0.10.0",
     description="vpype gcode plugin",
     long_description=readme,
     long_description_content_type="text/markdown",
@@ -16,6 +16,11 @@
     classifiers=(
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Environment :: Console",
+        "Topic :: Artistic Software",
+        "Topic :: Multimedia :: Graphics",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
     ),

vpype_gcode/bundled_configs.toml

@@ -5,20 +5,26 @@ segment_first = "G00 X{x:.4f} Y{y:.4f}\n"
 segment = "G01 X{x:.4f} Y{y:.4f}\n"
 document_end = "M2\n"
 unit = "in"
+invert_y = "True"
+info= "This gcode profile is correctly inverted across the y-axis"
 
 [gwrite.gcodemm]
 document_start = "G21\nG17\nG90\n"
 segment_first = "G00 X{x:.4f} Y{y:.4f}\n"
 segment = "G01 X{x:.4f} Y{y:.4f}\n"
 document_end = "M2\n"
 unit = "mm"
+invert_y = "True"
+info= "This gcode profile is correctly inverted across the y-axis"
 
 [gwrite.gcode_relative]
 document_start = "G20\nG17\nG91\n"
 segment_first = "G00 X{dx:.4f} Y{dy:.4f}\n"
 segment = "G01 X{dx:.4f} Y{dy:.4f}\n"
 document_end = "M2\n"
 unit = "in"
+invert_y = "True"
+info= "This gcode profile is correctly inverted across the y-axis"
 
 [gwrite.csv]
 document_start = "#Operation, X-value, Y-value\n"

vpype_gcode/gwrite.py

@@ -6,9 +6,33 @@
 import vpype as vp
 
 # Load the default config
+
 vp.CONFIG_MANAGER.load_config_file(str(Path(__file__).parent / "bundled_configs.toml"))
 
 
+def invert_axis(document: vp.Document, invert_x: bool, invert_y: bool):
+    """Inverts none, one or both axis of the document.
+    This applies a relative scale operation with factors of 1 or -1
+    on the two axis to all layers. The inversion happens relative to
+    the center of the bounds.
+    """
+
+    bounds = document.bounds()
+    if not bounds:
+        return document
+
+    origin = (
+        0.5 * (bounds[0] + bounds[2]),
+        0.5 * (bounds[1] + bounds[3]),
+    )
+
+    document.translate(-origin[0], -origin[1])
+    document.scale(-1 if invert_x else 1, -1 if invert_y else 1)
+    document.translate(origin[0], origin[1])
+
+    return document
+
+
 @click.command()
 @click.argument("output", type=click.File("w"))
 @click.option(
@@ -21,6 +45,12 @@
 )
 @vp.global_processor
 def gwrite(document: vp.Document, output: typing.TextIO, profile: str):
+    """
+    Write gcode or other ascii files for the vpype pipeline.
+
+    The output format can be customized by the user heavily to an extent that you can also output most known
+    non-gcode ascii text files.
+    """
     gwrite_config = vp.CONFIG_MANAGER.config["gwrite"]
 
     # If no profile was provided, try to use a default
@@ -73,6 +103,12 @@ def gwrite(document: vp.Document, output: typing.TextIO, profile: str):
     document.scale(scale_x / unit_scale, scale_y / unit_scale)
     document.translate(offset_x, offset_y)
 
+    invert_x = config.get("invert_x", False)
+    invert_y = config.get("invert_y", False)
+    # transform the document according to inversion parameters
+    if invert_x or invert_y:
+        document = invert_axis(document, invert_x, invert_y)
+
     # process file
     filename = output.name
     if document_start is not None:
@@ -187,7 +223,9 @@ def gwrite(document: vp.Document, output: typing.TextIO, profile: str):
         output.write(document_end.format(filename=filename))
     output.flush()
     output.close()
-
+    info = config.get("info", None)
+    if info:
+        print(info)
     return orig_document