kcl-ezpz 0.2.18

A constraint solver for KCL and Zoo Design Studio
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

use crate::datatypes::{
    AngleKind,
    inputs::{DatumCircle, DatumCircularArc, DatumLineSegment, DatumPoint},
};

use super::Constraint;

impl Constraint {
    /// Constrain these lines to be parallel.
    pub fn lines_parallel([l0, l1]: [DatumLineSegment; 2]) -> Self {
        // TODO: Check if all points are unique.
        // Our math can't handle a common point just yet.
        Self::LinesAtAngle(l0, l1, AngleKind::Parallel)
    }

    /// Constrain these lines to be perpendicular.
    pub fn lines_perpendicular([l0, l1]: [DatumLineSegment; 2]) -> Self {
        Self::LinesAtAngle(l0, l1, AngleKind::Perpendicular)
    }

    /// Constrains this point to bisect this arc.
    pub fn point_bisects_arc(arc: DatumCircularArc, point: DatumPoint) -> [Self; 2] {
        // To make a point bisect an arc, just:
        // - ensure the point is on the arc, with PointArcCoincident
        // - draw a line from the arc's center to that point, and
        //   make sure the arc's start and end points are symmetric
        //   across that line.
        let center_to_point = DatumLineSegment {
            p0: arc.center,
            p1: point,
        };
        [
            Constraint::PointArcCoincident(arc, point),
            Constraint::Symmetric(center_to_point, arc.start, arc.end),
        ]
    }

    /// Constrains these two lines to be parallel, and to have the given perpendicular distance.
    pub fn parallel_lines_distance(lines: [DatumLineSegment; 2], distance: f64) -> [Self; 2] {
        [
            Constraint::lines_parallel(lines),
            Constraint::PointLineDistance(lines[0].p0, lines[1], distance),
        ]
    }

    /// Constraints a circle and a circular arc to have the same center and radius.
    pub fn circle_arc_coincident(circle: DatumCircle, arc: DatumCircularArc) -> [Self; 2] {
        [
            Constraint::PointsCoincident(circle.center, arc.center),
            Constraint::LinesEqualLength(
                DatumLineSegment {
                    p0: arc.center,
                    p1: arc.start,
                },
                DatumLineSegment {
                    p0: arc.center,
                    p1: arc.end,
                },
            ),
        ]
    }
}