Add readme and demos

Author: adriandieter

orx-g-code/README.md

@@ -0,0 +1,46 @@
+# orx-g-code
+
+Utilities for generating *g-code* from compositions. 
+
+>*Make sure to verify compatibility to your hardware and that the
+commands do not exceed the machines limits before running any output of this.*
+
+## Generator
+
+A [Generator](src/commonMain/kotlin/Generator.kt) generates g-code for the following operations:
+- `setup`: Setup code at the beginning of a file.
+- `moveTo`: A move operation to the given location.
+- `preDraw`: Start drawing sequence. Pen down, laser on, etc.
+- `drawTo`: A draw operation to the given location.
+- `postDraw`: End draw sequence. Lift pen, turn laser off, etc.
+- `end`: End of file sequence.
+- `comment`: Insert a comment.
+
+These are used by the `toCommands()` extensions in [shape.kt](src/commonMain/kotlin/shape.kt) to convert a composition
+to a set of Commands. 
+
+It only supports absolute moves, so `G90 absolute positioning` should be included in the setup.
+
+`basicGrblSetup` defines an example that outputs g-code, which *should be*
+compatible with [grbl v1.1](https://github.com/grbl/grbl).
+
+See [DemoGcodeGenerator.kt](src/demo/kotlin/DemoGcodeGenerator.kt) for an example of how to use.
+
+## Plot (jvm only)
+
+The [Plot Extension](src/jvmMain/kotlin/Plot.kt) provides a quick setup for drawing, rendering and exporting files for
+a pen plotter. 
+See [DemoSimplePlot.kt](src/demo/kotlin/DemoSimplePlot.kt) for an example of how to use.
+
+
+<!-- __demos__ -->
+## Demos
+### DemoInteractivePlot
+[source code](src/demo/kotlin/DemoInteractivePlot.kt)
+
+![DemoInteractivePlotKt](https://raw.githubusercontent.com/openrndr/orx/media/orx-g-code/images/DemoInteractivePlotKt.png)
+
+### DemoSimplePlot
+[source code](src/demo/kotlin/DemoSimplePlot.kt)
+
+![DemoSimplePlotKt](https://raw.githubusercontent.com/openrndr/orx/media/orx-g-code/images/DemoSimplePlotKt.png)

orx-g-code/images/DemoInteractivePlotKt.png

@@ -0,0 +1,64 @@
+import org.openrndr.application
+import org.openrndr.drawComposition
+import org.openrndr.extra.gcode.asCommands
+import org.openrndr.extra.gcode.basicGrblSetup
+import org.openrndr.extra.gcode.extensions.toCommands
+import org.openrndr.extra.gcode.toGcode
+import org.openrndr.extra.gcode.withoutDuplicates
+
+fun main() = application {
+    configure {
+        width = 800
+        height = 800
+    }
+
+    program {
+
+        val generator = basicGrblSetup(drawRate = 500.0).copy(
+            preDraw = (40..80 step 5).flatMap { listOf("M3 S$it", "G4 P0.08") },
+            postDraw = "M3 S40".asCommands(),
+        )
+
+        val comp = drawComposition {
+            lineSegment(10.0, 10.0, 20.0, 20.0)
+        }
+
+        // Convert composition to g-code, print to console and exit
+        val commands = generator.setup + comp.toCommands(generator, 0.05) + generator.end
+        val gCode = commands.withoutDuplicates().toGcode()
+        println(gCode)
+        application.exit()
+
+        /* Output:
+        G21
+        G90
+        ;begin composition
+        ;begin shape: 0
+        G0 X10.0 Y10.0
+        M3 S40
+        G4 P0.08
+        M3 S45
+        G4 P0.08
+        M3 S50
+        G4 P0.08
+        M3 S55
+        G4 P0.08
+        M3 S60
+        G4 P0.08
+        M3 S65
+        G4 P0.08
+        M3 S70
+        G4 P0.08
+        M3 S75
+        G4 P0.08
+        M3 S80
+        G4 P0.08
+        G1 X20.0 Y20.0 F500.0
+        M3 S40
+        ;end shape: 0
+        ;end composition
+        G0 X0 Y0
+        G90
+        */
+    }
+}

orx-g-code/images/DemoSimplePlotKt.png

@@ -0,0 +1,64 @@
+import org.openrndr.MouseEvent
+import org.openrndr.application
+import org.openrndr.extensions.Screenshots
+import org.openrndr.extra.gcode.Plot
+import org.openrndr.extra.gcode.basicGrblSetup
+import org.openrndr.math.Vector2
+import org.openrndr.shape.ContourBuilder
+
+fun main() = application {
+    configure {
+        width = 600
+        height = 800
+    }
+
+    program {
+        extend(Screenshots())
+
+        val plot = Plot(dimensions = Vector2(210.0, 297.0), manualRedraw = false)
+        extend(plot) {
+            generator = basicGrblSetup()
+
+            // Set output files to be exported to tmp
+            // "g" to export g-code.
+            folder = "/tmp"
+        }
+
+        val drawingArea = plot.docBounds.offsetEdges(-10.0)
+
+        // Converts mouse events position to document space
+        fun MouseEvent.documentPosition(): Vector2 {
+            val s = 1 / plot.scale()
+            return Vector2(position.x * s, plot.docBounds.height - position.y * s)
+        }
+
+
+        val cb = ContourBuilder(true)
+
+        // Handle mouse events and restrict drawing to drawing area
+        mouse.buttonDown.listen {
+            val p = it.documentPosition()
+            if (drawingArea.contains(p)) {
+                cb.moveTo(p)
+            } else {
+                cb.moveTo(drawingArea.contour.nearest(p).position)
+            }
+        }
+        mouse.dragged.listen {
+            val p = it.documentPosition()
+            if (drawingArea.contains(p)) {
+                cb.moveOrLineTo(p)
+            } else {
+                cb.moveOrLineTo(drawingArea.contour.nearest(p).position)
+            }
+        }
+
+        // Draw contours of contour builder on every frame
+        extend {
+            plot.layer("drawing") {
+                strokeWeight = .5
+                contours(cb.result)
+            }
+        }
+    }
+}

orx-g-code/src/demo/kotlin/DemoGcodeGenerator.kt

@@ -0,0 +1,46 @@
+import org.openrndr.application
+import org.openrndr.color.ColorRGBa
+
+import org.openrndr.extra.gcode.LayerMode
+import org.openrndr.extra.gcode.Plot
+
+import org.openrndr.extra.gcode.basicGrblSetup
+
+import org.openrndr.math.Vector2
+
+fun main() = application {
+    configure {
+        width = 800
+        height = 800
+    }
+
+    program {
+
+
+        // A4 Portrait
+        extend(Plot(dimensions = Vector2(210.0, 297.0))) {
+            generator = basicGrblSetup()
+
+            // Export each layer to separate file
+            layerMode = LayerMode.MULTI_FILE
+
+            // Set output files to be exported to tmp
+            // "g" to export g-code.
+            folder = "/tmp"
+
+            draw {
+                // Rectangle in default layer
+                rectangle(docBounds.offsetEdges(-10.0))
+            }
+
+            layer("circles") {
+                // Stroke changes do not affect g-code
+                stroke = ColorRGBa.PINK
+                strokeWeight = .5
+                (10..90 step 10).forEach { r ->
+                    circle(docBounds.center, r.toDouble())
+                }
+            }
+        }
+    }
+}