Removing or changing spatial containers now supports updating more types of collection organisations

src/blenderbim/test/bim/feature/spatial.feature

@@ -0,0 +1,30 @@
+@spatial
+Feature: Spatial
+    Covers spatial containment management.
+
+Scenario: Enable editing container
+    Given an empty IFC project
+    And I add a cube
+    And the object "Cube" is selected
+    When I press "bim.enable_editing_container"
+    Then nothing happens
+
+Scenario: Disable editing container
+    Given an empty IFC project
+    And I add a cube
+    And the object "Cube" is selected
+    And I press "bim.enable_editing_container"
+    When I press "bim.disable_editing_container"
+    Then nothing happens
+
+Scenario: Assign container
+    Given an empty IFC project
+    And I add a cube
+    And the object "Cube" is selected
+    And I set "scene.BIMRootProperties.ifc_class" to "IfcWall"
+    And I press "bim.assign_class"
+    And the object "IfcWall/Cube" is selected
+    And I press "bim.enable_editing_container"
+    And the variable "site" is "tool.Ifc.get().by_type('IfcSite')[0].id()"
+    When I press "bim.assign_container(structure={site})"
+    Then the object "IfcWall/Cube" is in the collection "IfcSite/My Site"

src/blenderbim/test/bim/test_feature.py

@@ -18,6 +18,7 @@
 
 import os
 import bpy
+import blenderbim.tool as tool
 from blenderbim.bim.ifc import IfcStore
 from pytest_bdd import scenarios, given, when, then, parsers
 
@@ -103,8 +104,9 @@ def i_delete_the_selected_objects():
     bpy.ops.object.delete()
 
 
-@then(parsers.parse('the variable "{key}" is "{value}"'))
+@given(parsers.parse('the variable "{key}" is "{value}"'))
 @when(parsers.parse('the variable "{key}" is "{value}"'))
+@then(parsers.parse('the variable "{key}" is "{value}"'))
 def the_variable_key_is_value(key, value):
     variables[key] = eval(replace_variables(value))
 
@@ -122,7 +124,7 @@ def the_object_name_exists(name) -> bpy.types.Object:
     return obj
 
 
-@then('an IFC file exists')
+@then("an IFC file exists")
 def an_ifc_file_exists():
     ifc = IfcStore.get_file()
     if not ifc:
@@ -255,3 +257,8 @@ def prop_is_value(prop, value):
     if not is_value:
         actual_value = eval(f"bpy.context.{prop}")
         assert False, f"Value is {actual_value}"
+
+
+@then(parsers.parse('the object "{name}" is in the collection "{collection}"'))
+def the_object_name_is_in_the_collection_collection(name, collection):
+    assert collection in [c.name for c in the_object_name_exists(name).users_collection]

src/blenderbim/test/core/test_geometry.py

@@ -1,6 +1,25 @@
+# BlenderBIM Add-on - OpenBIM Blender Add-on
+# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
+#
+# This file is part of BlenderBIM Add-on.
+#
+# BlenderBIM Add-on is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# BlenderBIM Add-on 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with BlenderBIM Add-on.  If not, see <http://www.gnu.org/licenses/>.
+
 import blenderbim.core.geometry as subject
 from test.core.bootstrap import ifc, surveyor
 
+
 class TestEditObjectPlacement:
     def test_run(self, ifc, surveyor):
         ifc.get_entity("obj").should_be_called().will_return("element")

src/blenderbim/test/core/test_spatial.py

@@ -0,0 +1,67 @@
+# BlenderBIM Add-on - OpenBIM Blender Add-on
+# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
+#
+# This file is part of BlenderBIM Add-on.
+#
+# BlenderBIM Add-on is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# BlenderBIM Add-on 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with BlenderBIM Add-on.  If not, see <http://www.gnu.org/licenses/>.
+
+import blenderbim.core.spatial as subject
+from test.core.bootstrap import ifc, collector, container, surveyor
+
+
+class TestAssignContainer:
+    def test_run(self, ifc, collector, container, surveyor):
+        container.can_contain("structure_obj", "element_obj").should_be_called().will_return(True)
+        ifc.get_entity("structure_obj").should_be_called().will_return("structure")
+        ifc.get_entity("element_obj").should_be_called().will_return("element")
+        ifc.run(
+            "spatial.assign_container", product="element", relating_structure="structure"
+        ).should_be_called().will_return("rel")
+        surveyor.get_absolute_matrix("element_obj").should_be_called().will_return("matrix")
+        ifc.run("geometry.edit_object_placement", product="element", matrix="matrix").should_be_called()
+        container.disable_editing("element_obj").should_be_called()
+        collector.assign("element_obj").should_be_called()
+        assert (
+            subject.assign_container(
+                ifc, collector, container, surveyor, structure_obj="structure_obj", element_obj="element_obj"
+            )
+            == "rel"
+        )
+
+
+class TestEnableEditingContainer:
+    def test_run(self, container):
+        container.enable_editing("obj").should_be_called()
+        container.import_containers().should_be_called()
+        subject.enable_editing_container(container, obj="obj")
+
+
+class TestDisableEditingContainer:
+    def test_run(self, container):
+        container.disable_editing("obj").should_be_called()
+        subject.disable_editing_container(container, obj="obj")
+
+
+class TestChangeSpatialLevel:
+    def test_run(self, container):
+        container.import_containers(parent="parent").should_be_called()
+        subject.change_spatial_level(container, parent="parent")
+
+
+class TestRemoveContainer:
+    def test_run(self, ifc, collector):
+        ifc.get_entity("obj").should_be_called().will_return("element")
+        ifc.run("spatial.remove_container", product="element").should_be_called()
+        collector.assign("obj").should_be_called()
+        subject.remove_container(ifc, collector, obj="obj")

src/blenderbim/test/tool/test_collector.py

@@ -0,0 +1,57 @@
+# BlenderBIM Add-on - OpenBIM Blender Add-on
+# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
+#
+# This file is part of BlenderBIM Add-on.
+#
+# BlenderBIM Add-on is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# BlenderBIM Add-on 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with BlenderBIM Add-on.  If not, see <http://www.gnu.org/licenses/>.
+
+import bpy
+import ifcopenshell
+import blenderbim.core.tool
+import blenderbim.tool as tool
+from blenderbim.tool.collector import Collector as subject
+from test.bim.bootstrap import NewFile
+
+
+class TestImplementsTool(NewFile):
+    def test_run(self):
+        assert isinstance(subject(), blenderbim.core.tool.Collector)
+
+
+class TestAssign(NewFile):
+    def test_in_decomposition_mode_walls_are_placed_in_its_spatial_collection(self):
+        bpy.ops.bim.create_project()
+        wall_obj = bpy.data.objects.new("Object", None)
+        wall_element = tool.Ifc.get().createIfcWall()
+        tool.Ifc.link(wall_element, wall_obj)
+        bpy.context.scene.collection.objects.link(wall_obj)
+        ifcopenshell.api.run(
+            "spatial.assign_container",
+            tool.Ifc.get(),
+            product=wall_element,
+            relating_structure=tool.Ifc.get().by_type("IfcSite")[0],
+        )
+        subject.assign(wall_obj)
+        assert len(wall_obj.users_collection) == 1
+        assert "IfcSite" in wall_obj.users_collection[0].name
+
+    def test_in_decomposition_mode_walls_are_placed_in_the_project_if_not_decomposes(self):
+        bpy.ops.bim.create_project()
+        wall_obj = bpy.data.objects.new("Object", None)
+        wall_element = tool.Ifc.get().createIfcWall()
+        tool.Ifc.link(wall_element, wall_obj)
+        bpy.context.scene.collection.objects.link(wall_obj)
+        subject.assign(wall_obj)
+        assert len(wall_obj.users_collection) == 1
+        assert "IfcProject" in wall_obj.users_collection[0].name

src/blenderbim/test/tool/test_container.py

@@ -1,3 +1,21 @@
+# BlenderBIM Add-on - OpenBIM Blender Add-on
+# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
+#
+# This file is part of BlenderBIM Add-on.
+#
+# BlenderBIM Add-on is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# BlenderBIM Add-on 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with BlenderBIM Add-on.  If not, see <http://www.gnu.org/licenses/>.
+
 import bpy
 import ifcopenshell
 import blenderbim.core.tool

src/blenderbim/test/tool/test_owner.py

@@ -1,3 +1,21 @@
+# BlenderBIM Add-on - OpenBIM Blender Add-on
+# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
+#
+# This file is part of BlenderBIM Add-on.
+#
+# BlenderBIM Add-on is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# BlenderBIM Add-on 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with BlenderBIM Add-on.  If not, see <http://www.gnu.org/licenses/>.
+
 import bpy
 import ifcopenshell
 import test.bim.bootstrap

src/blenderbim/test/tool/test_surveyor.py

@@ -1,3 +1,21 @@
+# BlenderBIM Add-on - OpenBIM Blender Add-on
+# Copyright (C) 2021 Dion Moult <dion@thinkmoult.com>
+#
+# This file is part of BlenderBIM Add-on.
+#
+# BlenderBIM Add-on is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# BlenderBIM Add-on 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with BlenderBIM Add-on.  If not, see <http://www.gnu.org/licenses/>.
+
 import bpy
 import numpy as np
 import ifcopenshell