vizia_input 0.4.0

The input components of vizia
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

use vizia_id::GenerationalId;

/// A mouse button.
#[derive(Debug, Copy, Clone, PartialEq)]
pub enum MouseButton {
    /// The left mouse button.
    Left,
    /// The right mouse button.
    Right,
    /// The middle mouse button.
    Middle,
    /// Another mouse button with the associated button number.
    Other(u16),

    Back,

    Forward,
}

/// The state of a mouse button.
#[derive(Debug, Copy, Clone, PartialEq)]
pub enum MouseButtonState {
    /// Represents a pressed mouse button.
    Pressed,
    /// Represents a released mouse button.
    Released,
}

/// Data which describes the current state of a mouse button.
#[derive(Debug, Copy, Clone, PartialEq)]
pub struct MouseButtonData<I>
where
    I: GenerationalId,
{
    /// The state of the mouse button (pressed/released).
    pub state: MouseButtonState,
    /// The position of the mouse cursor when the mouse button was last pressed.
    pub pos_down: (f32, f32),
    /// The position of the mouse cursor when the mouse button was last released.
    pub pos_up: (f32, f32),
    /// The hovered entity when the mouse button was last pressed.
    pub pressed: I,
    /// The hovered entity when the mouse button was last released.
    pub released: I,
}

impl<I> Default for MouseButtonData<I>
where
    I: GenerationalId,
{
    fn default() -> Self {
        MouseButtonData {
            state: MouseButtonState::Released,
            pos_down: (0.0, 0.0),
            pos_up: (0.0, 0.0),
            pressed: I::null(),
            released: I::null(),
        }
    }
}

/// The current state of the mouse cursor and buttons.
#[derive(Debug, Copy, Clone, PartialEq)]
pub struct MouseState<I>
where
    I: GenerationalId,
{
    /// The horizontal mouse cursor position of the frame.
    pub cursor_x: f32,
    /// The vertical mouse cursor position of the frame.
    pub cursor_y: f32,
    /// The horizontal mouse cursor position of the previous frame.
    pub previous_cursor_x: f32,
    /// The vertical mouse cursor position of the previous frame.
    pub previous_cursor_y: f32,
    /// The state of the left mouse button.
    pub left: MouseButtonData<I>,
    /// The state of the right mouse button.
    pub right: MouseButtonData<I>,
    /// The state of the middle mouse button.
    pub middle: MouseButtonData<I>,
}

impl<I> Default for MouseState<I>
where
    I: GenerationalId,
{
    fn default() -> Self {
        MouseState {
            cursor_x: -1.0,
            cursor_y: -1.0,
            previous_cursor_x: -1.0,
            previous_cursor_y: -1.0,
            left: MouseButtonData::default(),
            right: MouseButtonData::default(),
            middle: MouseButtonData::default(),
        }
    }
}

impl<I> MouseState<I>
where
    I: GenerationalId,
{
    /// Returns the delta of the mouse cursor position of the current and previous frame.
    pub fn delta(&self) -> (f32, f32) {
        (self.cursor_x - self.previous_cursor_x, self.cursor_y - self.previous_cursor_y)
    }

    /// Returns the delta of the mouse cursor position of the current frame and the frame the `button` got pressed.
    pub fn button_delta(&self, button: MouseButton) -> (f32, f32) {
        match button {
            MouseButton::Left => {
                (self.cursor_x - self.left.pos_down.0, self.cursor_y - self.left.pos_down.1)
            }

            MouseButton::Right => {
                (self.cursor_x - self.right.pos_down.0, self.cursor_y - self.right.pos_down.1)
            }

            MouseButton::Middle => {
                (self.cursor_x - self.middle.pos_down.0, self.cursor_y - self.middle.pos_down.1)
            }

            _ => (0.0, 0.0),
        }
    }
}