cpux 0.2.0

Retained-mode GUI Framework
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

//! A simple text label widget for displaying text on the screen.

use crate::widget::Widget;
use image::Rgba;
use image::RgbaImage;
use rusttype::{Font, Scale};
use std::any::Any;

/// A simple text label widget
/// 
/// Example:
/// ```no_run
/// use cpux::text::Text;
/// let text = Text::new("Count: 0", font.clone());
/// ```
pub struct Text {
    /// The unique identifier used to find and update this label.
    pub id: Option<String>,
    /// The string text to display on the screen.
    pub content: String,
    /// Absolute (X, Y) rendering position.
    pub position: (i32, i32),
    /// Foreground text color (defaults to solid black).
    pub color: Rgba<u8>,
    /// The font size/scale metrics.
    pub scale: Scale,
    /// The TrueType font used to render text glyphs.
    pub font: Font<'static>,
}

impl Text {
    /// Creates a new text widget with a default size of 24.0.
    /// 
    /// Example:
    /// ```no_run
    /// use cpux::text::Text;
    /// let text = Text::new("Count: 0", font.clone());
    /// ```
    /// 
    /// You can override the default size by using `Text::with_size()`.
    /// ```no_run
    /// use cpux::text::Text;
    /// let text = Text::new("Count: 0", font.clone())
    ///     .with_size(32.0)
    /// ```
    /// 
    /// The text widget can also be assigned an ID, which allows it to be found and updated later.
    /// ```no_run
    /// use cpux::text::Text;
    /// let text = Text::new("Count: 0", font.clone())
    ///     .with_size(32.0)
    ///     .with_id("counter_text");
    /// ```
    pub fn new(content: impl Into<String>, font: Font<'static>) -> Self {
        Self {
            id: None,
            content: content.into(),
            position: (0, 0),
            color: Rgba([0, 0, 0, 255]),
            scale: Scale { x: 24.0, y: 24.0 },
            font,
        }
    }

    /// Assigns an ID to the text widget, which can be used for updating it.
    /// ```no_run
    /// use cpux::text::Text;
    /// let text = Text::new("Count: 0", font.clone())
    ///     .with_id("counter_text");
    /// ```
    pub fn with_id(mut self, id: impl Into<String>) -> Self {
        self.id = Some(id.into());
        self
    }

    /// Overrides the text default size of 24.0
    /// ```no_run
    /// use cpux::text::Text;
    /// let text = Text::new("Count: 0", font.clone())
    ///     .with_size(32.0)
    /// ```
    pub fn with_size(mut self, size: f32) -> Self {
        self.scale = Scale { x: size, y: size };
        self
    }
}

// Internal methods
impl Widget for Text {
    fn set_position(&mut self, x: i32, y: i32) {
        self.position = (x, y);
    }

    fn draw(&mut self, framebuffer: &mut RgbaImage) {
        imageproc::drawing::draw_text_mut(
            framebuffer,
            self.color,
            self.position.0,
            self.position.1,
            self.scale,
            &self.font,
            &self.content,
        );
    }

    fn size(&self) -> (i32, i32) {
        // Approximate width sizing using text length multiplied by average char radius
        ((self.content.len() as i32 * (self.scale.x * 0.5) as i32), self.scale.y as i32)
    }

    fn id(&self) -> Option<&str> {
        self.id.as_deref()
    }

    fn as_any_mut(&mut self) -> &mut dyn Any {
        self
    }
}