svg2gcode 3.3.4__tar.gz → 3.3.6__tar.gz

{svg2gcode-3.3.4 → svg2gcode-3.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: svg2gcode
-Version: 3.3.4
+Version: 3.3.6
 Summary: svg2gcode: convert an SVG (Scalable Vector Graphic) image to gcode.
 Keywords: scalable vector graphics,svg,image,laser cutter,laser engraving
 Author-email: Johannes Noordanus <mailjohannes.mailnoordanus@gmail.com>
@@ -50,9 +50,7 @@ Currently only value *evenodd* of *fill-rule* is supported.
 
 ### *WYSIWYG*
 
-As seen above, not all *svg* elements are directly supported, but they are after a *path* conversion within the composer (Inkscape: ```menu Path->Object/Stroke to Path```). Without a *path* conversion *svg2gcode* simply ignores all elements except *path* and *image*. Text (fonts) require another step after *selecting* all text and clicking menu ```Object to Path```. Clicking ```menu Object->Ungroup``` generates a separate *path* for each letter which contains all relevant attributes. (Otherwise Inkscape uses a group tag ```<g``` to set some attributes for all letters within the text that are not repeated for each individual letter.)
-
-Note that the latest version of *svg2gcode* (3.3.3) has support for ```<g``` tags (attribute inheritance) and is able to correctly convert text without ```Ungroup```.
+As seen above, not all *svg* elements are directly supported, but they are after a *path* conversion within the composer (Inkscape: ```menu Path->Object/Stroke to Path```). Without a *path* conversion *svg2gcode* simply ignores all elements except *path* and *image*. Text (fonts) require another step after *selecting* all text and clicking menu ```Object to Path```. Clicking menu```Object->Ungroup``` <sup>(**)</sup> generates a separate *path* for each letter which contains all relevant attributes. (Otherwise Inkscape uses a group tag ```<g``` to set some attributes for all letters within the text that are not repeated for each individual letter.) 
 
 You can use *gcode2image* to check the conversion result:
 ```
@@ -61,12 +59,30 @@ You can use *gcode2image* to check the conversion result:
 ```
 The image shown should be the same as the one shown by the composer (Inkscape). This is also a good way to measure the conversion result. Note that ```--grid``` and ```--showorigin``` can give some inteference. To be sure run *gcode2image* without them.
 
-#### Notes:
+#### Contour & fill
+
+Inkscape translates a contour of a raster image to an outline and fill. So, if you create a contour via (select bitmap first) ```Path->Trace Bitmap...``` slide the ```Treshold``` of the Trace Bitmap menu to almost 1 (0,995) to make the entire bitmap image black (this is a bit *trial and error*, use ```Update preview``` to get the highest slider value before the whole images is black).
+
+You can look at the result xml tree via Inkscapes ```XML editor``` which now shows a path for the outline of the raster image and a style attribue like this:
+```
+style           fill:#000000;stroke-width:0.172652
+```
+To cut this outline, you can set the *fill* attribute to *none* (via the ```XML editor``` or menu ```Fill and Stroke```) and set a specific *stroke* color, for example *red*. The following command generates gcode to cut the outline.
+```
+> svg2gcode --color_coded "red = cut" contour.svg contour.gc
+```
+You can also engrave the whole bitmap image by setting a specific fill color (via menu ```Fill and Stroke```) (in this case there is no need to use option ```color_coded```)
+
+#### Notes
+
  - drawing objects - within the composer - must be converted to a```path```to be translated to a gcode sequence
  - image objects should **not** be converted to a ```path```
  - images must be linked or embedded using base64 (Inkscape default).
  - images can be in several formats (my tests included *.png* and  *.jpg* image files)
  - *SVG* source documents must be in unit 'mm' and set to ```1 'user unit' is 1 mm``` (Inkscape default)
+
+<sup>(**)</sup> Note that the latest version of *svg2gcode* (3.3.4) has support for ```<g``` tags (attribute inheritance) and is able to correctly convert text without ```Ungroup```.
+
 ### Important Commandline options
 
 Option ```--color_coded``` can be used to specify what part(s) of the drawing to cut, engrave or even ignore. 
@@ -314,11 +330,8 @@ Note: to get options and defaults:
     > svg2gcode --help
 ```
 #### How do we cut these lines?
-Change the *style* attribute line - within file *line_hoek.svg* - to the following:
-```
-    style="fill:none;stroke:none;stroke-width:.1"
-```
-or add 'gcode-pathcut' to the style string: 
+
+Add 'gcode-pathcut' to the style string: 
 ```
     style="fill:none;stroke:red;stroke-width:.1;gcode-pathcut:true"
 ```
@@ -368,3 +381,4 @@ One containing the drawings of the .svg, the other containing the images:
 
 Default *svg2gcode* uses constant burn mode *M3*. This can be changed by setting option *--no-constantburn* which selects burn mode *M4*. Mode *M4* is not suitable for engravings because it automatically compensates (laser)power for speed. This conflicts with the specific gcode settings given by *image2gcode* (called by *svg2gcode*) for each pixel. In fact some experiments show that *M4* causes loss of quality and image deterioration when speed is increased. On white oak images had too much black and grey which did not go away for substantially higher speed. When switched back to constant burn (*M3*) mode, the same high speed gave excellent images having a sepia (licht yellow brown) color tone.
 
+

{svg2gcode-3.3.4 → svg2gcode-3.3.6}/README.md

@@ -36,9 +36,7 @@ Currently only value *evenodd* of *fill-rule* is supported.
 
 ### *WYSIWYG*
 
-As seen above, not all *svg* elements are directly supported, but they are after a *path* conversion within the composer (Inkscape: ```menu Path->Object/Stroke to Path```). Without a *path* conversion *svg2gcode* simply ignores all elements except *path* and *image*. Text (fonts) require another step after *selecting* all text and clicking menu ```Object to Path```. Clicking ```menu Object->Ungroup``` generates a separate *path* for each letter which contains all relevant attributes. (Otherwise Inkscape uses a group tag ```<g``` to set some attributes for all letters within the text that are not repeated for each individual letter.)
-
-Note that the latest version of *svg2gcode* (3.3.3) has support for ```<g``` tags (attribute inheritance) and is able to correctly convert text without ```Ungroup```.
+As seen above, not all *svg* elements are directly supported, but they are after a *path* conversion within the composer (Inkscape: ```menu Path->Object/Stroke to Path```). Without a *path* conversion *svg2gcode* simply ignores all elements except *path* and *image*. Text (fonts) require another step after *selecting* all text and clicking menu ```Object to Path```. Clicking menu```Object->Ungroup``` <sup>(**)</sup> generates a separate *path* for each letter which contains all relevant attributes. (Otherwise Inkscape uses a group tag ```<g``` to set some attributes for all letters within the text that are not repeated for each individual letter.) 
 
 You can use *gcode2image* to check the conversion result:
 ```
@@ -47,12 +45,30 @@ You can use *gcode2image* to check the conversion result:
 ```
 The image shown should be the same as the one shown by the composer (Inkscape). This is also a good way to measure the conversion result. Note that ```--grid``` and ```--showorigin``` can give some inteference. To be sure run *gcode2image* without them.
 
-#### Notes:
+#### Contour & fill
+
+Inkscape translates a contour of a raster image to an outline and fill. So, if you create a contour via (select bitmap first) ```Path->Trace Bitmap...``` slide the ```Treshold``` of the Trace Bitmap menu to almost 1 (0,995) to make the entire bitmap image black (this is a bit *trial and error*, use ```Update preview``` to get the highest slider value before the whole images is black).
+
+You can look at the result xml tree via Inkscapes ```XML editor``` which now shows a path for the outline of the raster image and a style attribue like this:
+```
+style           fill:#000000;stroke-width:0.172652
+```
+To cut this outline, you can set the *fill* attribute to *none* (via the ```XML editor``` or menu ```Fill and Stroke```) and set a specific *stroke* color, for example *red*. The following command generates gcode to cut the outline.
+```
+> svg2gcode --color_coded "red = cut" contour.svg contour.gc
+```
+You can also engrave the whole bitmap image by setting a specific fill color (via menu ```Fill and Stroke```) (in this case there is no need to use option ```color_coded```)
+
+#### Notes
+
  - drawing objects - within the composer - must be converted to a```path```to be translated to a gcode sequence
  - image objects should **not** be converted to a ```path```
  - images must be linked or embedded using base64 (Inkscape default).
  - images can be in several formats (my tests included *.png* and  *.jpg* image files)
  - *SVG* source documents must be in unit 'mm' and set to ```1 'user unit' is 1 mm``` (Inkscape default)
+
+<sup>(**)</sup> Note that the latest version of *svg2gcode* (3.3.4) has support for ```<g``` tags (attribute inheritance) and is able to correctly convert text without ```Ungroup```.
+
 ### Important Commandline options
 
 Option ```--color_coded``` can be used to specify what part(s) of the drawing to cut, engrave or even ignore. 
@@ -300,11 +316,8 @@ Note: to get options and defaults:
     > svg2gcode --help
 ```
 #### How do we cut these lines?
-Change the *style* attribute line - within file *line_hoek.svg* - to the following:
-```
-    style="fill:none;stroke:none;stroke-width:.1"
-```
-or add 'gcode-pathcut' to the style string: 
+
+Add 'gcode-pathcut' to the style string: 
 ```
     style="fill:none;stroke:red;stroke-width:.1;gcode-pathcut:true"
 ```
@@ -353,3 +366,4 @@ One containing the drawings of the .svg, the other containing the images:
 ### Burn mode M3/M4:
 
 Default *svg2gcode* uses constant burn mode *M3*. This can be changed by setting option *--no-constantburn* which selects burn mode *M4*. Mode *M4* is not suitable for engravings because it automatically compensates (laser)power for speed. This conflicts with the specific gcode settings given by *image2gcode* (called by *svg2gcode*) for each pixel. In fact some experiments show that *M4* causes loss of quality and image deterioration when speed is increased. On white oak images had too much black and grey which did not go away for substantially higher speed. When switched back to constant burn (*M3*) mode, the same high speed gave excellent images having a sepia (licht yellow brown) color tone.
+

{svg2gcode-3.3.4 → svg2gcode-3.3.6}/svg2gcode/__init__.py

@@ -1,4 +1,4 @@
 """
 svg2gcode: convert an SVG (Scalable Vector Graphic) image to gcode.
 """
-__version__ = "3.3.4"
+__version__ = "3.3.6"

{svg2gcode-3.3.4 → svg2gcode-3.3.6}/svg2gcode/svg_to_gcode/compiler/_compiler.py

@@ -19,7 +19,7 @@ from svg2gcode.svg_to_gcode import DEFAULT_SETTING
 from svg2gcode.svg_to_gcode import TOLERANCES, SETTING, check_setting
 
 from svg2gcode.svg_to_gcode import css_color
-from svg2gcode.svg_to_gcode.svg_parser import NAMESPACES, ElementTree_MY_PARENT
+from svg2gcode.svg_to_gcode.svg_parser import NAMESPACES, ElementTreeParent
 
 from svg2gcode import __version__
 
@@ -483,13 +483,13 @@ class Compiler:
             style['pathcut'] = curve.path_attrib['gcode_pathcut']
 
         # check missing attributes, if any
-        if ElementTree_MY_PARENT in curve.path_attrib:
-            parent = curve.path_attrib[ElementTree_MY_PARENT]
+        if ElementTreeParent in curve.path_attrib:
+            parent = curve.path_attrib[ElementTreeParent]
 
-            # find first parent g (group) tag, if any
+            # find first parent <g (group) tag, if any
             while parent and parent.tag != "{%s}g" % NAMESPACES["svg"]:
-                if ElementTree_MY_PARENT in parent.attrib:
-                    parent = parent.attrib[ElementTree_MY_PARENT]
+                if ElementTreeParent in parent.attrib:
+                    parent = parent.attrib[ElementTreeParent]
                 else:
                     parent = None
             if parent:
@@ -671,7 +671,7 @@ class Compiler:
         def get_style_info_of_line_chain(line_chain: LineSegmentChain) -> ():
             """
             Get style info of line_chain.
-            Returns tuple (stroke_width, stroke_color, stroke_alpha, fill_color, fill_alpha, fill_rule)
+            Returns tuple (stroke_width, stroke_color, stroke_alpha, fill_color, fill_alpha, fill_rule, pathcut)
             """
             # defaults
             stroke_width = 0
@@ -685,8 +685,7 @@ class Compiler:
             first_line_of_chain = line_chain.get(0)
             style = self.parse_style_attribute(first_line_of_chain)
             if style:
-                if not (style['pathcut'] == 'true' or self.settings["pathcut"]) \
-                    and style['stroke'] is not None and style['stroke'] != "none":
+                if style['stroke'] is not None and style['stroke'] != "none":
                     stroke_color = style['stroke']
                     if style['stroke-opacity'] is not None:
                         # fill opacity attribute overrides rgba property
@@ -721,7 +720,7 @@ class Compiler:
                             fill_alpha = rgba[3]
                     fill_color = round(fill_color * fill_alpha)
 
-            return (stroke_width, stroke_color, stroke_alpha, fill_color, fill_alpha, fill_rule)
+            return (stroke_width, stroke_color, stroke_alpha, fill_color, fill_alpha, fill_rule, style['pathcut'])
 
 
         path_curves = {}
@@ -776,9 +775,13 @@ class Compiler:
             # Render svg 'stroke' attribute
             for line_chain in path_curves[name_id]:
                 # get style info
-                stroke_width, stroke_color, stroke_alpha, fill_color, fill_alpha, fill_rule = get_style_info_of_line_chain(line_chain)
+                stroke_width, stroke_color, stroke_alpha, fill_color, fill_alpha, fill_rule, style_pathcut = get_style_info_of_line_chain(line_chain)
 
-                if len(stroke_color):
+                if (style_pathcut is not None and style_pathcut == 'true') or self.settings["pathcut"]:
+                    # cut path
+                    self.body.extend([f"\n; cut path (pathcut set) '{name_id}'"])
+                    render_pathwidth(line_chain, [0], None, None, boundingbox)
+                elif len(stroke_color):
 
                     # Get stroke alpha channel (opacity)
                     # fill opacity attribute overrides rgba property
@@ -840,13 +843,12 @@ class Compiler:
                                     if not (delta == stroke_width and stroke_width % 2 != 0):
                                         steps.append(round(-delta * pixel_size, self.precision))
 
-                        # color_coded isn't set: with path color engrave path
-                        self.body.extend([f"\n; engrave path '{name_id}', color '{stroke_color}'"])
+                        # color_coded isn't set: engrave path with stroke color
+                        self.body.extend([f"\n; default action: engrave path '{name_id}', color '{stroke_color}'"])
                         render_pathwidth(line_chain, steps, inverse_bw, speed, boundingbox)
                 else:
-                    # line stroke isn't set: ignore path
-                    self.body.extend([f"\n; no stroke color set: ignore path '{name_id}'"])
-                    #render_pathwidth(line_chain, [0], None, None, boundingbox)
+                    # cannot engrave path (ignore)
+                    self.body.extend([f"\n; cannot engrave path (ignore) no stroke color set: path '{name_id}'"])
 
             # Render svg 'fill' attribute
             #if not self.settings["nofill"] and fill_color is not None and boundingbox.get() is not None: