Merge remote-tracking branch 'pr-8928/feat-4779-material-merge' into Frankenstein_build-0.9.0-alpha2610050136

Author: bonsaiPR automation

src/bonsai/bonsai/bim/module/material/__init__.py

@@ -37,6 +37,7 @@
     operator.DisableEditingMaterialSetItem,
     operator.DisableEditingMaterialSetItemProfile,
     operator.DisableEditingMaterials,
+    operator.DisableMaterialMerge,
     operator.DuplicateLayer,
     operator.EditAssignedMaterial,
     operator.EditMaterial,
@@ -48,8 +49,10 @@
     operator.EnableEditingMaterialSetItem,
     operator.EnableEditingMaterialSetItemProfile,
     operator.EnableEditingMaterialStyle,
+    operator.EnableMaterialMerge,
     operator.ExpandMaterialCategory,
     operator.LoadMaterials,
+    operator.MergeMaterials,
     operator.RemoveConstituent,
     operator.RemoveLayer,
     operator.RemoveListItem,

src/bonsai/bonsai/bim/module/material/operator.py

@@ -361,6 +361,64 @@ def _execute(self, context):
             return {"CANCELLED"}
 
 
+class EnableMaterialMerge(bpy.types.Operator):
+    bl_idname = "bim.enable_material_merge"
+    bl_label = "Merge Materials"
+    bl_description = "Pick two or more redundant materials to merge into the active material"
+    bl_options = {"REGISTER", "UNDO"}
+
+    def execute(self, context):
+        props = tool.Material.get_material_props()
+        props.is_merging_materials = True
+        for material in props.materials:
+            material.is_selected = False
+        return {"FINISHED"}
+
+
+class DisableMaterialMerge(bpy.types.Operator):
+    bl_idname = "bim.disable_material_merge"
+    bl_label = "Cancel Merging Materials"
+    bl_options = {"REGISTER", "UNDO"}
+
+    def execute(self, context):
+        props = tool.Material.get_material_props()
+        props.is_merging_materials = False
+        for material in props.materials:
+            material.is_selected = False
+        return {"FINISHED"}
+
+
+class MergeMaterials(bpy.types.Operator, tool.Ifc.Operator):
+    bl_idname = "bim.merge_materials"
+    bl_label = "Merge Selected Into Active"
+    bl_description = (
+        "Merge the checked materials into the active material.\n"
+        "Every product, type, layer, profile, constituent, and material list that used "
+        "one of the checked materials is reassigned to the active material.\n"
+        "The now-redundant materials, along with their own properties and styles, are removed."
+    )
+    bl_options = {"REGISTER", "UNDO"}
+
+    def _execute(self, context):
+        ifc_file = tool.Ifc.get()
+        props = tool.Material.get_material_props()
+        active_material = props.active_material
+        if not active_material or active_material.is_category:
+            self.report({"ERROR"}, "Select the material to merge into first.")
+            return {"CANCELLED"}
+        target = ifc_file.by_id(active_material.ifc_definition_id)
+        sources = [
+            ifc_file.by_id(m.ifc_definition_id)
+            for m in props.materials
+            if m.is_selected and not m.is_category and m.ifc_definition_id != target.id()
+        ]
+        if not sources:
+            self.report({"ERROR"}, "No materials were checked to merge.")
+            return {"CANCELLED"}
+        core.merge_materials(tool.Ifc, tool.Material, materials=sources, merge_into=target)
+        props.is_merging_materials = False
+
+
 class RemoveMaterialSet(bpy.types.Operator, tool.Ifc.Operator):
     bl_idname = "bim.remove_material_set"
     bl_label = "Remove Material Set"

src/bonsai/bonsai/bim/module/material/prop.py

@@ -153,6 +153,7 @@ class Material(PropertyGroup):
     is_expanded: BoolProperty(name="Is Expanded", default=False)
     has_style: BoolProperty(name="Has Style", default=True)
     total_elements: IntProperty(name="Total Elements")
+    is_selected: BoolProperty(name="Is Selected", description="Selected as a source material to merge", default=False)
 
     if TYPE_CHECKING:
         name: str
@@ -161,6 +162,7 @@ class Material(PropertyGroup):
         is_expanded: bool
         has_style: bool
         total_elements: int
+        is_selected: bool
 
 
 class BIMMaterialProperties(PropertyGroup):
@@ -181,6 +183,7 @@ def update_active_material_index(self, context: bpy.types.Context) -> None:
     editing_material_type: StringProperty(name="Editing Material Type")
     styles: EnumProperty(items=get_styles, name="Styles")
     contexts: EnumProperty(items=get_contexts, name="Contexts")
+    is_merging_materials: BoolProperty(name="Is Merging Materials", default=False)
 
     @property
     def active_material(self) -> Material | None:
@@ -199,6 +202,7 @@ def active_material(self) -> Material | None:
         editing_material_type: str
         styles: str
         contexts: str
+        is_merging_materials: bool
 
 
 class BIMObjectMaterialProperties(PropertyGroup):

src/bonsai/bonsai/bim/module/material/ui.py

@@ -81,6 +81,11 @@ def draw(self, context):
                 op = row.operator("bim.enable_editing_material_style", text="", icon="SHADING_RENDERED")
                 op.material = material_id
                 row.operator("bim.remove_material", text="", icon="X").material = material_id
+                if not self.props.is_merging_materials:
+                    row.operator("bim.enable_material_merge", text="", icon="AUTOMERGE_ON")
+
+            if self.props.is_merging_materials:
+                self.draw_merging_ui()
 
             self.draw_editing_ui()
         else:
@@ -108,6 +113,19 @@ def draw(self, context):
                 op.style = style["id"]
                 op.context = style["context_id"]
 
+    def draw_merging_ui(self):
+        selected_total = sum(1 for m in self.props.materials if m.is_selected and not m.is_category)
+        target = self.props.active_material
+        target_name = target.name if target and not target.is_category else "(select a material below)"
+        box = self.layout.box()
+        row = box.row(align=True)
+        row.label(text=f"Merge target: {target_name}", icon="GREASEPENCIL")
+        row = box.row(align=True)
+        row.label(text=f"Check materials below to merge into it ({selected_total} checked)", icon="INFO")
+        row = box.row(align=True)
+        row.operator("bim.merge_materials", text="Merge Into Active", icon="AUTOMERGE_ON")
+        row.operator("bim.disable_material_merge", text="Cancel", icon="CANCEL")
+
     def draw_editing_ui(self):
         if not self.props.active_material_id:
             return
@@ -582,7 +600,10 @@ def draw_item(
                 else:
                     row.prop(item, "name", text="", emboss=False)
             else:
-                row.label(text="", icon="BLANK1")
+                if data.is_merging_materials and material_type == "IfcMaterial":
+                    row.prop(item, "is_selected", text="")
+                else:
+                    row.label(text="", icon="BLANK1")
                 if item.ifc_definition_id == data.active_material_id:
                     row.label(text="", icon="GREASEPENCIL")
                 if material_type == "IfcMaterialList":

src/bonsai/bonsai/core/material.py

@@ -64,6 +64,23 @@ def remove_material(
     return True
 
 
+def merge_materials(
+    ifc: type[tool.Ifc],
+    material_tool: type[tool.Material],
+    materials: list[ifcopenshell.entity_instance],
+    merge_into: ifcopenshell.entity_instance,
+) -> None:
+    """Merge redundant materials into `merge_into`.
+
+    Every reference to a material in `materials` (direct assignments, layers,
+    profiles, constituents, and material lists) is reassigned to
+    `merge_into`, and the now-redundant materials are removed.
+    """
+    ifc.run("material.merge_materials", materials=materials, merge_into=merge_into)
+    if material_tool.is_editing_materials():
+        material_tool.import_material_definitions(material_tool.get_active_material_type())
+
+
 def remove_material_set(
     ifc: type[tool.Ifc], material_tool: type[tool.Material], material: ifcopenshell.entity_instance
 ) -> None:

src/bonsai/test/core/test_material.py

@@ -84,6 +84,20 @@ def test_not_removing_a_material_if_it_is_used_in_a_material_set(self, ifc, mate
         subject.remove_material(ifc, material, material="material")
 
 
+class TestMergeMaterials:
+    def test_merging_materials(self, ifc, material):
+        ifc.run("material.merge_materials", materials=["source1", "source2"], merge_into="target").should_be_called()
+        material.is_editing_materials().should_be_called().will_return(False)
+        subject.merge_materials(ifc, material, materials=["source1", "source2"], merge_into="target")
+
+    def test_merging_materials_and_reloading_imported_materials(self, ifc, material):
+        ifc.run("material.merge_materials", materials=["source1", "source2"], merge_into="target").should_be_called()
+        material.is_editing_materials().should_be_called().will_return(True)
+        material.get_active_material_type().should_be_called().will_return("material_type")
+        material.import_material_definitions("material_type").should_be_called()
+        subject.merge_materials(ifc, material, materials=["source1", "source2"], merge_into="target")
+
+
 class TestRemoveMaterialSet:
     def test_run(self, ifc, material):
         ifc.run("material.remove_material_set", material="material").should_be_called()

src/ifcopenshell-python/ifcopenshell/api/material/__init__.py

@@ -48,6 +48,7 @@
 from .edit_material import edit_material
 from .edit_profile import edit_profile
 from .edit_profile_usage import edit_profile_usage
+from .merge_materials import merge_materials
 from .remove_constituent import remove_constituent
 from .remove_layer import remove_layer
 from .remove_list_item import remove_list_item
@@ -77,6 +78,7 @@
     "edit_material",
     "edit_profile",
     "edit_profile_usage",
+    "merge_materials",
     "remove_constituent",
     "remove_layer",
     "remove_list_item",

src/ifcopenshell-python/ifcopenshell/api/material/merge_materials.py

@@ -0,0 +1,105 @@
+# IfcOpenShell - IFC toolkit and geometry engine
+# Copyright (C) 2024 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/>.
+
+# This file was generated with the assistance of an AI coding tool.
+
+import ifcopenshell
+import ifcopenshell.api.material
+
+
+def merge_materials(
+    file: ifcopenshell.file,
+    materials: list[ifcopenshell.entity_instance],
+    merge_into: ifcopenshell.entity_instance,
+) -> None:
+    """Merges one or more redundant materials into a single designated material
+
+    This is typically used to clean up models (often from import processes)
+    that end up with many duplicate or near-duplicate IfcMaterial
+    definitions. Every product, type, material layer, material profile,
+    material constituent, and material list item that currently references
+    one of `materials` will be repointed to `merge_into` instead. Once a
+    material has no more references, it is removed, along with any
+    properties or styles that belonged only to that redundant material (the
+    definition of `merge_into` "wins").
+
+    If `merge_into` is included in `materials`, it is simply skipped, so it
+    is safe to pass the designated material as part of a "select all, merge"
+    workflow.
+
+    :param materials: The list of redundant IfcMaterial entities to merge and
+        remove.
+    :param merge_into: The IfcMaterial entity that should be used instead of
+        all of `materials`.
+    :return: None
+
+    Example:
+
+    .. code:: python
+
+        # Two suspiciously similar materials, perhaps from a bad import.
+        m1 = ifcopenshell.api.material.add_material(model, name="Concrete")
+        m2 = ifcopenshell.api.material.add_material(model, name="Concrete_2")
+
+        wall1 = ifcopenshell.api.root.create_entity(model, ifc_class="IfcWall")
+        wall2 = ifcopenshell.api.root.create_entity(model, ifc_class="IfcWall")
+        ifcopenshell.api.material.assign_material(model, products=[wall1], material=m1)
+        ifcopenshell.api.material.assign_material(model, products=[wall2], material=m2)
+
+        # Both walls will now use m1, and m2 will no longer exist.
+        ifcopenshell.api.material.merge_materials(model, materials=[m1, m2], merge_into=m1)
+    """
+    materials_to_remove = [m for m in materials if m != merge_into]
+    if not materials_to_remove:
+        return
+
+    for material in materials_to_remove:
+        # Repoint any direct "this product is made of this material" relationship.
+        rel = next(
+            (
+                r
+                for r in file.get_inverse(material)
+                if r.is_a("IfcRelAssociatesMaterial") and r.RelatingMaterial == material
+            ),
+            None,
+        )
+        if rel is not None and rel.RelatedObjects:
+            ifcopenshell.api.material.assign_material(
+                file, products=list(rel.RelatedObjects), type="IfcMaterial", material=merge_into
+            )
+
+        # Repoint material set membership (layers, profiles, constituents, lists).
+        for inverse in file.get_inverse(material):
+            if (
+                inverse.is_a("IfcMaterialLayer")
+                or inverse.is_a("IfcMaterialProfile")
+                or inverse.is_a("IfcMaterialConstituent")
+            ):
+                inverse.Material = merge_into
+            elif inverse.is_a("IfcMaterialList"):
+                new_materials = []
+                for item in inverse.Materials or []:
+                    item = merge_into if item == material else item
+                    if item not in new_materials:
+                        new_materials.append(item)
+                inverse.Materials = new_materials
+
+        # Whatever is left (e.g. properties or a style definition that
+        # belonged only to this now-redundant material) is discarded along
+        # with the material itself.
+        ifcopenshell.api.material.remove_material(file, material=material)