scadman 0.2.1

Code generator for OpenSCAD.
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

//! Types used to represent values in the library.

use derive_more::derive::From;
use nalgebra as na;

use crate::{common::Unit, scad_display::ScadDisplay};

/// Vector representing an RGB color.
pub type RGB = na::Vector3<Unit>;
/// Vector representing an RGBA color.
pub type RGBA = na::Vector4<Unit>;

#[derive(Copy, Clone, Debug, PartialEq)]
/// Angle type for SCAD
pub enum Angle {
    /// Angle in degrees
    Deg(Unit),
    /// Angle in radians
    Rad(Unit),
}

impl Angle {
    /// Returns the angle in degrees
    ///
    /// # Returns
    ///
    /// The angle in degrees
    ///
    /// # Examples
    ///
    /// ```
    /// use scadman::{prelude::Unit, value_type::Angle};
    /// let d = Angle::Deg(90.0 as Unit);
    /// assert!((d.deg() - 90.0).abs() < 1e5);
    /// let r = Angle::Rad(std::f64::consts::PI as Unit / 2.);
    /// assert!((d.deg() - 90.0).abs() < 1e5);
    /// ```
    pub const fn deg(&self) -> Unit {
        match *self {
            Self::Deg(d) => d,
            Self::Rad(r) => r.to_degrees(),
        }
    }
}

impl ScadDisplay for Angle {
    fn repr_scad(&self) -> String {
        self.deg().repr_scad()
    }
}

#[derive(Clone, Debug, PartialEq, From)]

/// Color type for SCAD
pub enum ScadColor {
    /// Color in RGB format
    RGB(RGB),
    /// Color in RGBA format
    RGBA(RGBA),
    /// Named color
    Name(String),
}

impl ScadDisplay for RGBA {
    fn repr_scad(&self) -> String {
        format!(
            "[{}, {}, {}, {}]",
            self[0].repr_scad(),
            self[1].repr_scad(),
            self[2].repr_scad(),
            self[3].repr_scad()
        )
    }
}

impl ScadColor {
    /// Returns the name of the key in SCAD code
    ///
    /// # Returns
    ///
    /// The name of the key in SCAD code
    pub const fn name(&self) -> &'static str {
        match *self {
            Self::Name(_) => "",
            _ => "c",
        }
    }
}

#[derive(Copy, Clone, Debug, PartialEq)]

/// Size of rounded shape type for SCAD
pub enum RoundSize {
    /// Radius of rounded shape
    Radius(Unit),
    /// Diameter of rounded shape
    Diameter(Unit),
}

impl RoundSize {
    /// Returns the name of the key in SCAD code
    ///
    /// # Returns
    ///
    /// The name of the key in SCAD code
    pub const fn name(&self) -> &'static str {
        match *self {
            Self::Radius(_) => "r",
            Self::Diameter(_) => "d",
        }
    }
}

impl ScadDisplay for RoundSize {
    fn repr_scad(&self) -> String {
        match self {
            Self::Radius(r) => r.repr_scad(),
            Self::Diameter(d) => d.repr_scad(),
        }
    }
}

impl ScadDisplay for ScadColor {
    fn repr_scad(&self) -> String {
        match self {
            Self::RGB(rgb) => rgb.repr_scad(),
            Self::RGBA(rgba) => rgba.repr_scad(),
            Self::Name(name) => format!("\"{name}\""), // Named colors are strings in OpenSCAD
        }
    }
}