honeybee-core 1.64.0__tar.gz → 1.64.2__tar.gz

{honeybee_core-1.64.0/honeybee_core.egg-info → honeybee_core-1.64.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: honeybee-core
-Version: 1.64.0
+Version: 1.64.2
 Summary: A library to create 3D building geometry for various types of environmental simulation.
 Home-page: https://github.com/ladybug-tools/honeybee-core
 Author: Ladybug Tools

{honeybee_core-1.64.0 → honeybee_core-1.64.2}/honeybee/model.py

@@ -13,7 +13,9 @@ try:  # check if we are in IronPython
 except ImportError:  # wea are in cPython
     import pickle
 
-from ladybug_geometry.geometry3d import Vector3D, Point3D, Plane, Face3D, Mesh3D
+from ladybug_geometry.geometry2d import Polygon2D
+from ladybug_geometry.geometry3d import Vector3D, Point3D, Plane, Face3D, \
+    Mesh3D, Polyface3D
 from ladybug_geometry.interop.stl import STL
 
 from ._base import _Base
@@ -1533,6 +1535,71 @@ class Model(_Base):
         return roof_to_exterior, slab_to_exterior, exposed_floor_to_exterior_wall, \
             exterior_wall_to_wall, roof_ridge, exposed_floor_to_floor, underground
 
+    def classified_sub_face_edges(
+        self, mullion_thickness=None, tolerance=None, angle_tolerance=None
+    ):
+        """Get classified edges around this Model's Apertures and Doors.
+
+        The edges returned by this method will only exist along the exterior
+        sub-faces.
+
+        Args:
+            mullion_thickness: The maximum difference that apertures can be from
+                one another for the edges to be considered a mullion rather than
+                a frame. If None, the Model's tolerance will be used.
+            tolerance: The maximum difference between point values for them to be
+                considered equivalent. If None, the Model's tolerance will be used.
+            angle_tolerance: The max angle difference in degrees where sub-face
+                normals are no longer considered coplanar. If None, the Model
+                angle_tolerance will be used. (Default: None).
+
+        Returns:
+            A tuple with three items where each item is a list containing
+            LineSegment3D surrounding different sub-face conditions.
+
+            -   window_frames - Apertures meet their parent exterior wall or roof.
+
+            -   window_mullions - Apertures meet one another.
+
+            -   door_frames - Doors meet their parent exterior wall or roof.
+        """
+        # set up lists to be populated
+        window_frames, window_mullions = [], []
+        tol = tolerance if tolerance is not None else self.tolerance
+        a_tol = math.radians(angle_tolerance) if angle_tolerance is not None else \
+            math.radians(self.angle_tolerance)
+        mul_thick = tol if mullion_thickness is None else mullion_thickness
+
+        # group the apertures by the plane in which they exist
+        apertures = self.apertures
+        coplanar_dict = {apertures[0].geometry.plane: [apertures[0]]}
+        for ap in apertures[1:]:
+            if isinstance(ap.boundary_condition, Outdoors):
+                for pln, f_list in coplanar_dict.items():
+                    if ap.geometry.plane.is_coplanar_tolerance(pln, tol, a_tol):
+                        f_list.append(ap)
+                        break
+                else:  # the first face with this type of plane
+                    coplanar_dict[ap.geometry.plane] = [ap]
+
+        # for each group, intersect their edges and extract edges from a Polyface3D
+        for plane, aps in coplanar_dict.items():
+            # intersect edges that are close enough to one another within thickness
+            polygons = []
+            for ap in aps:
+                pts_2d = [plane.xyz_to_xy(pt) for pt in ap.geometry.boundary]
+                polygons.append(Polygon2D(pts_2d))
+            polygons = Polygon2D.intersect_polygon_segments(polygons, mul_thick)
+            faces = []
+            for poly in polygons:
+                faces.append(Face3D([plane.xy_to_xyz(pt) for pt in poly]))
+            # create a joined Polyface3D and classify the edges
+            ap_polyface = Polyface3D.from_faces(faces, mul_thick)
+            window_frames.extend(ap_polyface.naked_edges)
+            window_mullions.extend(ap_polyface.internal_edges)
+
+        return window_frames, window_mullions, self.exterior_door_edges
+
     def add_prefix(self, prefix):
         """Change the identifier of this object and child objects by inserting a prefix.
 
@@ -1559,6 +1626,25 @@ class Model(_Base):
         for shade_mesh in self._shade_meshes:
             shade_mesh.add_prefix(prefix)
 
+    def reset_room_ids(self):
+        """Reset the identifiers of the Model Rooms to be derived from display_names.
+
+        In the event that duplicate Room identifiers are found, an integer will
+        be automatically appended to the new Room ID to make it unique.
+
+        Returns:
+            A dictionary that relates the old identifiers (keys) to the new
+            identifiers (values). This can be used to map between old and new
+            objects and update things like Surface boundary conditions.
+        """
+        room_dict, room_map = {}, {}
+        for room in self.rooms:
+            new_id = clean_and_number_string(
+                room.display_name, room_dict, 'Room identifier')
+            room_map[room.identifier] = new_id
+            room.identifier = new_id
+        return room_map
+
     def reset_ids(self, repair_surface_bcs=True):
         """Reset the identifiers of all Model objects to be derived from display_names.
 
@@ -1613,39 +1699,7 @@ class Model(_Base):
                 shade_mesh.display_name, sm_dict, 'ShadeMesh identifier')
         # reset all of the Surface boundary conditions if requested
         if repair_surface_bcs:
-            for room in self.rooms:
-                for face in room.faces:
-                    if isinstance(face.boundary_condition, Surface):
-                        old_objs = face.boundary_condition.boundary_condition_objects
-                        try:
-                            new_objs = (face_map[old_objs[0]], room_map[old_objs[1]])
-                        except KeyError:  # missing adjacency
-                            try:  # see if maybe the room reference is still there
-                                new_objs = (old_objs[0], room_map[old_objs[1]])
-                            except KeyError:  # just let the invalid adjacency pass
-                                continue
-                        new_bc = Surface(new_objs)
-                        face.boundary_condition = new_bc
-                        for ap in face.apertures:
-                            old_objs = ap.boundary_condition.boundary_condition_objects
-                            try:
-                                new_objs = (ap_map[old_objs[0]], face_map[old_objs[1]],
-                                            room_map[old_objs[2]])
-                            except KeyError:  # missing adjacency
-                                new_objs = (old_objs[0], old_objs[1],
-                                            room_map[old_objs[2]])
-                            new_bc = Surface(new_objs, True)
-                            ap.boundary_condition = new_bc
-                        for dr in face.doors:
-                            old_objs = dr.boundary_condition.boundary_condition_objects
-                            try:
-                                new_objs = (dr_map[old_objs[0]], face_map[old_objs[1]],
-                                            room_map[old_objs[2]])
-                            except KeyError:  # missing adjacency
-                                new_objs = (old_objs[0], old_objs[1],
-                                            room_map[old_objs[2]])
-                            new_bc = Surface(new_objs, True)
-                            dr.boundary_condition = new_bc
+            self._repair_surface_bcs(room_map, face_map, ap_map, dr_map)
         # return a dictionary that maps between old and new IDs
         return {
             'rooms': room_map,
@@ -1654,24 +1708,90 @@ class Model(_Base):
             'doors': dr_map
         }
 
-    def reset_room_ids(self):
-        """Reset the identifiers of the Model Rooms to be derived from display_names.
+    def reset_ids_to_integers(self, start_integer=0, repair_surface_bcs=True):
+        """Reset the identifiers of all Model geometry objects to be a unique integer.
 
-        In the event that duplicate Room identifiers are found, an integer will
-        be automatically appended to the new Room ID to make it unique.
+        Integers are simply incremented from the start_integer, assigning integers
+        first to Rooms, then to Faces, then to Apertures/Doors and lastly to
+        Shades/ShadeMeshes.
+
+        Args:
+            start_integer: The starting integer that will be used to set a lower
+                limit on the integers assigned to the geometry elements.
+            repair_surface_bcs: A Boolean to note whether all Surface boundary
+                conditions across the model should be updated with the new
+                identifiers that were generated from the display names. (Default: True).
 
         Returns:
-            A dictionary that relates the old identifiers (keys) to the new
-            identifiers (values). This can be used to map between old and new
-            objects and update things like Surface boundary conditions.
+            An integer for the last value assigned to the model geometry objects.
+            This can be used to ensure that any future IDs assigned after running
+            this method do not have IDs that collide with the model objects.
         """
-        room_dict, room_map = {}, {}
+        # set up dictionaries to hold various pieces of information
+        room_map, face_map, ap_map, dr_map = {}, {}, {}, {}
+        # loop through the objects and change their identifiers
         for room in self.rooms:
-            new_id = clean_and_number_string(
-                room.display_name, room_dict, 'Room identifier')
-            room_map[room.identifier] = new_id
-            room.identifier = new_id
-        return room_map
+            room_map[room.identifier] = str(start_integer)
+            room.identifier = str(start_integer)
+            start_integer += 1
+        for face in self.faces:
+            face_map[face.identifier] = str(start_integer)
+            face.identifier = str(start_integer)
+            start_integer += 1
+        for ap in self.apertures:
+            ap_map[ap.identifier] = str(start_integer)
+            ap.identifier = str(start_integer)
+            start_integer += 1
+        for dr in self.doors:
+            dr_map[dr.identifier] = str(start_integer)
+            dr.identifier = str(start_integer)
+            start_integer += 1
+        for shade in self.shades:
+            shade.identifier = str(start_integer)
+            start_integer += 1
+        for shade_mesh in self.shade_meshes:
+            shade_mesh.identifier = str(start_integer)
+            start_integer += 1
+        # reset all of the Surface boundary conditions if requested
+        if repair_surface_bcs:
+            self._repair_surface_bcs(room_map, face_map, ap_map, dr_map)
+        return start_integer
+
+    def _repair_surface_bcs(self, room_map, face_map, ap_map, dr_map):
+        """Repair Surface boundary conditions across the model using dict maps."""
+        for room in self.rooms:
+            for face in room.faces:
+                if isinstance(face.boundary_condition, Surface):
+                    old_objs = face.boundary_condition.boundary_condition_objects
+                    try:
+                        new_objs = (face_map[old_objs[0]], room_map[old_objs[1]])
+                    except KeyError:  # missing adjacency
+                        try:  # see if maybe the room reference is still there
+                            new_objs = (old_objs[0], room_map[old_objs[1]])
+                        except KeyError:  # just let the invalid adjacency pass
+                            continue
+                    new_bc = Surface(new_objs)
+                    face.boundary_condition = new_bc
+                    for ap in face.apertures:
+                        old_objs = ap.boundary_condition.boundary_condition_objects
+                        try:
+                            new_objs = (ap_map[old_objs[0]], face_map[old_objs[1]],
+                                        room_map[old_objs[2]])
+                        except KeyError:  # missing adjacency
+                            new_objs = (old_objs[0], old_objs[1],
+                                        room_map[old_objs[2]])
+                        new_bc = Surface(new_objs, True)
+                        ap.boundary_condition = new_bc
+                    for dr in face.doors:
+                        old_objs = dr.boundary_condition.boundary_condition_objects
+                        try:
+                            new_objs = (dr_map[old_objs[0]], face_map[old_objs[1]],
+                                        room_map[old_objs[2]])
+                        except KeyError:  # missing adjacency
+                            new_objs = (old_objs[0], old_objs[1],
+                                        room_map[old_objs[2]])
+                        new_bc = Surface(new_objs, True)
+                        dr.boundary_condition = new_bc
 
     def solve_adjacency(
             self, merge_coplanar=False, intersect=False, overwrite=False,
@@ -2181,6 +2301,18 @@ class Model(_Base):
             extrusion_rooms.append(room.to_extrusion(tol, a_tol))
         self._rooms = extrusion_rooms
 
+    def shade_meshes_to_shades(self):
+        """Convert all ShadeMesh objects on the Model to planar Shades."""
+        new_shades = []
+        for shade_mesh in self.shade_meshes:
+            try:
+                shade_mesh.triangulate_and_remove_degenerate_faces(self.tolerance)
+                new_shades.extend(shade_mesh.to_shades())
+            except AssertionError:
+                pass  # completely degenerate ShadeMesh to ignore
+        self._orphaned_shades.extend(new_shades)
+        self._shade_meshes = []
+
     def convert_to_units(self, units='Meters'):
         """Convert all of the geometry in this model to certain units.
 

{honeybee_core-1.64.0 → honeybee_core-1.64.2}/honeybee/shademesh.py

@@ -324,6 +324,23 @@ class ShadeMesh(_Base):
             base['user_data'] = self.user_data
         return base
 
+    def to_shades(self):
+        """Return a list of Honeybee Shade objects derived from this ShadeMesh.
+
+        Note that the resulting Shades may be degenerate or non-planar so it
+        may be useful to call triangulate_and_remove_degenerate_faces on this
+        object before converting to Shades.
+        """
+        from honeybee.shade import Shade  # imported here to avoid circular import
+        shades = []
+        for i, shade_geo in enumerate(self.geometry.face_vertices):
+            shade_id = '{}_{}'.format(self.identifier, i)
+            shade = Shade(shade_id, Face3D(shade_geo), self.is_detached)
+            if self._display_name is not None:
+                shade.display_name = '{} {}'.format(self.display_name, i)
+            shades.append(shade)
+        return shades
+
     @staticmethod
     def _display_mesh(mesh3d, color):
         """Create a DisplayMesh3D dictionary from a Mesh3D and color."""

{honeybee_core-1.64.0 → honeybee_core-1.64.2/honeybee_core.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: honeybee-core
-Version: 1.64.0
+Version: 1.64.2
 Summary: A library to create 3D building geometry for various types of environmental simulation.
 Home-page: https://github.com/ladybug-tools/honeybee-core
 Author: Ladybug Tools

{honeybee_core-1.64.0 → honeybee_core-1.64.2}/tests/model_test.py

@@ -399,6 +399,18 @@ def test_reset_ids():
     assert new_model.check_missing_adjacencies() == ''
 
 
+def test_reset_ids_to_integers():
+    """Test the reset_ids_to_integers method."""
+    model_json = './tests/json/model_with_adiabatic.hbjson'
+    parsed_model = Model.from_hbjson(model_json, cleanup_irrational=True)
+
+    new_model = parsed_model.duplicate()
+    new_model.reset_ids_to_integers(True)
+
+    assert new_model.rooms[0].identifier != parsed_model.rooms[0].identifier
+    assert new_model.check_missing_adjacencies() == ''
+
+
 def test_offset_aperture_edges():
     """Test the Face offset_aperture_edges method."""
     model_json = './tests/json/room_for_window_offset.hbjson'
@@ -588,6 +600,12 @@ def test_remove_degenerate_geometry():
     model.remove_degenerate_geometry()
     assert len(model.shade_meshes) == 1
 
+    model = Model('MultiZoneSingleFamilyHouse',
+                  [first_floor, second_floor], shade_meshes=[shade1, shade2])
+    model.shade_meshes_to_shades()
+    assert len(model.shade_meshes) == 0
+    assert len(model.orphaned_shades) == 2
+
 
 def test_assign_stories_by_floor_height():
     """Test the Model assign_stories_by_floor_height method."""