ifcopenshell.api.alignment.create_alignment

Module Contents

ifcopenshell.api.alignment.create_alignment.create(file: ifcopenshell.file, name: str, include_vertical: bool = False, include_cant: bool = False, start_station: float = 0.0) → ifcopenshell.entity_instance

Creates a new IfcAlignment with an IfcRelNests nesting an IfcReferent (for stationing) and IfcAlignmentHorizontal. The nest relationship can optionally include IfcAlignmentVertical and IfcAlignmentCant. Geometric representations for the alignment layouts (IfcCompositeCurve, IfcGradientCurve, IfcSegmentedReferenceCurve) are created as well.

Zero length segments are added at the end.

The IfcAlignment is aggreated to IfcProject

Use get_horizontal_layout(alignment) to get the IfcAlignmentHorizontal layout.

Parameters:

  • file

  • name – name assigned to IfcAlignment.Name

  • include_vertical – If True, IfcAlignmentVertical and IfcGradientCurve are created

  • include_cant – If True, IfcAlignmentCant and IfcSegmentedReferenceCurve are created

  • start_station – station value at the start of the alignment

Returns:

Returns an IfcAlignment