Fix for #158, bringing SP up to date on OpenSCAD's built-in color and alpha handling. Bumping version to 1.0.4.

Author: Evan Jones

README.rst

@@ -387,38 +387,18 @@ See
 `solid/examples/path_extrude_example.py <https://github.com/SolidCode/SolidPython/blob/master/solid/examples/path_extrude_example.py>`__
 for use.
 
-Basic color library
+Color & Transparency Settings
 -------------------
 
 You can change an object's color by using the OpenSCAD
-``color([rgba_array])`` function:
+``color([rgba_array | rgba hex | SVG color name], alpha)`` function:
 
 .. code:: python
 
     transparent_blue = color([0,0,1, 0.5])(cube(10))  # Specify with RGB[A]
-    red_obj = color(Red)(cube(10))                    # Or use predefined colors
-
-These colors are pre-defined in solid.utils:
-
-+------------+---------+--------------+
-| Red        | Green   |  Blue        |
-+------------+---------+--------------+
-| Cyan       | Magenta |  Yellow      |
-+------------+---------+--------------+
-| Black      | White   |  Transparent |
-+------------+---------+--------------+
-| Oak        | Pine    |  Birch       |
-+------------+---------+--------------+
-| Iron       | Steel   |  Stainless   |
-+------------+---------+--------------+
-| Aluminum   | Brass   |  BlackPaint  |
-+------------+---------+--------------+
-| FiberBoard |         |              |
-+------------+---------+--------------+
-
-They're a conversion of the materials in the `MCAD OpenSCAD
-library <https://github.com/openscad/MCAD>`__, as seen [here]
-(https://github.com/openscad/MCAD/blob/master/materials.scad).
+    purple_obj = color('MediumPurple')(cube(10))      # Or use predefined SVG colors
+
+OpenSCAD natively accepts the W3C's `SVG Color Names <https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#color>`__
 
 Bill Of Materials
 -----------------

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "solidpython"
-version = "1.0.3"
+version = "1.0.4"
 description = "Python interface to the OpenSCAD declarative geometry language"
 authors = ["Evan Jones <evan_t_jones@mac.com>"]
 homepage = "https://github.com/SolidCode/SolidPython"

solid/objects.py

@@ -376,11 +376,14 @@ class color(OpenSCADObject):
     not specified.
 
     :param c: RGB color + alpha value.
-    :type c: sequence of 3 or 4 numbers between 0 and 1
+    :type c: sequence of 3 or 4 numbers between 0 and 1, OR 3-, 4-, 6-, or 8-digit RGB/A hex code, OR string color name as described at https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#color
+
+    :param alpha: Alpha value from 0 to 1
+    :type alpha: float 
     """
 
-    def __init__(self, c: Vec34) -> None:
-        super().__init__('color', {'c': c})
+    def __init__(self, c: Union[Vec34, str], alpha: float = 1.0) -> None:
+        super().__init__('color', {'c': c, 'alpha': alpha})
 
 
 class minkowski(OpenSCADObject):

solid/test/test_solidpython.py

@@ -36,7 +36,6 @@
     {'name': 'mirror', 'class': 'mirror' , 'kwargs': {}, 'expected': '\n\nmirror(v = [0, 0, 1]);', 'args': {'v': [0, 0, 1]}, },
     {'name': 'resize', 'class': 'resize' , 'kwargs': {'newsize': [5, 5, 5], 'auto': [True, True, False]}, 'expected': '\n\nresize(auto = [true, true, false], newsize = [5, 5, 5]);', 'args': {}, },
     {'name': 'multmatrix', 'class': 'multmatrix' , 'kwargs': {}, 'expected': '\n\nmultmatrix(m = [[1, 0, 0, 0], [0, 1, 0, 0], [0, 0, 1, 0], [0, 0, 0, 1]]);', 'args': {'m': [[1, 0, 0, 0], [0, 1, 0, 0], [0, 0, 1, 0], [0, 0, 0, 1]]}, },
-    {'name': 'color', 'class': 'color' , 'kwargs': {}, 'expected': '\n\ncolor(c = [1, 0, 0]);', 'args': {'c': [1, 0, 0]}, },
     {'name': 'minkowski', 'class': 'minkowski' , 'kwargs': {}, 'expected': '\n\nminkowski();', 'args': {}, },
     {'name': 'offset', 'class': 'offset' , 'kwargs': {'r': 1}, 'expected': '\n\noffset(r = 1);', 'args': {}, },
     {'name': 'offset_segments', 'class': 'offset' , 'kwargs': {'r': 1, 'segments': 12}, 'expected': '\n\noffset($fn = 12, r = 1);', 'args': {}, },
@@ -114,7 +113,7 @@ def test_infix_intersection(self):
 
     def test_parse_scad_callables(self):
         test_str = """
-                    module hex (width=10, height=10,    
+                    module hex (width=10, height=10,
                                 flats= true, center=false){}
                     function righty (angle=90) = 1;
                     function lefty(avar) = 2;
@@ -215,11 +214,11 @@ def test_import_scad(self):
         self.assertTrue(hasattr(examples.scad_to_include, 'steps'))
 
         # TODO: we should test that:
-        # A) scad files in the designated OpenSCAD library directories 
-        #       (path-dependent, see: solid.objects._openscad_library_paths()) 
+        # A) scad files in the designated OpenSCAD library directories
+        #       (path-dependent, see: solid.objects._openscad_library_paths())
         #       are imported correctly. Not sure how to do this without writing
         #       temp files to those directories. Seems like overkill for the moment
-        
+
     def test_imported_scad_arguments(self):
         include_file = self.expand_scad_path("examples/scad_to_include.scad")
         mod = import_scad(include_file)
@@ -229,7 +228,7 @@ def test_imported_scad_arguments(self):
         abs_path = points._get_include_path(include_file)
         expected = f'use <{abs_path}>\n\n\npolygon(points = scad_points());'
         self.assertEqual(expected, actual)
-        
+
     def test_use_reserved_words(self):
         scad_str = '''module reserved_word_arg(or=3){\n\tcube(or);\n}\nmodule or(arg=3){\n\tcube(arg);\n}\n'''
 
@@ -297,6 +296,25 @@ def test_root(self):
         actual = scad_render(root(a))
         self.assertEqual(expected, actual)
 
+    def test_color(self):
+        all_args = [
+            {'c': [1, 0, 0]},
+            {'c': [1, 0, 0], 'alpha': 0.5},
+            {'c': "#66F"},
+            {'c': "Teal", 'alpha': 0.5},
+        ]
+
+        expecteds = [
+            '\n\ncolor(alpha = 1.0000000000, c = [1, 0, 0]);',
+            '\n\ncolor(alpha = 0.5000000000, c = [1, 0, 0]);',
+            '\n\ncolor(alpha = 1.0000000000, c = "#66F");',
+            '\n\ncolor(alpha = 0.5000000000, c = "Teal");',
+        ]
+        for args, expected in zip(all_args, expecteds):
+            col = color(**args)
+            actual = scad_render(col)
+            self.assertEqual(expected, actual)
+
     def test_explicit_hole(self):
         a = cube(10, center=True) + hole()(cylinder(2, 20, center=True))
         expected = '\n\ndifference(){\n\tunion() {\n\t\tcube(center = true, size = 10);\n\t}\n\t/* Holes Below*/\n\tunion(){\n\t\tcylinder(center = true, h = 20, r = 2);\n\t} /* End Holes */ \n}'

solid/utils.py

@@ -52,6 +52,8 @@
 # ==========
 # = Colors =
 # ========== 
+# Deprecated, but kept for backwards compatibility . Note that OpenSCAD natively
+# accepts SVG Color names, as seen here: https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Transformations#color
 # From Hans Häggström's materials.scad in MCAD: https://github.com/openscad/MCAD
 Red         = (1, 0, 0)
 Green       = (0, 1, 0)