gpui_component/plot/shape/
arc.rs

1// @reference: https://d3js.org/d3-shape/arc
2
3use std::{f32::consts::PI, fmt::Debug};
4
5use gpui::{point, px, Bounds, Hsla, Path, PathBuilder, Pixels, Point, Window};
6
7use crate::PixelsExt;
8
9const EPSILON: f32 = 1e-12;
10const HALF_PI: f32 = PI / 2.;
11
12pub struct ArcData<'a, T> {
13    pub data: &'a T,
14    pub index: usize,
15    pub value: f32,
16    pub start_angle: f32,
17    pub end_angle: f32,
18    pub pad_angle: f32,
19}
20
21impl<T> Debug for ArcData<'_, T> {
22    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
23        write!(
24            f,
25            "ArcData {{ index: {}, value: {}, start_angle: {}, end_angle: {}, pad_angle: {} }}",
26            self.index, self.value, self.start_angle, self.end_angle, self.pad_angle
27        )
28    }
29}
30
31pub struct Arc {
32    inner_radius: f32,
33    outer_radius: f32,
34}
35
36impl Default for Arc {
37    fn default() -> Self {
38        Self {
39            inner_radius: 0.,
40            outer_radius: 0.,
41        }
42    }
43}
44
45impl Arc {
46    pub fn new() -> Self {
47        Self::default()
48    }
49
50    /// Set the inner radius of the Arc.
51    pub fn inner_radius(mut self, inner_radius: f32) -> Self {
52        self.inner_radius = inner_radius;
53        self
54    }
55
56    /// Set the outer radius of the Arc.
57    pub fn outer_radius(mut self, outer_radius: f32) -> Self {
58        self.outer_radius = outer_radius;
59        self
60    }
61
62    /// Get the centroid of the Arc.
63    pub fn centroid<T>(&self, arc: &ArcData<T>) -> Point<f32> {
64        let start_angle = arc.start_angle - HALF_PI;
65        let end_angle = arc.end_angle - HALF_PI;
66        let r = (self.inner_radius + self.outer_radius) / 2.;
67        let a = (start_angle + end_angle) / 2.;
68
69        point(r * a.cos(), r * a.sin())
70    }
71
72    fn path<T>(
73        &self,
74        arc: &ArcData<T>,
75        inner_radius: Option<f32>,
76        outer_radius: Option<f32>,
77        bounds: &Bounds<Pixels>,
78    ) -> Option<Path<Pixels>> {
79        let start_angle = arc.start_angle - HALF_PI;
80        let end_angle = arc.end_angle - HALF_PI;
81        let da = end_angle - start_angle;
82        let pad_angle = if da >= PI {
83            // Leave some pad angle for full circle.
84            // If not, the path start and end will be the same point.
85            0.0001
86        } else {
87            arc.pad_angle
88        };
89        let r0 = inner_radius.unwrap_or(self.inner_radius).max(0.);
90        let r1 = outer_radius.unwrap_or(self.outer_radius).max(0.);
91
92        // Calculate the center point.
93        let center_x = bounds.origin.x.as_f32() + bounds.size.width.as_f32() / 2.;
94        let center_y = bounds.origin.y.as_f32() + bounds.size.height.as_f32() / 2.;
95
96        // Angle difference.
97        if r1 < EPSILON || da.abs() < EPSILON {
98            return None;
99        }
100
101        // Handle pad angle.
102        let (a0_outer, a1_outer, a0_inner, a1_inner) = if r0 > EPSILON && pad_angle > 0.0 {
103            let pad_width = r1 * pad_angle;
104            let pad_angle_outer = pad_width / r1;
105            let mut pad_angle_inner = pad_width / r0;
106            let max_inner_pad = da * 0.8;
107            if pad_angle_inner > max_inner_pad {
108                pad_angle_inner = max_inner_pad;
109            }
110            (
111                start_angle + pad_angle_outer * 0.5,
112                end_angle - pad_angle_outer * 0.5,
113                start_angle + pad_angle_inner * 0.5,
114                end_angle - pad_angle_inner * 0.5,
115            )
116        } else {
117            let pad = pad_angle * 0.5;
118            (
119                start_angle + pad,
120                end_angle - pad,
121                start_angle + pad,
122                end_angle - pad,
123            )
124        };
125
126        let da_outer = a1_outer - a0_outer;
127        if da_outer <= 0. {
128            return None;
129        }
130
131        // Calculate the start and end points of the outer arc.
132        let x01 = center_x + r1 * a0_outer.cos();
133        let y01 = center_y + r1 * a0_outer.sin();
134        let x11 = center_x + r1 * a1_outer.cos();
135        let y11 = center_y + r1 * a1_outer.sin();
136
137        let mut builder = PathBuilder::fill();
138
139        // Move to the start point of the outer arc.
140        builder.move_to(point(px(x01), px(y01)));
141
142        // Draw the outer arc.
143        let large_arc = (a1_outer - a0_outer).abs() > PI;
144        builder.arc_to(
145            point(px(r1), px(r1)),
146            px(0.),
147            large_arc,
148            true,
149            point(px(x11), px(y11)),
150        );
151
152        if r0 > EPSILON {
153            // End point of the inner arc.
154            let x10 = center_x + r0 * a1_inner.cos();
155            let y10 = center_y + r0 * a1_inner.sin();
156            builder.line_to(point(px(x10), px(y10)));
157
158            // Draw the inner arc.
159            let x00 = center_x + r0 * a0_inner.cos();
160            let y00 = center_y + r0 * a0_inner.sin();
161            let large_arc_inner = (a1_inner - a0_inner).abs() > PI;
162            builder.arc_to(
163                point(px(r0), px(r0)),
164                px(0.),
165                large_arc_inner,
166                false,
167                point(px(x00), px(y00)),
168            );
169        } else {
170            // If there is no inner radius, draw a line to the center.
171            builder.line_to(point(px(center_x), px(center_y)));
172        }
173
174        builder.build().ok()
175    }
176
177    /// Paint the Arc.
178    pub fn paint<T>(
179        &self,
180        arc: &ArcData<T>,
181        color: impl Into<Hsla>,
182        inner_radius: Option<f32>,
183        outer_radius: Option<f32>,
184        bounds: &Bounds<Pixels>,
185        window: &mut Window,
186    ) {
187        let path = self.path(arc, inner_radius, outer_radius, bounds);
188        if let Some(path) = path {
189            window.paint_path(path, color.into());
190        }
191    }
192}
193
194#[cfg(test)]
195mod tests {
196    use super::*;
197
198    #[test]
199    fn test_arc_default() {
200        let arc = Arc::default();
201        assert_eq!(arc.inner_radius, 0.);
202        assert_eq!(arc.outer_radius, 0.);
203    }
204
205    #[test]
206    fn test_arc_builder() {
207        let arc = Arc::new().inner_radius(10.).outer_radius(20.);
208
209        assert_eq!(arc.inner_radius, 10.);
210        assert_eq!(arc.outer_radius, 20.);
211    }
212
213    #[test]
214    fn test_arc_centroid() {
215        let arc = Arc::new().inner_radius(10.).outer_radius(20.);
216
217        let arc_data = ArcData {
218            data: &(),
219            index: 0,
220            value: 1.,
221            start_angle: 0.,
222            end_angle: PI,
223            pad_angle: 0.,
224        };
225
226        let centroid = arc.centroid(&arc_data);
227        let expected_radius = (10. + 20.) / 2.;
228        let expected_angle = (0. + PI - 2. * HALF_PI) / 2.;
229
230        assert_eq!(centroid.x, expected_radius * expected_angle.cos());
231        assert_eq!(centroid.y, expected_radius * expected_angle.sin());
232    }
233}