axiolid-profile 0.3.1

Exact 2D profile representations for sweeps and sectioned solids
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

#![forbid(unsafe_code)]

//! Exact two-dimensional section profiles.
//!
//! The crate stores profile intent. Boolean cleanup and triangulation are
//! algorithms in higher tiers so a consumer can use profile data without them.

pub mod center_line;
pub mod contour;
pub mod parameterized;
pub mod validate;

use axiolid_core::Transform2;

pub use center_line::CenterLineProfile;
pub use contour::{Contour, ContourProfile, ProfileSegment};
pub use parameterized::{CircleProfile, EllipseProfile, RectangleProfile, SectionProfile};
pub use validate::ValidateProfile;

/// Format-neutral profile representation.
#[non_exhaustive]
#[derive(Debug, Clone, PartialEq)]
pub enum Profile {
    /// Rectangle or rounded rectangle.
    Rectangle(RectangleProfile),
    /// Circle or annulus.
    Circle(CircleProfile),
    /// Ellipse.
    Ellipse(EllipseProfile),
    /// Structural parameterized section.
    Section(SectionProfile),
    /// Arbitrary exact contour with holes.
    Contour(ContourProfile),
    /// Profile transformed from another profile.
    ///
    /// Placement is recorded as a transform over the exact basis, not by
    /// transforming tessellated points, so a placed circle stays a circle.
    Derived {
        /// Base profile.
        basis: Box<Profile>,
        /// Two-dimensional transform.
        transform: Transform2,
    },
    /// Ordered collection of profiles used as one section.
    Composite(Vec<Profile>),
    /// Open path plus a constant width, centred on the path.
    ///
    /// Distinct from [`Profile::Contour`] because the area is *implied* by an
    /// offset rather than bounded explicitly. A consumer that cannot offset
    /// must refuse this rather than treat the path as a boundary: the path is
    /// open, so reading it as a contour yields a degenerate zero-area region.
    CenterLine(CenterLineProfile),
}