haussmann 0.0.3

Integrate highly customisable widgets and themes for any Rust application or GUI library
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

// This file is part of "haussmann"
// Under the MIT License
// Copyright (c) 2023 Antonin Hérault

//! Shapes into what the widgets are converted and tools to create shapes.

use super::colours::RGBA;
use super::Point;
use crate::{Border, Radius};

mod builder;

pub use builder::Builder;

/// [`Widget`s](crate::Widget) are transformed into shapes to draw them on a
/// surface. To create a shape, use [`shapes::Builder`](Builder).
///
/// There is the same number of `points` than `borders`. The shape cannot be set
/// as `filled` without a fill colour.
///
/// Thanks to shapes builder, it's surely a safe structure, there cannot be any
/// illogical problem.
#[derive(Debug, Clone, PartialEq)]
pub struct Shape {
    /// The points of the shape.
    ///
    /// The first point is the top left point. It is also relative to the layout
    /// where the shape is, it is not a fixed point.
    points: Vec<Point>,
    /// Borders for each side of the shape. An empty `borders` vector is used to
    /// define no borders.
    borders: Vec<Border>,
    /// The first value is whether the shape is filled, and the second value is
    /// the fill colour if the shape is filled.
    ///
    /// If the shape is designed to be filled, the second value must be not
    /// `None`.
    filled: (bool, Option<RGBA>),
    /// The radius of the shape, in degrees.
    radius: Radius,
}

impl Shape {
    /// Moves all the points by `position`.
    pub fn move_by(&mut self, position: Point) {
        for point in &mut self.points {
            *point = [position[0] + point[0], position[1] + point[1]];
        }
    }

    /// Returns the shape's points.
    pub fn points(&self) -> &Vec<Point> {
        &self.points
    }

    /// Returns the first point of the shape being its position.
    pub fn position(&self) -> &Point {
        &self.points[0]
    }

    /// Returns the shape's borders if they exist, otherwise returns `None`.
    pub fn borders(&self) -> Option<&Vec<Border>> {
        if self.borders.is_empty() {
            None
        } else {
            Some(&self.borders)
        }
    }

    /// Whether the shape is filled or not.
    pub fn is_filled(&self) -> bool {
        self.filled.0
    }

    /// Returns the fill colour when exists, otherwise returns `None`. But, also
    /// returns `None` if the shape is specified to not be filled, no matter if
    /// the fill colour exists or not.
    pub fn fill_colour(&self) -> Option<RGBA> {
        if !self.is_filled() {
            // The shape is not filled, there is no fill colour or we don't care
            // about it.
            None
        } else {
            // Returns the fill colour
            self.filled.1
        }
    }

    /// Returns the radius for the shape's corners.
    pub fn radius(&self) -> Radius {
        self.radius
    }
}