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 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
//! Small tracked parts of the application state. Includes **window**, **keys**, **mouse**, and
//! **time** - each of which are stored in the **App**.
pub use self::keys::Keys;
pub use self::mouse::Mouse;
pub use self::time::Time;
pub use self::window::Window;
/// Tracked state related to the focused window.
pub mod window {
use crate::geom;
use crate::window;
/// The default scalar value used for window positioning and sizing.
pub type DefaultScalar = geom::scalar::Default;
/// State of the window in focus.
#[derive(Copy, Clone, Debug, PartialEq)]
pub struct Window {
/// ID of the window currently in focus.
pub id: Option<window::Id>,
}
impl Window {
/// Initialise the window state.
pub fn new() -> Self {
Window { id: None }
}
/// Expects that there will be a `window::Id` (the common case) and **panic!**s otherwise.
pub fn id(&self) -> window::Id {
self.id.unwrap()
}
}
}
/// Tracked state related to the keyboard.
pub mod keys {
use crate::event::{Key, ModifiersState};
use std::collections::HashSet;
use std::ops::Deref;
/// The state of the keyboard.
#[derive(Clone, Debug, Default)]
pub struct Keys {
/// The state of the modifier keys as last indicated by winit.
pub mods: ModifiersState,
/// The state of all keys as tracked via the nannou App event handling.
pub down: Down,
}
/// The set of keys that are currently pressed.
#[derive(Clone, Debug, Default)]
pub struct Down {
pub(crate) keys: HashSet<Key>,
}
impl Deref for Down {
type Target = HashSet<Key>;
fn deref(&self) -> &Self::Target {
&self.keys
}
}
}
/// Tracked state related to the mouse.
pub mod mouse {
use crate::geom::Point2;
use crate::window;
use std::collections::HashMap;
#[doc(inline)]
pub use crate::event::MouseButton as Button;
/// The state of the `Mouse` at a single moment in time.
#[derive(Clone, Debug, PartialEq)]
pub struct Mouse {
/// The ID of the last window currently in focus.
pub window: Option<window::Id>,
/// *x* position relative to the middle of `window`.
pub x: f32,
/// *y* position relative to the middle of `window`.
pub y: f32,
/// A map describing the state of each mouse button.
pub buttons: ButtonMap,
}
/// Whether the button is up or down.
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum ButtonPosition {
/// The button is up (i.e. unpressed).
Up,
/// The button is down and was originally pressed down at the given `Point2`.
Down(Point2),
}
/// Stores the state of all mouse buttons.
///
/// If the mouse button is down, it stores the position of the mouse when the button was pressed
#[derive(Clone, Debug, PartialEq)]
pub struct ButtonMap {
buttons: HashMap<Button, ButtonPosition>,
}
impl Mouse {
/// Construct a new default `Mouse`.
pub fn new() -> Self {
Mouse {
window: None,
buttons: ButtonMap::new(),
x: 0.0,
y: 0.0,
}
}
/// The position of the mouse relative to the middle of the window in focus..
pub fn position(&self) -> Point2 {
[self.x, self.y].into()
}
}
impl ButtonPosition {
/// If the mouse button is down, return a new one with position relative to the given `xy`.
pub fn relative_to(self, xy: Point2) -> Self {
match self {
ButtonPosition::Down(pos) => {
let rel_p = pos - xy;
ButtonPosition::Down([rel_p.x, rel_p.y].into())
}
button_pos => button_pos,
}
}
/// Is the `ButtonPosition` down.
pub fn is_down(&self) -> bool {
match *self {
ButtonPosition::Down(_) => true,
_ => false,
}
}
/// Is the `ButtonPosition` up.
pub fn is_up(&self) -> bool {
match *self {
ButtonPosition::Up => true,
_ => false,
}
}
/// Returns the position at which the button was pressed.
pub fn if_down(&self) -> Option<Point2> {
match *self {
ButtonPosition::Down(xy) => Some(xy),
_ => None,
}
}
}
impl ButtonMap {
/// Returns a new button map with all buttons unpressed
pub fn new() -> Self {
ButtonMap {
buttons: HashMap::with_capacity(5),
}
}
/// Returns a copy of the ButtonMap relative to the given `Point2`
pub fn relative_to(self, xy: Point2) -> Self {
Self {
buttons: self
.buttons
.iter()
.map(|(&button, &point)| (button, point.relative_to(xy)))
.collect(),
}
}
/// The state of the left mouse button.
pub fn left(&self) -> &ButtonPosition {
&self[Button::Left]
}
/// The state of the middle mouse button.
pub fn middle(&self) -> &ButtonPosition {
&self[Button::Middle]
}
/// The state of the right mouse button.
pub fn right(&self) -> &ButtonPosition {
&self[Button::Right]
}
/// Sets the `Button` in the `Down` position.
pub fn press(&mut self, button: Button, xy: Point2) {
self[button] = ButtonPosition::Down(xy);
}
/// Set's the `Button` in the `Up` position.
pub fn release(&mut self, button: Button) {
self[button] = ButtonPosition::Up;
}
/// An iterator yielding all pressed mouse buttons along with the location at which they
/// were originally pressed.
pub fn pressed<'a>(&'a self) -> impl Iterator<Item = (Button, Point2)> + 'a {
self.buttons
.iter()
.filter_map(|(&button, &point)| point.if_down().map(|point| (button, point)))
}
}
impl std::ops::Index<Button> for ButtonMap {
type Output = ButtonPosition;
fn index(&self, button: Button) -> &Self::Output {
self.buttons.get(&button).unwrap_or(&ButtonPosition::Up)
}
}
impl std::ops::IndexMut<Button> for ButtonMap {
fn index_mut(&mut self, button: Button) -> &mut Self::Output {
self.buttons.entry(button).or_insert(ButtonPosition::Up)
}
}
}
/// Tracked durations related to the App.
pub mod time {
/// The state of time tracked by the App.
#[derive(Copy, Clone, Debug, Default, Eq, PartialEq, Hash)]
pub struct Time {
/// The duration since the app started running.
pub since_start: std::time::Duration,
/// The duration since the previous update.
pub since_prev_update: std::time::Duration,
}
impl Time {
/// The number of updates per second if `since_prev_update` were to remain constant
pub fn updates_per_second(&self) -> f32 {
if self.since_prev_update.as_secs() > 0 {
return 0.0;
}
let millis = self.since_prev_update.subsec_millis() as f32;
if millis == 0.0 {
return std::f32::MAX;
}
1000.0 / millis
}
}
}