See #5972. Add tests for adding boolean and check against recursive booleans and invalid boolean items.

2026-08-10 01:41:57 +00:00 · 2025-01-18 21:13:37 +11:00
parent 35734f4b67
commit a12427e44a
4 changed files with 177 additions and 189 deletions
@@ -20,38 +20,127 @@ import test.bootstrap
 import ifcopenshell.api.root
 import ifcopenshell.api.context
 import ifcopenshell.api.geometry
-import numpy as np


 class TestAddBoolean(test.bootstrap.IFC4):
-    def test_returning_ifc_boolean_clipping_result(self):
+    def test_adding_a_boolean_from_two_top_level_items(self):
        ifcopenshell.api.root.create_entity(self.file, ifc_class="IfcProject")
        model = ifcopenshell.api.context.add_context(self.file, context_type="Model")
        body = ifcopenshell.api.context.add_context(
-            self.file,
-            context_type="Model",
-            context_identifier="Body",
-            target_view="MODEL_VIEW",
-            parent=model,
+            self.file, context_type="Model", context_identifier="Body", target_view="MODEL_VIEW", parent=model
        )
-        wall = ifcopenshell.api.root.create_entity(self.file, ifc_class="IfcWall")
+        builder = ifcopenshell.util.shape_builder.ShapeBuilder(self.file)
+        first = builder.sphere()
+        second = builder.block()
+        rep = builder.get_representation(body, [first, second])

-        profile = self.file.create_entity(
-            "IfcIShapeProfileDef",
-            ProfileName="HEA100",
-            ProfileType="AREA",
-            OverallWidth=100,
-            OverallDepth=96,
-            WebThickness=5,
-            FlangeThickness=8,
-            FilletRadius=12,
+        booleans = ifcopenshell.api.geometry.add_boolean(self.file, first, [second])
+        assert len(booleans) == 1
+        boolean = list(booleans)[0]
+        assert boolean.is_a("IfcBooleanResult")
+        assert boolean.FirstOperand == first
+        assert boolean.SecondOperand == second
+        assert boolean.Operator == "DIFFERENCE"
+        assert set(rep.Items) == {boolean}
+
+    def test_adding_multiple_booleans_from_three_top_level_items(self):
+        ifcopenshell.api.root.create_entity(self.file, ifc_class="IfcProject")
+        model = ifcopenshell.api.context.add_context(self.file, context_type="Model")
+        body = ifcopenshell.api.context.add_context(
+            self.file, context_type="Model", context_identifier="Body", target_view="MODEL_VIEW", parent=model
        )
-        rep = ifcopenshell.api.geometry.add_profile_representation(self.file, context=body, profile=profile, depth=5)
-        ifcopenshell.api.geometry.assign_representation(self.file, product=wall, representation=rep)
+        builder = ifcopenshell.util.shape_builder.ShapeBuilder(self.file)
+        first = builder.sphere()
+        second1 = builder.block()
+        second2 = builder.block()
+        rep = builder.get_representation(body, [first, second1, second2])

-        ifcopenshell.api.geometry.add_boolean(self.file, representation=rep, matrix=np.eye(4))
-        assert rep.Items[0].is_a() == "IfcBooleanClippingResult"
-        assert rep.RepresentationType == "Clipping"
+        booleans = ifcopenshell.api.geometry.add_boolean(self.file, first, [second1, second2])
+        assert len(booleans) == 2
+        assert len(rep.Items) == 1
+        assert rep.Items[0].FirstOperand.is_a("IfcBooleanResult")
+        assert rep.Items[0].FirstOperand.is_a("IfcBooleanResult")
+        assert rep.Items[0].SecondOperand == second2
+        assert rep.Items[0].Operator == "DIFFERENCE"
+        assert rep.Items[0].FirstOperand.FirstOperand == first
+        assert rep.Items[0].FirstOperand.SecondOperand == second1
+        assert rep.Items[0].FirstOperand.Operator == "DIFFERENCE"
+
+    def test_adding_a_boolean_to_an_existing_operand_from_a_top_level_item(self):
+        ifcopenshell.api.root.create_entity(self.file, ifc_class="IfcProject")
+        model = ifcopenshell.api.context.add_context(self.file, context_type="Model")
+        body = ifcopenshell.api.context.add_context(
+            self.file, context_type="Model", context_identifier="Body", target_view="MODEL_VIEW", parent=model
+        )
+        builder = ifcopenshell.util.shape_builder.ShapeBuilder(self.file)
+        first = builder.sphere()
+        second1 = builder.block()
+        second2 = builder.block()
+        rep = builder.get_representation(body, [first, second1])
+        booleans = ifcopenshell.api.geometry.add_boolean(self.file, first, [second1])
+        rep.Items = list(rep.Items) + [second2]
+        booleans = ifcopenshell.api.geometry.add_boolean(self.file, first, [second2])
+        assert len(booleans) == 1
+        assert len(rep.Items) == 1
+        assert rep.Items[0].FirstOperand.is_a("IfcBooleanResult")
+        assert rep.Items[0].SecondOperand == second2
+        assert rep.Items[0].FirstOperand.FirstOperand == first
+        assert rep.Items[0].FirstOperand.SecondOperand == second1
+
+    def test_adding_a_boolean_to_an_existing_operand_from_another_operand(self):
+        ifcopenshell.api.root.create_entity(self.file, ifc_class="IfcProject")
+        model = ifcopenshell.api.context.add_context(self.file, context_type="Model")
+        body = ifcopenshell.api.context.add_context(
+            self.file, context_type="Model", context_identifier="Body", target_view="MODEL_VIEW", parent=model
+        )
+        builder = ifcopenshell.util.shape_builder.ShapeBuilder(self.file)
+        first1 = builder.sphere()
+        second1 = builder.block()
+        first2 = builder.sphere()
+        second2 = builder.block()
+        rep = builder.get_representation(body, [first1, first2, second1, second2])
+        booleans = ifcopenshell.api.geometry.add_boolean(self.file, first1, [second1])
+        booleans = ifcopenshell.api.geometry.add_boolean(self.file, first2, [second2])
+        booleans = ifcopenshell.api.geometry.add_boolean(self.file, first1, [second2])
+
+        assert len(booleans) == 1
+        assert len(rep.Items) == 2
+
+        assert len(self.file.get_inverse(first1)) == 1
+        result = list(self.file.get_inverse(first1))[0]
+        assert result.FirstOperand == first1
+        assert result.SecondOperand == second1
+        result2 = list(self.file.get_inverse(result))[0]
+        assert result2.FirstOperand == result
+        # Second2 is now used twice. Reusing is OK (albeit confusing), so long as things don't get recursive.
+        assert result2.SecondOperand == second2
+
+        assert len(self.file.get_inverse(first2)) == 1
+        result3 = list(self.file.get_inverse(first2))[0]
+        assert result3.FirstOperand == first2
+        assert result3.SecondOperand == second2
+
+    def test_preventing_recursive_booleans(self):
+        ifcopenshell.api.root.create_entity(self.file, ifc_class="IfcProject")
+        model = ifcopenshell.api.context.add_context(self.file, context_type="Model")
+        body = ifcopenshell.api.context.add_context(
+            self.file, context_type="Model", context_identifier="Body", target_view="MODEL_VIEW", parent=model
+        )
+        builder = ifcopenshell.util.shape_builder.ShapeBuilder(self.file)
+        first = builder.sphere()
+        second = builder.block()
+        rep = builder.get_representation(body, [first, second])
+        ifcopenshell.api.geometry.add_boolean(self.file, first, [second])
+        ifcopenshell.api.geometry.add_boolean(self.file, first, [second])
+        assert len(rep.Items) == 1
+        assert rep.Items[0].FirstOperand == first
+        assert rep.Items[0].SecondOperand == second
+        ifcopenshell.api.geometry.add_boolean(self.file, second, [second])
+        ifcopenshell.api.geometry.add_boolean(self.file, second, [first])
+        assert len(rep.Items) == 1
+        assert rep.Items[0].FirstOperand == first
+        assert rep.Items[0].SecondOperand == second
+        assert len(self.file.by_type("IfcBooleanResult")) == 1


 class TestAddBooleanIFC2X3(test.bootstrap.IFC2X3, TestAddBoolean):