honeybee-core 1.61.17__tar.gz → 1.61.18__tar.gz

{honeybee_core-1.61.17/honeybee_core.egg-info → honeybee_core-1.61.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: honeybee-core
-Version: 1.61.17
+Version: 1.61.18
 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.61.17 → honeybee_core-1.61.18}/honeybee/aperture.py

@@ -818,6 +818,39 @@ class Aperture(_BaseWithShade):
             return full_msg
         return [] if detailed else ''
 
+    def check_degenerate(self, tolerance=0.01, raise_exception=True, detailed=False):
+        """Check whether the Aperture is degenerate with effectively zero area.
+
+        Note that, while the Aperture may have an area larger than the tolerance,
+        removing colinear vertices within the tolerance would create a geometry
+        smaller than the tolerance.
+
+        Args:
+            tolerance: The minimum difference between the coordinate values of two
+                vertices at which they can be considered equivalent. Default: 0.01,
+                suitable for objects in meters.
+            raise_exception: If True, a ValueError will be raised if the object
+                intersects with itself. Default: True.
+            detailed: Boolean for whether the returned object is a detailed list of
+                dicts with error info or a string with a message. (Default: False).
+
+        Returns:
+            A string with the message or a list with a dictionary if detailed is True.
+        """
+        msg = 'Aperture "{}" is degenerate and should be deleted.'.format(
+            self.full_id)
+        try:  # see if it is self-intersecting because of a duplicate vertex
+            new_geo = self.geometry.remove_colinear_vertices(tolerance)
+            if new_geo.area > tolerance:
+                return [] if detailed else ''  # valid
+        except AssertionError:
+            pass  # degenerate subface; treat it as degenerate
+        full_msg = self._validation_message(
+            msg, raise_exception, detailed, '000103',
+            error_type='Zero-Area Geometry')
+        return full_msg
+        return [] if detailed else ''
+
     def display_dict(self):
         """Get a list of DisplayFace3D dictionaries for visualizing the object."""
         base = [self._display_face(self.geometry, self.type_color)]

{honeybee_core-1.61.17 → honeybee_core-1.61.18}/honeybee/door.py

@@ -575,6 +575,39 @@ class Door(_BaseWithShade):
             return full_msg
         return [] if detailed else ''
 
+    def check_degenerate(self, tolerance=0.01, raise_exception=True, detailed=False):
+        """Check whether the Door is degenerate with effectively zero area.
+
+        Note that, while the Door may have an area larger than the tolerance,
+        removing colinear vertices within the tolerance would create a geometry
+        smaller than the tolerance.
+
+        Args:
+            tolerance: The minimum difference between the coordinate values of two
+                vertices at which they can be considered equivalent. Default: 0.01,
+                suitable for objects in meters.
+            raise_exception: If True, a ValueError will be raised if the object
+                intersects with itself. Default: True.
+            detailed: Boolean for whether the returned object is a detailed list of
+                dicts with error info or a string with a message. (Default: False).
+
+        Returns:
+            A string with the message or a list with a dictionary if detailed is True.
+        """
+        msg = 'Door "{}" is degenerate and should be deleted.'.format(
+            self.full_id)
+        try:  # see if it is self-intersecting because of a duplicate vertex
+            new_geo = self.geometry.remove_colinear_vertices(tolerance)
+            if new_geo.area > tolerance:
+                return [] if detailed else ''  # valid
+        except AssertionError:
+            pass  # degenerate subface; treat it as degenerate
+        full_msg = self._validation_message(
+            msg, raise_exception, detailed, '000103',
+            error_type='Zero-Area Geometry')
+        return full_msg
+        return [] if detailed else ''
+
     def display_dict(self):
         """Get a list of DisplayFace3D dictionaries for visualizing the object."""
         base = [self._display_face(self.geometry, self.type_color)]

{honeybee_core-1.61.17 → honeybee_core-1.61.18}/honeybee/face.py

@@ -130,6 +130,13 @@ class Face(_BaseWithShade):
             assert data['type'] == 'Face', 'Expected Face dictionary. ' \
                 'Got {}.'.format(data['type'])
 
+            # remove any invalid holes from the geometry
+            geo_dict = data['geometry']
+            if 'holes' in geo_dict and geo_dict['holes'] is not None:
+                for i, hole_list in enumerate(geo_dict['holes']):
+                    if len(hole_list) < 3:
+                        geo_dict['holes'].pop(i)
+
             # first serialize it with an outdoor boundary condition
             face_type = face_types.by_name(data['face_type'])
             face = cls(data['identifier'], Face3D.from_dict(data['geometry']),
@@ -2039,6 +2046,38 @@ class Face(_BaseWithShade):
             return full_msg
         return [] if detailed else ''
 
+    def check_degenerate(self, tolerance=0.01, raise_exception=True, detailed=False):
+        """Check whether the Face is degenerate with effectively zero area.
+
+        Note that, while the Face may have an area larger than the tolerance,
+        removing colinear vertices within the tolerance would create a geometry
+        smaller than the tolerance.
+
+        Args:
+            tolerance: The minimum difference between the coordinate values of two
+                vertices at which they can be considered equivalent. Default: 0.01,
+                suitable for objects in meters.
+            raise_exception: If True, a ValueError will be raised if the object
+                intersects with itself. Default: True.
+            detailed: Boolean for whether the returned object is a detailed list of
+                dicts with error info or a string with a message. (Default: False).
+
+        Returns:
+            A string with the message or a list with a dictionary if detailed is True.
+        """
+        msg = 'Face "{}" is degenerate and should be deleted.'.format(self.full_id)
+        try:  # see if it is self-intersecting because of a duplicate vertex
+            new_geo = self.geometry.remove_colinear_vertices(tolerance)
+            if new_geo.area > tolerance:
+                return [] if detailed else ''  # valid
+        except AssertionError:
+            pass  # degenerate face; treat it as degenerate
+        full_msg = self._validation_message(
+            msg, raise_exception, detailed, '000103',
+            error_type='Zero-Area Geometry')
+        return full_msg
+        return [] if detailed else ''
+
     def display_dict(self):
         """Get a list of DisplayFace3D dictionaries for visualizing the object."""
         base = [self._display_face(self.punched_geometry, self.type_color)]

{honeybee_core-1.61.17 → honeybee_core-1.61.18}/honeybee/room.py

@@ -1155,7 +1155,7 @@ class Room(_BaseWithShade):
         """Remove colinear and duplicate vertices from this object's Faces and Sub-faces.
 
         If degenerate geometry is found in the process of removing colinear vertices,
-        an exception will be raised. Note that this does not affect the assigned Shades.
+        an exception will be raised unless delete_degenerate is True.
 
         Args:
             tolerance: The minimum distance between a vertex and the boundary segments
@@ -1628,13 +1628,19 @@ class Room(_BaseWithShade):
         """
         # if the room has the correct number of faces, test the envelope geometry
         if len(self._faces) >= 4 and self.volume > tolerance:
-            try:
-                test_room = self.duplicate()  # duplicate to avoid editing the original
-                test_room.remove_colinear_vertices_envelope(tolerance)
-            except ValueError as e:
-                deg_msg = str(e)
-                if raise_exception:
-                    raise ValueError(e)
+            msgs, final_faces = [], []
+            for face in self._faces:
+                face_msg = face.check_degenerate(tolerance, False, detailed)
+                if not face_msg:
+                    final_faces.append(face)
+                msgs.append(face_msg)
+                for ap in face._apertures:
+                    msgs.append(ap.check_degenerate(tolerance, False, detailed))
+                for dr in face._doors:
+                    msgs.append(dr.check_degenerate(tolerance, False, detailed))
+            if len(final_faces) < 4:
+                deg_msg = 'Room "{}" is degenerate with zero volume. ' \
+                    'It should be deleted'.format(self.full_id)
                 if detailed:
                     deg_msg = [{
                         'type': 'ValidationError',
@@ -1646,9 +1652,19 @@ class Room(_BaseWithShade):
                         'element_name': [self.display_name],
                         'message': deg_msg
                     }]
-                return deg_msg
-            return [] if detailed else ''
-        #  otherwise, report the room as invalid
+                msgs.append(deg_msg)
+            full_msgs = [msg for msg in msgs if msg]
+            if len(full_msgs) == 0:
+                return [] if detailed else ''
+            elif detailed:
+                return [m for megs in full_msgs for m in megs]
+            full_msg = 'Room "{}" contains degenerate geometry.' \
+                '\n  {}'.format(self.full_id, '\n  '.join(full_msgs))
+            if raise_exception and len(full_msgs) != 0:
+                raise ValueError(full_msg)
+            return full_msg
+
+        # otherwise, report the room as invalid
         msg = 'Room "{}" is degenerate with zero volume. It should be deleted'.format(
                 self.full_id)
         return self._validation_message(

{honeybee_core-1.61.17 → honeybee_core-1.61.18/honeybee_core.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: honeybee-core
-Version: 1.61.17
+Version: 1.61.18
 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