First attempt at ripping out agnostic code into ifcopenshell.api namespace. See #1399.

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

@@ -0,0 +1,16 @@
+import ifcopenshell
+
+
+class Usecase:
+    def __init__(self, file, settings=None):
+        self.file = file
+        self.settings = {"constituent_set": None, "material": None}
+        for key, value in settings.items():
+            self.settings[key] = value
+
+    def execute(self):
+        constituents = list(self.settings["constituent_set"].MaterialConstituents or [])
+        constituent = self.file.create_entity("IfcMaterialConstituent", **{"Material": self.settings["material"]})
+        constituents.append(constituent)
+        self.settings["constituent_set"].MaterialConstituents = constituents
+        return constituent

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

@@ -0,0 +1,19 @@
+import ifcopenshell
+
+
+class Usecase:
+    def __init__(self, file, settings=None):
+        self.file = file
+        self.settings = {"layer_set": None, "material": None}
+        for key, value in settings.items():
+            self.settings[key] = value
+
+    def execute(self):
+        layers = list(self.settings["layer_set"].MaterialLayers or [])
+        layer = self.file.create_entity("IfcMaterialLayer", **{
+            "Material": self.settings["material"],
+            "LayerThickness": 0.
+        })
+        layers.append(layer)
+        self.settings["layer_set"].MaterialLayers = layers
+        return layer

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

@@ -0,0 +1,14 @@
+import ifcopenshell
+
+
+class Usecase:
+    def __init__(self, file, settings=None):
+        self.file = file
+        self.settings = {"material_list": None, "material": None}
+        for key, value in settings.items():
+            self.settings[key] = value
+
+    def execute(self):
+        materials = list(self.settings["material_list"].Materials or [])
+        materials.append(self.settings["material"])
+        self.settings["material_list"].Materials = materials

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

@@ -0,0 +1,12 @@
+import ifcopenshell
+
+
+class Usecase:
+    def __init__(self, file, settings=None):
+        self.file = file
+        self.settings = {"Name": "Unnamed"}
+        for key, value in settings.items():
+            self.settings[key] = value
+
+    def execute(self):
+        return self.file.create_entity("IfcMaterial", **{"Name": self.settings["Name"] or "Unnamed"})

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

@@ -0,0 +1,67 @@
+import ifcopenshell
+
+
+class Usecase:
+    def __init__(self, file, settings=None):
+        self.file = file
+        self.settings = {"product": None, "type": "IfcMaterial", "material": None}
+        for key, value in settings.items():
+            self.settings[key] = value
+
+    def execute(self):
+        if self.settings["type"] == "IfcMaterial":
+            self.assign_ifc_material()
+        elif self.settings["type"] == "IfcMaterialConstituentSet":
+            material_set = self.file.create_entity(self.settings["type"])
+            self.create_material_association(material_set)
+        elif self.settings["type"] == "IfcMaterialLayerSet":
+            material_set = self.file.create_entity(self.settings["type"])
+            self.create_material_association(material_set)
+        elif self.settings["type"] == "IfcMaterialLayerSetUsage":
+            material_set = self.file.create_entity("IfcMaterialLayerSet")
+            material_set_usage = self.create_layer_set_usage(material_set)
+            self.create_material_association(material_set_usage)
+        elif self.settings["type"] == "IfcMaterialProfileSet":
+            material_set = self.file.create_entity(self.settings["type"])
+            self.create_material_association(material_set)
+        elif self.settings["type"] == "IfcMaterialList":
+            material_set = self.file.create_entity(self.settings["type"])
+            material_set.Materials = [self.settings["material"]]
+            self.create_material_association(material_set)
+
+    def create_layer_set_usage(self, material_set):
+        return self.file.create_entity("IfcMaterialLayerSetUsage", **{
+            "ForLayerSet": material_set,
+            "LayerSetDirection": "AXIS2" if self.settings["product"].is_a("IfcWall") else "AXIS3",
+            "DirectionSense": "POSITIVE",
+            "OffsetFromReferenceLine": 0
+        })
+
+    def assign_ifc_material(self):
+        rel = self.get_rel_associates_material(self.settings["material"])
+        if not rel:
+            return self.create_material_association(self.settings["material"])
+        related_objects = list(rel.RelatedObjects)
+        related_objects.append(self.settings["product"])
+        rel.RelatedObjects = related_objects
+
+    def create_material_association(self, relating_material):
+        return self.file.create_entity(
+            "IfcRelAssociatesMaterial",
+            **{
+                "GlobalId": ifcopenshell.guid.new(),
+                "RelatedObjects": [self.settings["product"]],
+                "RelatingMaterial": relating_material,
+            }
+        )
+
+    def get_rel_associates_material(self, material):
+        if self.file.schema == "IFC2X3":
+            rel = [
+                r
+                for r in self.file.by_type("IfcRelAssociatesMaterial")
+                if r.RelatingMaterial == self.settings["material"]
+            ]
+            return rel[0] if rel else None
+        if self.settings["material"].AssociatedTo:
+            return self.settings["material"].AssociatedTo[0]

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

@@ -0,0 +1,114 @@
+import ifcopenshell
+
+
+class Data:
+    is_loaded = False
+    materials = {}
+    constituent_sets = {}
+    constituents = {}
+    layer_sets = {}
+    layers = {}
+    profile_sets = {}
+    profiles = {}
+    lists = {}
+    products = {}
+    _file = None
+
+    @classmethod
+    def purge(cls):
+        cls.is_loaded = False
+        cls.materials = {}
+        cls.constituent_sets = {}
+        cls.constituents = {}
+        cls.layer_set_usages = {}
+        cls.layer_sets = {}
+        cls.layers = {}
+        cls.profile_sets = {}
+        cls.profiles = {}
+        cls.lists = {}
+        cls.products = {}
+        cls._file = None
+
+    @classmethod
+    def load(cls, file, product_id=None):
+        cls._file = file
+        if not cls._file:
+            return
+        if product_id:
+            return cls.load_product_material(product_id)
+        cls.load_materials()
+        cls.load_constituents()
+        cls.load_layers()
+        cls.load_layer_usages()
+        cls.load_profiles()
+        cls.load_lists()
+        cls.is_loaded = True
+
+    @classmethod
+    def load_materials(cls):
+        cls.materials = {}
+        cls.load_element("IfcMaterial", cls.materials)
+
+    @classmethod
+    def load_constituents(cls):
+        cls.constituent_sets = {}
+        cls.constituents = {}
+        cls.load_element("IfcMaterialConstituent", cls.constituents)
+        cls.load_element("IfcMaterialConstituentSet", cls.constituent_sets)
+
+    @classmethod
+    def load_layers(cls):
+        cls.layer_sets = {}
+        cls.layers = {}
+        cls.load_element("IfcMaterialLayer", cls.layers)
+        cls.load_element("IfcMaterialLayerSet", cls.layer_sets)
+
+    @classmethod
+    def load_layer_usages(cls):
+        cls.layer_set_usages = {}
+        cls.load_element("IfcMaterialLayerSetUsage", cls.layer_set_usages)
+
+    @classmethod
+    def load_profiles(cls):
+        cls.profile_sets = {}
+        cls.profiles = {}
+        cls.load_element("IfcMaterialProfile", cls.profiles)
+        cls.load_element("IfcMaterialProfileSet", cls.profile_sets)
+
+    @classmethod
+    def load_lists(cls):
+        cls.lists = {}
+        cls.load_element("IfcMaterialList", cls.lists)
+
+    @classmethod
+    def load_product_material(cls, product_id):
+        cls.products[product_id] = {}
+        for association in cls._file.by_id(product_id).HasAssociations:
+            if association.is_a("IfcRelAssociatesMaterial"):
+                cls.load_association(association, product_id)
+
+    @classmethod
+    def load_element(cls, ifc_class, to_dict):
+        try:
+            elements = cls._file.by_type(ifc_class)
+        except:
+            return
+        for element in elements:
+            to_dict[element.id()] = cls.get_simple_info(element)
+
+    @classmethod
+    def get_simple_info(cls, element):
+        info = element.get_info()
+        for key, value in info.items():
+            if isinstance(value, ifcopenshell.entity_instance):
+                info[key] = value.id()
+            elif isinstance(value, tuple) and value and isinstance(value[0], ifcopenshell.entity_instance):
+                info[key] = [v.id() for v in value]
+        return info
+
+    @classmethod
+    def load_association(cls, association, product_id):
+        material_select = association.RelatingMaterial
+        if material_select.is_a("IfcMaterialProfileSetUsage"):  # TODO: implement usages
+            material_select = material_select.ForProfileSet
+        cls.products[product_id] = {"type": material_select.is_a(), "id": material_select.id()}

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

@@ -0,0 +1,13 @@
+class Usecase():
+    def __init__(self, file, settings=None):
+        self.file = file
+        self.settings = {
+            "element": None,
+            "attributes": {}
+        }
+        for key, value in settings.items():
+            self.settings[key] = value
+
+    def execute(self):
+        for name, value in self.settings["attributes"].items():
+            setattr(self.settings["element"], name, value)

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

@@ -0,0 +1,15 @@
+class Usecase():
+    def __init__(self, file, settings=None):
+        self.file = file
+        self.settings = {
+            "constituent": None,
+            "attributes": {},
+            "material": None
+        }
+        for key, value in settings.items():
+            self.settings[key] = value
+
+    def execute(self):
+        for name, value in self.settings["attributes"].items():
+            setattr(self.settings["constituent"], name, value)
+        self.settings["constituent"].Material = self.settings["material"]

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

@@ -0,0 +1,15 @@
+class Usecase():
+    def __init__(self, file, settings=None):
+        self.file = file
+        self.settings = {
+            "layer": None,
+            "attributes": {},
+            "material": None
+        }
+        for key, value in settings.items():
+            self.settings[key] = value
+
+    def execute(self):
+        for name, value in self.settings["attributes"].items():
+            setattr(self.settings["layer"], name, value)
+        self.settings["layer"].Material = self.settings["material"]

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

@@ -0,0 +1,15 @@
+class Usecase():
+    def __init__(self, file, settings=None):
+        self.file = file
+        self.settings = {
+            "profile": None,
+            "attributes": {},
+            "material": None
+        }
+        for key, value in settings.items():
+            self.settings[key] = value
+
+    def execute(self):
+        for name, value in self.settings["attributes"].items():
+            setattr(self.settings["profile"], name, value)
+        self.settings["profile"].Material = self.settings["material"]

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

@@ -0,0 +1,12 @@
+import ifcopenshell
+
+
+class Usecase:
+    def __init__(self, file, settings=None):
+        self.file = file
+        self.settings = {"constituent": None}
+        for key, value in settings.items():
+            self.settings[key] = value
+
+    def execute(self):
+        self.file.remove(self.settings["constituent"])

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

@@ -0,0 +1,12 @@
+import ifcopenshell
+
+
+class Usecase:
+    def __init__(self, file, settings=None):
+        self.file = file
+        self.settings = {"layer": None}
+        for key, value in settings.items():
+            self.settings[key] = value
+
+    def execute(self):
+        self.file.remove(self.settings["layer"])

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

@@ -0,0 +1,13 @@
+import ifcopenshell
+
+
+class Usecase:
+    def __init__(self, file, settings=None):
+        self.file = file
+        self.settings = {"material_list": None, "material": None}
+        for key, value in settings.items():
+            self.settings[key] = value
+
+    def execute(self):
+        materials = [m for m in self.settings["material_list"].Materials if m != self.settings["material"]]
+        self.settings["material_list"].Materials = materials

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

@@ -0,0 +1,23 @@
+import ifcopenshell
+
+
+class Usecase:
+    def __init__(self, file, settings=None):
+        self.file = file
+        self.settings = {"material": None}
+        for key, value in settings.items():
+            self.settings[key] = value
+
+    def execute(self):
+        inverse_elements = self.file.get_inverse(self.settings["material"])
+        self.file.remove(self.settings["material"])
+        # TODO: this is probably not robust enough
+        for inverse in inverse_elements:
+            if inverse.is_a("IfcMaterialConstituent"):
+                self.file.remove(inverse)
+            elif inverse.is_a("IfcMaterialLayer"):
+                self.file.remove(inverse)
+            elif inverse.is_a("IfcMaterialProfile"):
+                self.file.remove(inverse)
+            elif inverse.is_a("IfcRelAssociatesMaterial"):
+                self.file.remove(inverse)

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

@@ -0,0 +1,19 @@
+class Usecase:
+    def __init__(self, file, settings=None):
+        self.file = file
+        self.settings = {"material_set": None, "old_index": 0, "new_index": 0}
+        for key, value in settings.items():
+            self.settings[key] = value
+
+    def execute(self):
+        if self.settings["material_set"].is_a("IfcMaterialConstituentSet"):
+            set_name = "MaterialConstituents"
+        elif self.settings["material_set"].is_a("IfcMaterialLayerSet"):
+            set_name = "MaterialLayers"
+        elif self.settings["material_set"].is_a("IfcMaterialProfileSet"):
+            set_name = "MaterialProfiles"
+        elif self.settings["material_set"].is_a("IfcMaterialList"):
+            set_name = "Materials"
+        items = list(getattr(self.settings["material_set"], set_name) or [])
+        items.insert(self.settings["new_index"], items.pop(self.settings["old_index"]))
+        setattr(self.settings["material_set"], set_name, items)

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

@@ -0,0 +1,14 @@
+import ifcopenshell
+
+
+class Usecase:
+    def __init__(self, file, settings=None):
+        self.file = file
+        self.settings = {"product": None}
+        for key, value in settings.items():
+            self.settings[key] = value
+
+    def execute(self):
+        for association in self.settings["product"].HasAssociations:
+            if association.is_a("IfcRelAssociatesMaterial"):
+                self.file.remove(association)