ifc-alignment 0.6.0

IFC4x3 linear positioning: alignments, referents, linear placement, spirals.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

//! `ifc-alignment` -- Linear referencing and alignment -- the IFC4x3 civil layer.
//!
//!
//! IFC4x3 adds 14 alignment entities plus spiral curve types (`IfcClothoid`,
//! `IfcCosineSpiral`). Isolated in its own crate because building-only
//! consumers should never compile spiral curve laws.
//!
//! # Module map
//!
//! | Module | Role |
//! |---|---|
//! | `horizontal` | Horizontal segments: line, arc, spiral transitions |
//! | `vertical` | Vertical segments: grades and parabolic curves |
//! | `cant` | Superelevation (`IfcAlignmentCant`) for rail |
//! | `referent` | `IfcReferent` stationing and chainage |
//! | `view` | The IFC4X3 profile pin and the `IfcAlignment` hierarchy |
//! | `placement` | `IfcLinearPlacement` and distance expressions |
//! | `error` | Why an alignment operation failed |
//!
//! Horizontal lines, circular arcs and transition spirals lower to exact
//! neutral curve graphs; a spiral is stored as its curvature law
//! (`Curve2::Intrinsic`), never integrated here, and a `CUBIC` as its cubic
//! parabola trimmed by arc length. A whole layout is also one plan curve
//! parameterised by distance along it (an intrinsic curve with a piecewise
//! curvature law, or an arc-length chain when it holds a `CUBIC`), which is
//! what an elevated 3D centreline carries. Vertical circular arcs are the
//! circle itself, and cant makes the centreline a banked curve that rolls
//! the section about its tangent. Families without an exact law are typed
//! refusals, tracked in GitHub issues.

pub mod authoring;
mod cant;
mod curve;
mod error;
mod horizontal;
mod placement;
mod referent;
pub(crate) mod slot;
mod vertical;
mod view;

pub use authoring::{
    alignment, alignment_segment, axis2_placement_linear, cant_layout, cant_segment,
    cartesian_point, horizontal_layout, horizontal_segment, linear_element, linear_placement,
    linear_positioning_element, point_by_distance, referent, stationing, vertical_layout,
    vertical_segment, CantSegmentDraft, HorizontalSegmentDraft, VerticalSegmentDraft,
};
pub use cant::{
    cant_at, read_cant_segment, CantAtStation, CantFrame, CantLayout, CantSegment, CantSegmentType,
};
pub use curve::{
    elevation_law, gradient_curve3, lower_gradient_curve, lower_horizontal_layout,
    lower_horizontal_layout_partial, lower_horizontal_plan, lower_horizontal_segment,
    lower_segmented_reference_curve, lower_vertical_segment, profile_law, profile_law_within,
    segmented_reference_curve3, vertical_profile_law, HorizontalPlan, HorizontalSeam,
    LoweredAlignmentCurve, PartialHorizontalLayout, RefusedSegment, SeamCheck, SeamTolerance,
};
pub use error::{AlignmentError, AlignmentResult, ProfileSeam};
pub use horizontal::{
    read_horizontal_segment, AlignmentUnits, HorizontalSegment, HorizontalSegmentType,
};
pub use placement::{
    resolve_linear_placement, resolve_point_by_distance, CurveMeasure, LinearPlacement,
    PointByDistance,
};
#[allow(deprecated)]
pub use referent::station_equations;
pub use referent::{StationEquation, Stationing, STATION_TOLERANCE};
pub use vertical::{
    read_vertical_segment, VerticalLayout, VerticalSeam, VerticalSeamKind, VerticalSegment,
    VerticalSegmentType,
};
pub use view::{AlignmentHierarchy, AlignmentView};