Files
IfcOpenShell/src/ifcopenshell-python/ifcopenshell/api/alignment/get_basis_curve.py
T
Richard Brice 40f92d15c3 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>
2025-07-08 10:09:14 -07:00

55 lines
2.2 KiB
Python

# 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.util
from ifcopenshell import entity_instance
import ifcopenshell.util.representation
def get_basis_curve(alignment: entity_instance) -> entity_instance:
"""
Returns the basis curve for an alignment. This curve is the geometric representation that is used
as the basis curve for vertical and cant alignments.
:param alignment: The alignment
:return: The geometric representation that is used as a basis curve, typically an IfcCompositeCurve, or None if the alignment does not have a representation
Example:
.. code:: python
alignment = model.by_type("IfcAlignment")[0]
composite_curve = ifcopenshell.api.alignment.get_basis_curve(alignment)
"""
axis = None
representations = ifcopenshell.util.representation.get_representations_iter(alignment)
for representation in representations:
if (representation.RepresentationIdentifier == "Axis" and representation.RepresentationType == "Curve2D") or (
representation.RepresentationIdentifier == "FootPrint" and representation.RepresentationType == "Curve2D"
):
axis = representation
return None if axis.Items == None or len(axis.Items) == 0 else axis.Items[0]
if axis == None and 0 < len(alignment.Decomposes):
parent_alignment = alignment.Decomposes[0].RelatingObject
return get_basis_curve(parent_alignment)
return None