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 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
use winit::dpi::PhysicalSize;
use winit::event::{DeviceEvent, Event, WindowEvent};
use winit::keyboard::{Key, KeyCode, PhysicalKey};
use crate::current_input::{CurrentInput, KeyAction, MouseAction, ScanCodeAction, TextChar};
use std::{path::PathBuf, time::Duration};
use web_time::Instant;
/// The main struct of the API.
///
/// Create with `WinitInputHelper::new`.
/// Call `WinitInputHelper::update` for every `winit::event::Event` you receive from winit.
/// `WinitInputHelper::update` returning true indicates a step has occured.
/// You should now run your application logic, calling any of the accessor methods you need.
///
/// An alternative API is provided via `WinitInputHelper::step_with_window_events`,
/// call this method instead of `WinitInputHelper::update` if you need to manually control when a new step begins.
/// A step occurs every time this method is called.
///
/// Do not mix usages of `WinitInputHelper::update` and `WinitInputHelper::step_with_window_events`.
/// You should stick to one or the other.
#[derive(Clone)]
pub struct WinitInputHelper {
current: Option<CurrentInput>,
dropped_file: Option<PathBuf>,
window_resized: Option<PhysicalSize<u32>>,
window_size: Option<(u32, u32)>,
scale_factor_changed: Option<f64>,
scale_factor: Option<f64>,
destroyed: bool,
close_requested: bool,
step_start: Option<Instant>,
step_duration: Option<Duration>,
}
impl Default for WinitInputHelper {
fn default() -> Self {
Self::new()
}
}
impl WinitInputHelper {
pub fn new() -> WinitInputHelper {
WinitInputHelper {
current: Some(CurrentInput::new()),
dropped_file: None,
window_resized: None,
window_size: None,
scale_factor_changed: None,
scale_factor: None,
destroyed: false,
close_requested: false,
step_start: None,
step_duration: None,
}
}
/// Pass every winit event to this function and run your application logic when it returns true.
///
/// The following winit events are handled:
/// * `Event::NewEvents` clears all internal state.
/// * `Event::MainEventsCleared` causes this function to return true, signifying a "step" has completed.
/// * `Event::WindowEvent` updates internal state, this will affect the result of accessor methods immediately.
/// * `Event::DeviceEvent` updates value of `mouse_diff()`
pub fn update<T>(&mut self, event: &Event<T>) -> bool {
match &event {
Event::NewEvents(_) => {
self.step();
false
}
Event::WindowEvent { event, .. } => {
self.process_window_event(event);
false
}
Event::DeviceEvent { event, .. } => {
self.process_device_event(event);
false
}
Event::AboutToWait => {
self.end_step();
true
}
_ => false,
}
}
/// Pass a slice containing every winit event that occured within the step to this function.
/// Ensure this method is only called once per application main loop.
/// Ensure every event since the last `WinitInputHelper::step_with_window_events` call is included in the `events` argument.
///
/// `WinitInputHelper::Update` is easier to use.
/// But this method is useful when your application logic steps dont line up with winit's event loop.
/// e.g. you have a seperate thread for application logic using WinitInputHelper that constantly
/// runs regardless of winit's event loop and you need to send events to it directly.
pub fn step_with_window_events(&mut self, events: &[WindowEvent]) {
self.step();
for event in events {
self.process_window_event(event);
}
self.end_step();
}
fn step(&mut self) {
self.dropped_file = None;
self.window_resized = None;
self.scale_factor_changed = None;
self.close_requested = false;
// Set the start time on the first event to avoid the first step appearing too long
self.step_start.get_or_insert(Instant::now());
self.step_duration = None;
if let Some(current) = &mut self.current {
current.step();
}
}
fn process_window_event(&mut self, event: &WindowEvent) {
match event {
WindowEvent::CloseRequested => self.close_requested = true,
WindowEvent::Destroyed => self.destroyed = true,
WindowEvent::Focused(false) => self.current = None,
WindowEvent::Focused(true) => {
if self.current.is_none() {
self.current = Some(CurrentInput::new())
}
}
WindowEvent::DroppedFile(path) => self.dropped_file = Some(path.clone()),
WindowEvent::Resized(size) => {
self.window_resized = Some(*size);
self.window_size = Some((*size).into());
}
WindowEvent::ScaleFactorChanged { scale_factor, .. } => {
self.scale_factor_changed = Some(*scale_factor);
self.scale_factor = Some(*scale_factor);
}
_ => {}
}
if let Some(current) = &mut self.current {
current.handle_event(event);
}
}
fn process_device_event(&mut self, event: &DeviceEvent) {
if let Some(ref mut current) = self.current {
current.handle_device_event(event);
}
}
fn end_step(&mut self) {
self.step_duration = self.step_start.map(|start| start.elapsed());
self.step_start = Some(Instant::now());
}
/// Returns true when the key with the specified keycode goes from "not pressed" to "pressed".
/// Otherwise returns false.
///
/// Uses physical keys in the US layout, so for example the `W` key will be in the same physical key on both US and french keyboards.
///
/// This is suitable for game controls.
pub fn key_pressed(&self, keycode: KeyCode) -> bool {
let key = PhysicalKey::Code(keycode);
if let Some(current) = &self.current {
let searched_action = ScanCodeAction::Pressed(key);
if current.scancode_actions.contains(&searched_action) {
return true;
}
}
false
}
/// Returns true when the key with the specified keycode goes from "not pressed" to "pressed".
/// Otherwise returns false.
///
/// Uses physical keys in the US layout, so for example the `W` key will be in the same physical key on both US and french keyboards.
///
/// Will repeat key presses while held down according to the OS's key repeat configuration
/// This is suitable for UI.
pub fn key_pressed_os(&self, keycode: KeyCode) -> bool {
let key = PhysicalKey::Code(keycode);
if let Some(current) = &self.current {
let searched_action = ScanCodeAction::PressedOs(key);
if current.scancode_actions.contains(&searched_action) {
return true;
}
}
false
}
/// Returns true when the key with the specified KeyCode goes from "pressed" to "not pressed".
/// Otherwise returns false.
///
/// Uses physical keys in the US layout, so for example the `W` key will be in the same physical key on both US and french keyboards.
pub fn key_released(&self, keycode: KeyCode) -> bool {
let key = PhysicalKey::Code(keycode);
if let Some(current) = &self.current {
let searched_action = ScanCodeAction::Released(key);
if current.scancode_actions.contains(&searched_action) {
return true;
}
}
false
}
/// Returns true when the key with the specified keycode remains "pressed".
/// Otherwise returns false.
///
/// Uses physical keys in the US layout, so for example the `W` key will be in the same physical key on both US and french keyboards.
pub fn key_held(&self, keycode: KeyCode) -> bool {
let key = PhysicalKey::Code(keycode);
if let Some(current) = &self.current {
return current.scancode_held.contains(&key);
}
false
}
/// Returns true while any shift key is held on the keyboard.
/// Otherwise returns false.
///
/// Uses physical keys.
pub fn held_shift(&self) -> bool {
self.key_held(KeyCode::ShiftLeft) || self.key_held(KeyCode::ShiftRight)
}
/// Returns true while any control key is held on the keyboard.
/// Otherwise returns false.
///
/// Uses physical keys.
pub fn held_control(&self) -> bool {
self.key_held(KeyCode::ControlLeft) || self.key_held(KeyCode::ControlRight)
}
/// Returns true while any alt key is held on the keyboard.
/// Otherwise returns false.
///
/// Uses physical keys.
pub fn held_alt(&self) -> bool {
self.key_held(KeyCode::AltLeft) || self.key_held(KeyCode::AltRight)
}
/// Returns true when the specified keyboard key goes from "not pressed" to "pressed".
/// Otherwise returns false.
///
/// Uses logical keypresses, so for example `W` is changed between a US and french keyboard.
/// Will never repeat keypresses while held.
pub fn key_pressed_logical(&self, check_key: Key<&str>) -> bool {
if let Some(current) = &self.current {
for action in ¤t.key_actions {
if let KeyAction::Pressed(key) = action {
if key.as_ref() == check_key {
return true;
}
}
}
}
false
}
/// Returns true when the specified keyboard key goes from "not pressed" to "pressed".
/// Otherwise returns false.
///
/// Uses logical keypresses, so for example `W` is changed between a US and french keyboard.
///
/// Will repeat key presses while held down according to the OS's key repeat configuration
/// This is suitable for UI.
pub fn key_pressed_os_logical(&self, check_key: Key<&str>) -> bool {
if let Some(current) = &self.current {
for action in ¤t.key_actions {
if let KeyAction::PressedOs(key_code) = action {
if key_code.as_ref() == check_key {
return true;
}
}
}
}
false
}
/// Returns true when the specified keyboard key goes from "pressed" to "not pressed".
/// Otherwise returns false.
///
/// Uses logical keypresses, so for example `W` is changed between a US and french keyboard.
pub fn key_released_logical(&self, check_key: Key<&str>) -> bool {
if let Some(current) = &self.current {
for action in ¤t.key_actions {
if let KeyAction::Released(key_code) = action {
if key_code.as_ref() == check_key {
return true;
}
}
}
}
false
}
/// Returns true while the specified keyboard key remains "pressed".
/// Otherwise returns false.
///
/// Uses logical keypresses, so for example `W` is changed between a US and french keyboard.
pub fn key_held_logical(&self, check_key: Key<&str>) -> bool {
match &self.current {
Some(current) => current.key_held.iter().any(|x| x.as_ref() == check_key),
None => false,
}
}
/// Returns true when the specified mouse button goes from "not pressed" to "pressed".
/// Otherwise returns false.
///
/// Left => 0
/// Right => 1
/// Middle => 2
/// Other => 3..255
pub fn mouse_pressed(&self, check_mouse_button: usize) -> bool {
// TODO: Take MouseButton instead of usize
if let Some(current) = &self.current {
for action in ¤t.mouse_actions {
if let MouseAction::Pressed(key_code) = *action {
if key_code == check_mouse_button {
return true;
}
}
}
}
false
}
/// Returns true when the specified mouse button goes from "pressed" to "not pressed".
/// Otherwise returns false.
///
/// Left => 0
/// Right => 1
/// Middle => 2
/// Other => 3..255
pub fn mouse_released(&self, check_mouse_button: usize) -> bool {
// TODO: Take MouseButton instead of usize
if let Some(current) = &self.current {
for action in ¤t.mouse_actions {
if let MouseAction::Released(key_code) = *action {
if key_code == check_mouse_button {
return true;
}
}
}
}
false
}
/// Returns true while the specified mouse button remains "pressed".
/// Otherwise returns false.
///
/// Left => 0
/// Right => 1
/// Middle => 2
/// Other => 3..255
pub fn mouse_held(&self, mouse_button: usize) -> bool {
// TODO: Take MouseButton instead of usize
match &self.current {
Some(current) => current.mouse_held[mouse_button],
None => false,
}
}
/// Returns `(0.0, 0.0)` when the window is not focused.
/// Otherwise returns the amount scrolled by the mouse during the last step.
/// Returns (horizontally, vertically)
pub fn scroll_diff(&self) -> (f32, f32) {
match &self.current {
Some(current) => (current.x_scroll_diff, current.y_scroll_diff),
None => (0.0, 0.0),
}
}
/// Returns the cursor coordinates in pixels, when window is focused AND (cursor is on window OR any mouse button remains held while cursor moved off window)
/// Otherwise returns `None`
pub fn cursor(&self) -> Option<(f32, f32)> {
match &self.current {
Some(current) => current.cursor_point,
None => None,
}
}
/// Returns the change in cursor coordinates that occured during the last step, when window is focused AND (cursor is on window OR any mouse button remains held while cursor moved off window)
/// Otherwise returns `(0.0, 0.0)`.
pub fn cursor_diff(&self) -> (f32, f32) {
if let Some(current_input) = &self.current {
if let Some(cur) = current_input.cursor_point {
if let Some(prev) = current_input.cursor_point_prev {
return (cur.0 - prev.0, cur.1 - prev.1);
}
}
}
(0.0, 0.0)
}
/// Returns the change in mouse coordinates that occured during the last step.
///
/// This is useful when implementing first person controls with a captured mouse.
///
/// Because this uses `DeviceEvent`s, the `step_with_windows_events`
/// function won't update this as it is not a `WindowEvent`.
pub fn mouse_diff(&self) -> (f32, f32) {
if let Some(current_input) = &self.current {
if let Some(diff) = current_input.mouse_diff {
return diff;
}
}
(0.0, 0.0)
}
/// Returns the characters pressed during the last step.
/// The earlier the character was pressed, the lower the index in the Vec.
pub fn text(&self) -> Vec<TextChar> {
match &self.current {
Some(current) => current.text.clone(),
None => vec![],
}
}
/// Returns the path to a file that has been drag-and-dropped onto the window.
pub fn dropped_file(&self) -> Option<PathBuf> {
self.dropped_file.clone()
}
/// Returns the current window size if it was resized during the last step.
/// Otherwise returns `None`.
pub fn window_resized(&self) -> Option<PhysicalSize<u32>> {
self.window_resized
}
/// Returns `None` when no `WindowEvent::Resized` have been received yet.
/// After one has been received it returns the current resolution of the window.
pub fn resolution(&self) -> Option<(u32, u32)> {
self.window_size
}
/// Returns the current scale factor if it was changed during the last step.
/// Otherwise returns `None`.
pub fn scale_factor_changed(&self) -> Option<f64> {
self.scale_factor_changed
}
/// Returns `None` when no `WindowEvent::ScaleFactorChanged` have been received yet.
/// After one has been received it returns the current scale_factor of the window.
pub fn scale_factor(&self) -> Option<f64> {
self.scale_factor
}
/// Returns true if the window has been destroyed
/// Otherwise returns false.
/// Once this method has returned true once all following calls to this method will also return true.
pub fn destroyed(&self) -> bool {
self.destroyed
}
/// Returns true if the OS has requested the application to close during this step.
/// Otherwise returns false.
pub fn close_requested(&self) -> bool {
self.close_requested
}
/// Deprecated
#[deprecated(note = "Instead use `input.close_requested() || input.destroyed()`")]
pub fn quit(&self) -> bool {
self.close_requested || self.destroyed
}
/// Returns the `std::time::Duration` elapsed since the last step.
/// Returns `None` if the step is still in progress.
pub fn delta_time(&self) -> Option<Duration> {
self.step_duration
}
}