First Commit

2026-05-31 10:17:09 +07:00
commit 17a9c69379
4547 changed files with 1170384 additions and 0 deletions
@@ -0,0 +1,36 @@
+# IfcOpenShell - IFC toolkit and geometry engine
+# Copyright (C) 2022 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/>.
+
+"""Create relationships necessary for smart annotations for drawings
+
+Drawings may be generated from modeled elements and annotations. These
+annotations may have relationships which indicate smart data being populated.
+"""
+
+from .. import wrap_usecases
+from .assign_product import assign_product
+from .edit_text_literal import edit_text_literal
+from .unassign_product import unassign_product
+
+wrap_usecases(__path__, __name__)
+
+__all__ = [
+    "assign_product",
+    "edit_text_literal",
+    "unassign_product",
+]
@@ -0,0 +1,105 @@
+# IfcOpenShell - IFC toolkit and geometry engine
+# Copyright (C) 2021 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 ifcopenshell
+import ifcopenshell.api.owner
+import ifcopenshell.guid
+
+
+def assign_product(
+    file: ifcopenshell.file,
+    relating_product: ifcopenshell.entity_instance,
+    related_object: ifcopenshell.entity_instance,
+) -> ifcopenshell.entity_instance:
+    """Associates a product and an object, typically for annotation
+
+    Warning: this is an experimental API.
+
+    When you want to draw attention to a feature or characteristic (such as
+    a dimension, material, or name) or of a product (e.g. wall, slab,
+    furniture, etc), an annotation object is created. This annotation is
+    then associated with the product so that it can reference attributes,
+    properties, and relationships.
+
+    For example, an annotation of a line will be associated with a grid
+    axis, such that when that grid axis moves, the annotation of that grid
+    axis (which is typically truncated to the extents of a drawing) will
+    also move.
+
+    Another example might be a label of a furniture product, which might
+    have some text of the name of the furniture to be shown on drawings or
+    in 3D.
+
+    :param relating_product: The IfcProduct the object is related to
+    :param related_object: The object (typically IfcAnnotation) that the
+        product is related to
+    :return: The created IfcRelAssignsToProduct relationship
+
+    Example:
+
+    .. code:: python
+
+        furniture = ifcopenshell.api.root.create_entity(model, ifc_class="IfcFurniture")
+        annotation = ifcopenshell.api.root.create_entity(model, ifc_class="IfcAnnotation")
+        ifcopenshell.api.drawing.assign_product(model,
+            relating_product=furniture, related_object=annotation)
+    """
+    if relating_product.is_a("IfcGridAxis"):
+        axis = relating_product
+        grid = None
+        for attribute in ("PartOfW", "PartOfV", "PartOfU"):
+            if getattr(axis, attribute, None):
+                grid = getattr(axis, attribute)[0]
+                break
+        for rel in grid.ReferencedBy or []:
+            if rel.Name == axis.AxisTag and related_object in rel.RelatedObjects:
+                return
+
+        return file.create_entity(
+            "IfcRelAssignsToProduct",
+            GlobalId=ifcopenshell.guid.new(),
+            Name=axis.AxisTag,
+            OwnerHistory=ifcopenshell.api.owner.create_owner_history(file),
+            RelatedObjects=[related_object],
+            RelatingProduct=grid,
+        )
+
+    if related_object.HasAssignments:
+        for rel in related_object.HasAssignments:
+            if rel.is_a("IfcRelAssignsToProduct") and rel.RelatingProduct == relating_product:
+                return
+
+    referenced_by = None
+    if relating_product.ReferencedBy:
+        referenced_by = relating_product.ReferencedBy[0]
+
+    if referenced_by:
+        related_objects = list(referenced_by.RelatedObjects)
+        related_objects.append(related_object)
+        referenced_by.RelatedObjects = related_objects
+        ifcopenshell.api.owner.update_owner_history(file, element=referenced_by)
+    else:
+        referenced_by = file.create_entity(
+            "IfcRelAssignsToProduct",
+            GlobalId=ifcopenshell.guid.new(),
+            OwnerHistory=ifcopenshell.api.owner.create_owner_history(file),
+            RelatedObjects=[related_object],
+            RelatingProduct=relating_product,
+        )
+
+    return referenced_by
@@ -0,0 +1,44 @@
+# IfcOpenShell - IFC toolkit and geometry engine
+# Copyright (C) 2021 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/>.
+from typing import Any
+
+import ifcopenshell
+
+
+def edit_text_literal(
+    file: ifcopenshell.file, text_literal: ifcopenshell.entity_instance, attributes: dict[str, Any]
+) -> None:
+    """Edits the attributes of an IfcTextLiteral
+
+    For more information about the attributes and data types of an
+    IfcTextLiteral, consult the IFC documentation.
+
+    :param reference: The IfcTextLiteral entity you want to edit
+    :param attributes: a dictionary of attribute names and values.
+    :return: None
+
+    Example:
+
+    .. code:: python
+
+        text = model.createIfcTextLiteral()
+        ifcopenshell.api.drawing.edit_text_literal(model,
+            text_literal=text, attributes={"Literal": "MY ANNOTATION"})
+    """
+    for name, value in attributes.items():
+        setattr(text_literal, name, value)
@@ -0,0 +1,74 @@
+# IfcOpenShell - IFC toolkit and geometry engine
+# Copyright (C) 2021 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 ifcopenshell
+import ifcopenshell.api.owner
+import ifcopenshell.util.element
+
+
+def unassign_product(
+    file: ifcopenshell.file,
+    relating_product: ifcopenshell.entity_instance,
+    related_object: ifcopenshell.entity_instance,
+) -> None:
+    """Unassigns a product and an object (typically an annotation)
+
+    Smart annotation objects can be associated with products so that they
+    can annotate attributes and properties. This function lets you remove
+    the association, so that you may change the assocation with another
+    object later or leave the annotation as a "dumb" annotation.
+
+    :param relating_product: The IfcProduct the object is related to
+    :param related_object: The object (typically IfcAnnotation) that the
+        product is related to
+    :return: None
+
+    Example:
+
+    .. code:: python
+
+        furniture = ifcopenshell.api.root.create_entity(model, ifc_class="IfcFurniture")
+        annotation = ifcopenshell.api.root.create_entity(model, ifc_class="IfcAnnotation")
+        ifcopenshell.api.drawing.assign_product(model,
+            relating_product=furniture, related_object=annotation)
+
+        # Let's change our mind and remove the relationship
+        ifcopenshell.api.drawing.unassign_product(model,
+            relating_product=furniture, related_object=annotation)
+    """
+    if relating_product.is_a("IfcGridAxis"):
+        grid = None
+        for attribute in ("PartOfW", "PartOfV", "PartOfU"):
+            if getattr(relating_product, attribute, None):
+                grid = getattr(relating_product, attribute)[0]
+                break
+        relating_product = grid
+
+    for rel in related_object.HasAssignments or []:
+        if not rel.is_a("IfcRelAssignsToProduct") or rel.RelatingProduct != relating_product:
+            continue
+        if len(rel.RelatedObjects) == 1:
+            history = rel.OwnerHistory
+            file.remove(rel)
+            if history:
+                ifcopenshell.util.element.remove_deep2(file, history)
+            return
+        related_objects = list(rel.RelatedObjects)
+        related_objects.remove(related_object)
+        rel.RelatedObjects = related_objects
+        ifcopenshell.api.owner.update_owner_history(file, element=rel)