ifcopenshell.api.alignment.create_alignment_by_pi_method

Module Contents

ifcopenshell.api.alignment.create_alignment_by_pi_method.create_alignment_by_pi_method(file: ifcopenshell.file, alignment_name: str, hpoints: Sequence[Sequence[float]], radii: Sequence[float], vpoints: Sequence[Sequence[float]] = None, lengths: Sequence[float] = None, alignment_description: str = None) → ifcopenshell.entity_instance

Create an alignment using the PI layout method for both horizontal and vertical alignments. If vpoints and lengths are omitted, only a horizontal alignment is created. Only the business logic entities are creaed. Use create_geometric_representation() to create the geometric entities.

Parameters:

  • alignment_name – value for Name attribute

  • points – (X,Y) pairs denoting the location of the horizontal PIs, including start and end

  • radii – radii values to use for transition

  • vpoints – (distance_along, Z_height) pairs denoting the location of the vertical PIs, including start and end.

  • lengths – parabolic vertical curve horizontal length values to use for transition

  • alignment_description – value for Description attribute

Returns:

Returns an IfcAlignment