Add parameter transparency to material appearance - issue 4252 (#4278)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Maxime Rey <[email protected]>
Co-authored-by: Kathy Pippert <[email protected]>
Co-authored-by: Massimo Capodiferro <[email protected]>
Co-authored-by: maxcapodi78 <Shark78>

Author: 5 people

_unittest/test_03_Materials.py

@@ -92,14 +92,18 @@ def test_02_create_material(self):
         assert mat1.get_curve_coreloss_type() == "Power Ferrite"
         assert isinstance(mat1.material_appearance, list)
 
-        mat1.material_appearance = [11, 22, 0]
-        assert mat1.material_appearance == [11, 22, 0]
-        mat1.material_appearance = ["11", "22", "10"]
-        assert mat1.material_appearance == [11, 22, 10]
+        mat1.material_appearance = [11, 22, 0, 0.5]
+        assert mat1.material_appearance == [11, 22, 0, 0.5]
+        mat1.material_appearance = ["11", "22", "10", "0.5"]
+        assert mat1.material_appearance == [11, 22, 10, 0.5]
         with pytest.raises(ValueError):
-            mat1.material_appearance = [11, 22, 300]
+            mat1.material_appearance = [11, 22, 300, 0.5]
         with pytest.raises(ValueError):
-            mat1.material_appearance = [11, -22, 0]
+            mat1.material_appearance = [11, 22, 100, 1.5]
+        with pytest.raises(ValueError):
+            mat1.material_appearance = [11, -22, 0, 0.5]
+        with pytest.raises(ValueError):
+            mat1.material_appearance = [11, 22, 0, -1]
         with pytest.raises(ValueError):
             mat1.material_appearance = [11, 22]
 

examples/02-HFSS/HFSS_Choke.py

@@ -12,7 +12,7 @@
 import os
 import pyaedt
 
-project_name = pyaedt.generate_unique_project_name(project_name="choke")
+project_name = pyaedt.generate_unique_project_name(rootname=r"C:\Data\Support\Test", folder_name="choke", project_name="choke")
 
 ##########################################################
 # Set AEDT version

pyaedt/modules/Material.py

@@ -1301,13 +1301,15 @@ def __init__(self, materiallib, name, props=None, material_update=True):
             self._material_appearance.append(self._props["AttachedData"]["MatAppearanceData"]["Red"])
             self._material_appearance.append(self._props["AttachedData"]["MatAppearanceData"]["Green"])
             self._material_appearance.append(self._props["AttachedData"]["MatAppearanceData"]["Blue"])
+            self._material_appearance.append(self._props["AttachedData"]["MatAppearanceData"].get("Transparency", 0.0))
         else:
             vals = list(CSS4_COLORS.values())
             if (materiallib._color_id) >= len(vals):
                 materiallib._color_id = 0
             h = vals[materiallib._color_id].lstrip("#")
             self._material_appearance = list(int(h[i : i + 2], 16) for i in (0, 2, 4))
             materiallib._color_id += 1
+            self._material_appearance.append(0)
             self._props["AttachedData"] = OrderedDict(
                 {
                     "MatAppearanceData": OrderedDict(
@@ -1316,6 +1318,7 @@ def __init__(self, materiallib, name, props=None, material_update=True):
                             "Red": self._material_appearance[0],
                             "Green": self._material_appearance[1],
                             "Blue": self._material_appearance[2],
+                            "Transparency": self._material_appearance[3],
                         }
                     )
                 }
@@ -1366,46 +1369,61 @@ def _update_material(self):
 
     @property
     def material_appearance(self):
-        """Material Appearance specified as an RGB list.
+        """Material appearance specified as a list where the first three items are
+        RGB color and the fourth one is transparency.
 
         Returns
         -------
         list
-            Color of the material in RGB.  Values are in the range ``[0, 255]``.
+            Color of the material in RGB and transparency.
+            Color values are in the range ``[0, 255]``.
+            Transparency is a float in the range ``[0,1]``.
 
         Examples
         --------
-        Create a new material with color ``[0, 153, 153]`` (darker cyan).
+        Create a material with color ``[0, 153, 153]`` (darker cyan) and transparency ``0.5``.
 
         >>> from pyaedt import Hfss
         >>> hfss = Hfss(specified_version="2021.2")
         >>> mat1 = hfss.materials.add_material("new_material")
-        >>> rgbcolor = mat1.material_appearance
-        >>> mat1.material_appearance = [0, 153, 153]
+        >>> appearance_props = mat1.material_appearance
+        >>> mat1.material_appearance = [0, 153, 153, 0.5]
         """
         return self._material_appearance
 
     @material_appearance.setter
-    def material_appearance(self, rgb):
-        if not isinstance(rgb, (list, tuple)):
-            raise TypeError("`material_apperance` must be a list or tuple")
-        if len(rgb) != 3:
-            raise ValueError("`material_appearance` must be three items (RGB)")
-        value_int = []
-        for rgb_item in rgb:
-            rgb_int = int(rgb_item)
-            if rgb_int < 0 or rgb_int > 255:
-                raise ValueError("RGB value must be between 0 and 255")
-            value_int.append(rgb_int)
-        self._material_appearance = value_int
+    def material_appearance(self, appearance_props):
+        if not isinstance(appearance_props, (list, tuple)):
+            raise TypeError("`material_appearance` must be a list or tuple.")
+        if len(appearance_props) != 3 and len(appearance_props) != 4:
+            raise ValueError("`material_appearance` must be four items (R, G, B, transparency).")
+        elif len(appearance_props) == 3:
+            transparency_value = self.material_appearance[3]
+            msg = "Only RGB specified. Transparency is set to " + str(transparency_value)
+            self.logger.info(msg)
+            appearance_props.append(transparency_value)
+        value = []
+        for i in range(len(appearance_props)):
+            if i < 3:
+                rgb_int = int(appearance_props[i])
+                if rgb_int < 0 or rgb_int > 255:
+                    raise ValueError("RGB value must be between 0 and 255.")
+                value.append(rgb_int)
+            else:
+                transparency = float(appearance_props[i])
+                if transparency < 0 or transparency > 1:
+                    raise ValueError("Transparency value must be between 0 and 1.")
+                value.append(transparency)
+        self._material_appearance = value
         self._props["AttachedData"] = OrderedDict(
             {
                 "MatAppearanceData": OrderedDict(
                     {
                         "property_data": "appearance_data",
-                        "Red": value_int[0],
-                        "Green": value_int[1],
-                        "Blue": value_int[2],
+                        "Red": value[0],
+                        "Green": value[1],
+                        "Blue": value[2],
+                        "Transparency": value[3],
                     }
                 )
             }