Alignment api update (#6817)

* Some basic COGO survey points functions * Update alignment api Includes defining alignment segment by segment, automatic geometry definitions, and automatric stationing and referents * Fixes bonsai import alignment from csv * Adds DMS angle conversion functions to COGO api * Updated per @civilx64 review comments * Fixes problem with segment representations * Fixes problem with segment transition codes * Allows for compound vertical and horizontal curves * Implements callbacks for referent naming * Renames angle_from_bearing to bearing2dd for consistency with ifcopenshell.util.geolocation.dms2dd. Removes angle_from_dms because it duplicates dms2dd * Documents register_referent_name_callback * Fixes all sorts of problems with Cant/SegRefCurve implementation * refactor referent unit tests to use a fixture for test setup * lint with black --------- Co-authored-by: Scott Lecher <civilx64@gmail.com>
2026-08-11 02:02:22 +00:00 · 2025-07-08 10:09:14 -07:00
parent ad8d02bfed
commit 40f92d15c3
76 changed files with 3645 additions and 1839 deletions
@@ -0,0 +1,137 @@
+# IfcOpenShell - IFC toolkit and geometry engine
+# Copyright (C) 2025 Thomas Krijnen <thomas@aecgeeks.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.alignment
+import ifcopenshell.api.nest
+import ifcopenshell.api.pset
+import ifcopenshell.util.stationing
+import ifcopenshell.guid
+from ifcopenshell import entity_instance
+from ifcopenshell import ifcopenshell_wrapper
+import numpy as np
+
+
+def add_stationing_referent(
+    file: ifcopenshell.file,
+    element: entity_instance,
+    basis_curve: entity_instance,
+    distance_along: float,
+    station: float,
+    name: str,
+) -> entity_instance:
+    """
+    Adds an IfcReferent to the element with the Pset_Stationing property set.
+    If element is an IfcAlignment, IfcReferent.PredefinedType is set to "STATION", otherwise "POSITION"
+
+    :param element: the element to receive the referent, expected to be an IfcAlignment or IfcAlignmentSegment
+    :param basis_curve: the basis curve for positining
+    :param distance_along: distance along the basis curve
+    :param station: station value
+    :param name: name to assign to IfcReferent.Name, typically a stringized version of the station value
+    :return: referent
+
+    Example:
+
+    .. code:: python
+
+        alignment = model.by_type("IfcAlignment")[0]
+        basis_curve = ifcopenshell.api.alignment.get_basis_curve(alignment)
+        ifcopenshell.api.alignment.add_stationing_referent(model,entity=alignment,basis_curve=basis_curve,distance_along=0.0,station=100.0)
+    """
+    object_placement = None
+    representation = None
+    if basis_curve:
+        unit_scale = ifcopenshell.util.unit.calculate_unit_scale(file)
+
+        settings = ifcopenshell.geom.settings()
+        fn = ifcopenshell_wrapper.map_shape(settings, basis_curve.wrapped_data)
+        evaluator = ifcopenshell_wrapper.function_item_evaluator(settings, fn)
+        p = evaluator.evaluate(distance_along * unit_scale)
+        p = np.array(p)
+
+        x = float(p[0, 3]) / unit_scale
+        y = float(p[1, 3]) / unit_scale
+        z = float(p[2, 3]) / unit_scale
+
+        rx = float(p[0, 0])
+        ry = float(p[1, 0])
+        rz = float(p[2, 0])
+
+        ax = float(p[0, 2])
+        ay = float(p[1, 2])
+        az = float(p[2, 2])
+
+        object_placement = file.createIfcLinearPlacement(
+            RelativePlacement=file.createIfcAxis2PlacementLinear(
+                Location=file.createIfcPointByDistanceExpression(
+                    DistanceAlong=file.createIfcLengthMeasure(distance_along),
+                    OffsetLateral=None,
+                    OffsetVertical=None,
+                    OffsetLongitudinal=None,
+                    BasisCurve=basis_curve,
+                )
+            ),
+            CartesianPosition=file.createIfcAxis2Placement3D(
+                Location=file.createIfcCartesianPoint(((x, y, z))),
+                Axis=file.createIfcDirection((ax, ay, az)),
+                RefDirection=file.createIfcDirection((rx, ry, rz)),
+            ),
+        )
+    # this commented out code is what you would do to add a geometric representation of the referent
+    # the example is a circle. a better way would be to pass a representation into the function
+    #    representation = file.create_entity(
+    #        name="IfcCircle",
+    #        position=file.createIfcAxis2Placement2D(Location=file.createIfcCartesianPoint(Coordinates=(0.0, 0.0)),
+    #        radius=1.0)
+    #    )
+
+    # create referent for the station
+    predefined_type = "STATION" if element.is_a("IfcAlignment") else "POSITION"
+    referent = file.createIfcReferent(
+        GlobalId=ifcopenshell.guid.new(),
+        OwnerHistory=None,
+        Name=name,
+        Description=None,
+        ObjectType=None,
+        ObjectPlacement=object_placement,
+        Representation=representation,
+        PredefinedType=predefined_type,
+    )
+    pset_stationing = ifcopenshell.api.pset.add_pset(file, product=referent, name="Pset_Stationing")
+    ifcopenshell.api.pset.edit_pset(file, pset=pset_stationing, properties={"Station": station})
+    ifcopenshell.api.nest.assign_object(file, related_objects=[referent], relating_object=element)
+
+    alignment = element
+
+    if element.is_a("IfcAlignmentSegment"):
+        layout = element.Nests[0].RelatingObject
+        alignment = ifcopenshell.api.alignment.get_alignment(layout)
+
+    if len(alignment.Positions) == 0:
+        rel_positions = file.createIfcRelPositions(
+            GlobalId=ifcopenshell.guid.new(),
+            RelatingPositioningElement=alignment,
+            RelatedProducts=[
+                referent,
+            ],
+        )
+    else:
+        alignment.Positions[0].RelatedProducts += (referent,)
+
+    return referent