standard-plugin-sdk 0.1.1

Write Standard Code plugins in Rust: wasm components against standard:plugin@2.0.0
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

//! Surface sizes and rectangles.

/// The size a surface currently has. `cols`/`rows` are cells; `px_w`/`px_h`
/// the pixel size of the graphics model (zero while the viewer has no pixel
/// geometry); `cell_px_w`/`cell_px_h` the pixel size of one cell.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct Geometry {
    pub cols: u32,
    pub rows: u32,
    pub px_w: u32,
    pub px_h: u32,
    pub cell_px_w: u32,
    pub cell_px_h: u32,
}

impl Geometry {
    /// `cols` by `rows` cells of `cell_px` pixels (`(0, 0)`: no pixels).
    pub const fn cells(cols: u32, rows: u32, cell_px: (u32, u32)) -> Self {
        Self {
            cols,
            rows,
            px_w: cols * cell_px.0,
            px_h: rows * cell_px.1,
            cell_px_w: cell_px.0,
            cell_px_h: cell_px.1,
        }
    }

    pub const fn is_empty(&self) -> bool {
        self.cols == 0 || self.rows == 0
    }
}

/// A rectangle in cells (cell model) or pixels (graphics model).
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct Rect {
    pub x: u32,
    pub y: u32,
    pub w: u32,
    pub h: u32,
}

impl Rect {
    pub const fn new(x: u32, y: u32, w: u32, h: u32) -> Self {
        Self { x, y, w, h }
    }

    pub const fn is_empty(&self) -> bool {
        self.w == 0 || self.h == 0
    }

    pub const fn right(&self) -> u32 {
        self.x.saturating_add(self.w)
    }

    pub const fn bottom(&self) -> u32 {
        self.y.saturating_add(self.h)
    }

    pub const fn area(&self) -> u64 {
        self.w as u64 * self.h as u64
    }

    /// The part inside a `width` by `height` surface, or `None`.
    pub fn clamp(self, width: u32, height: u32) -> Option<Self> {
        let right = self.right().min(width);
        let bottom = self.bottom().min(height);
        (self.x < right && self.y < bottom).then(|| Self {
            x: self.x,
            y: self.y,
            w: right - self.x,
            h: bottom - self.y,
        })
    }

    pub fn contains_rect(&self, other: &Self) -> bool {
        other.x >= self.x
            && other.y >= self.y
            && other.right() <= self.right()
            && other.bottom() <= self.bottom()
    }

    /// The smallest rectangle covering both.
    pub fn union(&self, other: &Self) -> Self {
        let x = self.x.min(other.x);
        let y = self.y.min(other.y);
        Self {
            x,
            y,
            w: self.right().max(other.right()) - x,
            h: self.bottom().max(other.bottom()) - y,
        }
    }
}