test for model.get_manual_booleans() #3709

added test that model.get_manual_booleans will ignore IfcBooleanClippings until we find some other solution to distinguish automatic and manual clippings. And some refactor along the way.

src/blenderbim/test/tool/test_model.py

@@ -52,12 +52,14 @@ class TestGenerateOccurrenceName(NewFile):
         bpy.context.scene.BIMModelProperties.occurrence_name_function = '"Foobar"'
         assert subject.generate_occurrence_name(element_type, "IfcWall") == "Foobar"
 
+
 class TestGetManualBooleans(NewFile):
     def test_run(self):
         assert isinstance(subject(), blenderbim.core.tool.Model)
 
-    def test_len_returned_boolean(self):
+    def setup_profile_represntation(self, clippings=[]):
         ifc = ifcopenshell.file()
+        self.ifc = ifc
         tool.Ifc.set(ifc)
         ifcopenshell.api.run("root.create_entity", ifc, ifc_class="IfcProject")
         length = ifcopenshell.api.run("unit.add_si_unit", ifc, unit_type="LENGTHUNIT")
@@ -65,17 +67,43 @@ class TestGetManualBooleans(NewFile):
         ifcopenshell.api.run("unit.assign_unit", ifc)
         element = ifc.createIfcColumn()
         hea100 = ifc.create_entity(
-            "IfcIShapeProfileDef", ProfileName="HEA100", ProfileType="AREA",
-            OverallWidth=100, OverallDepth=96, WebThickness=5, FlangeThickness=8, FilletRadius=12,
+            "IfcIShapeProfileDef",
+            ProfileName="HEA100",
+            ProfileType="AREA",
+            OverallWidth=100,
+            OverallDepth=96,
+            WebThickness=5,
+            FlangeThickness=8,
+            FilletRadius=12,
         )
         model3d = ifcopenshell.api.run("context.add_context", ifc, context_type="Model")
-        body = ifcopenshell.api.run("context.add_context", ifc,context_type="Model", context_identifier="Body", target_view="MODEL_VIEW", parent=model3d)
-        representation = ifcopenshell.api.run("geometry.add_profile_representation", ifc, context=body, profile=hea100, depth=5)
+        body = ifcopenshell.api.run(
+            "context.add_context",
+            ifc,
+            context_type="Model",
+            context_identifier="Body",
+            target_view="MODEL_VIEW",
+            parent=model3d,
+        )
+        representation = ifcopenshell.api.run(
+            "geometry.add_profile_representation", ifc, context=body, profile=hea100, depth=5, clippings=clippings
+        )
         ifcopenshell.api.run("geometry.assign_representation", ifc, product=element, representation=representation)
+        return element, representation
+
+    def test_manual_booleans(self):
+        element, representation = self.setup_profile_represntation()
         matrix = np.eye(4)
-        matrix = ifcopenshell.util.placement.rotation(45,"X") @ matrix
-        matrix[:,3][0:3] = (0, 0, 3)
-        matrix = matrix.tolist()
-        ifcopenshell.api.run("geometry.add_boolean", ifc, representation = representation, type = "IfcHalfSpaceSolid", matrix = matrix)
+        ifcopenshell.api.run(
+            "geometry.add_boolean", self.ifc, representation=representation, type="IfcHalfSpaceSolid", matrix=matrix
+        )
         assert len(subject.get_manual_booleans(element)) == 1
 
+    def test_automatic_booleans_ignored(self):
+        clipping = {
+            "type": "IfcBooleanClippingResult",
+            "operand_type": "IfcHalfSpaceSolid",
+            "matrix": np.eye(4).tolist(),
+        }
+        element, representation = self.setup_profile_represntation(clippings=[clipping])
+        assert len(subject.get_manual_booleans(element)) == 0

src/ifcopenshell-python/ifcopenshell/api/geometry/add_boolean.py

@@ -17,6 +17,7 @@
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
 
 import ifcopenshell.util.unit
+import numpy as np
 
 
 class Usecase:
@@ -44,7 +45,6 @@ class Usecase:
         elif self.settings["type"] == "Mesh":
             if self.settings["blender_obj"]:
                 result = self.create_blender_mesh()
-        representation_type = "Clipping"
         items = []
         for item in self.settings["representation"].Items:
             # For now, we don't use IfcBooleanClippingResult.
@@ -56,23 +56,13 @@ class Usecase:
         self.settings["representation"].Items = items
 
     def create_half_space_solid(self):
-        clipping = self.settings["matrix"]
-        return self.file.createIfcHalfSpaceSolid(
-            self.file.createIfcPlane(
-                self.file.createIfcAxis2Placement3D(
-                    self.file.createIfcCartesianPoint(
-                        (
-                            self.convert_si_to_unit(clipping[0][3]),
-                            self.convert_si_to_unit(clipping[1][3]),
-                            self.convert_si_to_unit(clipping[2][3]),
-                        )
-                    ),
-                    self.file.createIfcDirection((clipping[0][2], clipping[1][2], clipping[2][2])),
-                    self.file.createIfcDirection((clipping[0][0], clipping[1][0], clipping[2][0])),
-                )
-            ),
-            False,
-        )
+        clipping = np.array(self.settings["matrix"])[:3]
+        local_z = self.file.createIfcDirection(clipping[:, 2].tolist())
+        local_x = self.file.createIfcDirection(clipping[:, 0].tolist())
+        point = self.file.createIfcCartesianPoint(self.convert_si_to_unit(clipping[:, 3]).tolist())
+        placement = self.file.createIfcAxis2Placement3D(point, local_z, local_x)
+        plane = self.file.createIfcPlane(placement)
+        return self.file.createIfcHalfSpaceSolid(plane, AgreementFlag=False)
 
     def create_blender_mesh(self):
         self.ifc_vertices = []

src/ifcopenshell-python/test/api/geometry/test_add_boolean.py

@@ -0,0 +1,46 @@
+# IfcOpenShell - IFC toolkit and geometry engine
+# Copyright (C) 2023 Dion Moult <dion@thinkmoult.com>
+#
+# This file is part of IfcOpenShell.
+#
+# IfcOpenShell is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# IfcOpenShell is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
+
+import test.bootstrap
+import ifcopenshell.api
+import numpy as np
+from ifcopenshell.util.shape_builder import ShapeBuilder
+
+
+class TestAddBoolean(test.bootstrap.IFC4):
+    def test_returning_ifc_boolean_result(self):
+        ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcProject")
+        model = ifcopenshell.api.run("context.add_context", self.file, context_type="Model")
+        body = ifcopenshell.api.run(
+            "context.add_context",
+            self.file,
+            context_type="Model",
+            context_identifier="Body",
+            target_view="MODEL_VIEW",
+            parent=model,
+        )
+        wall = ifcopenshell.api.run("root.create_entity", self.file, ifc_class="IfcWall")
+
+        builder = ShapeBuilder(self.file)
+        extrusion = builder.extrude(builder.rectangle())
+        rep = builder.get_representation(body, extrusion)
+        ifcopenshell.api.run("geometry.assign_representation", self.file, product=wall, representation=rep)
+
+        ifcopenshell.api.run("geometry.add_boolean", self.file, representation=rep, matrix=np.eye(4))
+        assert rep.Items[0].is_a() == "IfcBooleanResult"
+        assert rep.RepresentationType == "CSG"