fix(shademesh): Add extension methods for ShadeMesh

Author: chriswmackey

honeybee_display/_extend_honeybee.py

@@ -6,6 +6,7 @@
 from honeybee.aperture import Aperture
 from honeybee.door import Door
 from honeybee.shade import Shade
+from honeybee.shademesh import ShadeMesh
 from honeybee.colorobj import ColorRoom, ColorFace
 
 # import the extension functions
@@ -15,6 +16,7 @@
 from .aperture import aperture_to_vis_set
 from .door import door_to_vis_set
 from .shade import shade_to_vis_set
+from .shademesh import shade_mesh_to_vis_set
 from .colorobj import color_room_to_vis_set, color_face_to_vis_set
 
 # inject the methods onto the classes
@@ -25,6 +27,7 @@
 Aperture.to_vis_set = aperture_to_vis_set
 Door.to_vis_set = door_to_vis_set
 Shade.to_vis_set = shade_to_vis_set
+ShadeMesh.to_vis_set = shade_mesh_to_vis_set
 ColorRoom.to_vis_set = color_room_to_vis_set
 ColorFace.to_vis_set = color_face_to_vis_set
 

honeybee_display/aperture.py

@@ -7,7 +7,7 @@ def aperture_to_vis_set(aperture, color_by='type'):
     """Translate a Honeybee Aperture to a VisualizationSet.
 
     Args:
-        model: A Honeybee Aperture object to be converted to a VisualizationSet.
+        aperture: A Honeybee Aperture object to be converted to a VisualizationSet.
         color_by: Text for the property that dictates the colors of the Aperture
             geometry. (Default: type). Choose from the following:
 

honeybee_display/door.py

@@ -7,7 +7,7 @@ def door_to_vis_set(door, color_by='type'):
     """Translate a Honeybee Door to a VisualizationSet.
 
     Args:
-        model: A Honeybee Door object to be converted to a VisualizationSet.
+        door: A Honeybee Door object to be converted to a VisualizationSet.
         color_by: Text for the property that dictates the colors of the Door
             geometry. (Default: type). Choose from the following:
 

honeybee_display/face.py

@@ -7,7 +7,7 @@ def face_to_vis_set(face, color_by='type'):
     """Translate a Honeybee Face to a VisualizationSet.
 
     Args:
-        model: A Honeybee Face object to be converted to a VisualizationSet.
+        face: A Honeybee Face object to be converted to a VisualizationSet.
         color_by: Text for the property that dictates the colors of the Face
             geometry. (Default: type). Choose from the following:
 

honeybee_display/model.py

@@ -2,7 +2,7 @@
 import os
 import json
 
-from ladybug_geometry.geometry3d import Point3D
+from ladybug_geometry.geometry3d import Point3D, Face3D
 from ladybug.datatype.generic import GenericType
 from ladybug.color import Color
 from ladybug_display.geometry3d import DisplayPoint3D, DisplayLineSegment3D, \
@@ -171,6 +171,12 @@ def model_to_vis_set(
                 type_dict['Outdoor Shade'].append(shd.geometry)
         for shd in model.indoor_shades:
             type_dict['Indoor Shade'].append(shd.geometry)
+        # add all of the shade meshes to the dictionary
+        for shd in model.shade_meshes:
+            if shd.is_detached:
+                type_dict['Context Shade'].append(shd.geometry)
+            else:
+                type_dict['Outdoor Shade'].append(shd.geometry)
     elif color_by == 'boundary_condition':
         type_dict = {
             'Outdoors': [], 'Surface': [], 'Ground': [], 'Adiabatic': [], 'Other': []}
@@ -209,6 +215,9 @@ def model_to_vis_set(
         # add all shades to the dictionary
         for shd in model.shades:
             type_dict['Other'].append(shd.geometry)
+        # add all of the shade meshes to the dictionary
+        for shd in model.shade_meshes:
+            type_dict['Other'].append(shd.geometry)
     elif color_by == 'none':
         type_dict = {}
     else:  # unrecognized property for coloring
@@ -221,12 +230,16 @@ def model_to_vis_set(
         if len(geometries) != 0:
             col = TYPE_COLORS[geo_id] if color_by == 'type' else BC_COLORS[geo_id]
             if use_mesh:
-                dis_geos = [DisplayMesh3D(f.triangulated_mesh3d, color=col)
-                            for f in geometries]
+                dis_geos = []
+                for f in geometries:
+                    c_geo = f.triangulated_mesh3d if isinstance(f, Face3D) else f
+                    dis_geos.append(DisplayMesh3D(c_geo, color=col))
             else:
                 dis_geos = []
                 for geo in geometries:
-                    dis_geos.append(DisplayFace3D(geo, col))
+                    c_geo = DisplayFace3D(geo, color=col) if isinstance(geo, Face3D) \
+                        else DisplayMesh3D(geo, color=col)
+                    dis_geos.append(c_geo)
             con_geo = ContextGeometry(geo_id.replace(' ', '_'), dis_geos)
             if hide_color_by:
                 con_geo.hidden = True
@@ -447,6 +460,10 @@ def _process_wireframe(face3d, wireframe, line_width=1):
     for shd in model.outdoor_shades:
         lw = 2 if shd.is_detached else 1
         _process_wireframe(shd.geometry, wireframe, lw)
+    for shd_m in model.shade_meshes:
+        lw = 2 if shd_m.is_detached else 1
+        for seg in shd_m.geometry.edges:
+            wireframe.append(DisplayLineSegment3D(seg, line_width=lw))
 
     # build the VisualizationSet and return it
     if len(wireframe) == 0:

honeybee_display/room.py

@@ -8,7 +8,7 @@ def room_to_vis_set(room, color_by='type'):
     """Translate a Honeybee Room to a VisualizationSet.
 
     Args:
-        model: A Honeybee Room object to be converted to a VisualizationSet.
+        room: A Honeybee Room object to be converted to a VisualizationSet.
         color_by: Text for the property that dictates the colors of the Room
             geometry. (Default: type). Choose from the following:
 

honeybee_display/shade.py

@@ -7,7 +7,7 @@ def shade_to_vis_set(shade, color_by='type'):
     """Translate a Honeybee Shade to a VisualizationSet.
 
     Args:
-        model: A Honeybee Shade object to be converted to a VisualizationSet.
+        shade: A Honeybee Shade object to be converted to a VisualizationSet.
         color_by: Text for the property that dictates the colors of the Shade
             geometry. (Default: type). Choose from the following:
 

honeybee_display/shademesh.py

@@ -0,0 +1,33 @@
+"""Method to translate a ShadeMesh to a VisualizationSet."""
+from ladybug_display.geometry3d import DisplayMesh3D
+from ladybug_display.visualization import VisualizationSet, ContextGeometry
+
+
+
+def shade_mesh_to_vis_set(shade, color_by='type'):
+    """Translate a Honeybee ShadeMesh to a VisualizationSet.
+
+    Args:
+        shade: A Honeybee ShadeMesh object to be converted to a VisualizationSet.
+        color_by: Text for the property that dictates the colors of the Shade
+            geometry. (Default: type). Choose from the following:
+
+            * type
+            * boundary_condition
+
+    Returns:
+        A VisualizationSet object that represents the ShadeMesh with a
+        single ContextGeometry.
+    """
+    # get the basic properties for geometry conversion
+    color_by_attr = 'type_color' if color_by.lower() == 'type' else 'bc_color'
+    d_mod = 'SurfaceWithEdges'
+    # convert all geometry into DisplayFace3D
+    a_col = getattr(shade, color_by_attr)
+    dis_geos = [DisplayMesh3D(shade.geometry, a_col, d_mod)]
+    # build the VisualizationSet and ContextGeometry
+    con_geo = ContextGeometry(shade.identifier, dis_geos)
+    con_geo.display_name = shade.display_name
+    vis_set = VisualizationSet(shade.identifier, [con_geo])
+    vis_set.display_name = shade.display_name
+    return vis_set

requirements.txt

@@ -1,2 +1,2 @@
 ladybug-display>=0.7.2
-honeybee-core>=1.56.18
+honeybee-core>=1.57.9