jiao 0.2.1

Cross platform 2D rendering engine
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

// Copyright (c) 2022 Xu Shaohua <shaohua@biofan.org>. All rights reserved.
// Use of this source is governed by Apache-2.0 License that can be found
// in the LICENSE file.

use crate::base::{PointF, RectF};
use crate::kernel::{PainterTrait, PathTrait};
use crate::platforms::Path;
use crate::shapes::ShapeTrait;
use crate::util::fuzzy_compare;

#[allow(clippy::module_name_repetitions)]
#[derive(Debug)]
pub struct GridShape {
    horizontal_step: f64,
    vertical_step: f64,
    start_point: PointF,
    viewport: RectF,
    horizontal_visible: bool,
    vertical_visible: bool,
    path_is_dirty: bool,
    path: Path,
}

impl GridShape {
    /// Create a new grid shape.
    ///
    /// # Panics
    ///
    /// Both `horizontal_step` and `vertical_step` shall be >= 0.0.
    #[must_use]
    pub fn new(horizontal_step: f64, vertical_step: f64) -> Self {
        assert!(horizontal_step >= 0.0 && vertical_step >= 0.0);
        let start_point = PointF::new();
        let viewport = RectF::from(0.0, 0.0, 100.0, 100.0);
        let path = Path::new();
        Self {
            horizontal_step,
            vertical_step,
            start_point,
            viewport,
            horizontal_visible: true,
            vertical_visible: true,
            path_is_dirty: true,
            path,
        }
    }

    /// Get horizontal step value.
    #[must_use]
    pub const fn horizontal_step(&self) -> f64 {
        self.horizontal_step
    }

    /// Update value of horizontal step.
    ///
    /// # Panics
    ///
    /// `horizontal_step` shall be >= 0.0.
    pub fn set_horizontal_step(&mut self, horizontal_step: f64) {
        assert!(horizontal_step >= 0.0);
        if !fuzzy_compare(self.horizontal_step, horizontal_step) {
            self.horizontal_step = horizontal_step;
            self.path_is_dirty = true;
        }
    }

    /// Check if horizontal step is visible.
    #[must_use]
    pub const fn horizontal_visible(&self) -> bool {
        self.horizontal_visible
    }

    /// Make horizontal step invisible.
    pub fn set_horizontal_visible(&mut self, visible: bool) {
        if self.horizontal_visible != visible {
            self.horizontal_visible = visible;
            self.path_is_dirty = true;
        }
    }

    /// Get vertical step value.
    #[must_use]
    pub const fn vertical_step(&self) -> f64 {
        self.vertical_step
    }

    /// Update value of vertical step.
    ///
    /// # Panics
    ///
    /// `vertical_step` shall be >= 0.0.
    pub fn set_vertical_step(&mut self, vertical_step: f64) {
        assert!(vertical_step >= 0.0);
        if !fuzzy_compare(self.vertical_step, vertical_step) {
            self.vertical_step = vertical_step;
            self.path_is_dirty = true;
        }
    }

    /// Check if vertical step is visible.
    #[must_use]
    pub const fn vertical_visible(&self) -> bool {
        self.vertical_visible
    }

    /// Make vertical step invisible.
    pub fn set_vertical_visible(&mut self, visible: bool) {
        if self.vertical_visible != visible {
            self.vertical_visible = visible;
            self.path_is_dirty = true;
        }
    }

    /// Get start point of grid.
    #[must_use]
    pub const fn start_point(&self) -> PointF {
        self.start_point
    }

    /// Update `start_point` of grid.
    pub fn set_start_point(&mut self, start_point: PointF) {
        self.start_point = start_point;
        self.path_is_dirty = true;
    }

    /// Get current viewport.
    #[must_use]
    pub const fn viewport(&self) -> &RectF {
        &self.viewport
    }

    /// Update viewport of grid.
    pub fn set_viewport(&mut self, viewport: RectF) {
        self.viewport = viewport;
        self.path_is_dirty = true;
    }

    fn update_path(&mut self) {
        if !self.path_is_dirty {
            return;
        }
        self.path.clear();

        self.path_is_dirty = false;
    }
}

impl ShapeTrait for GridShape {
    fn bounding_rect(&self) -> RectF {
        self.viewport.clone()
    }

    fn repaint(&mut self, painter: &mut dyn PainterTrait) {
        self.update_path();
        painter.stroke(&self.path);
    }
}