open-timeline-gui 0.1.0

OpenTimeline GUI
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

// SPDX-License-Identifier: GPL-3.0-or-later

//!
//! Keyboard shortcuts
//!

use crate::app::{ActionRequest, EntityOrTimelineActionRequest};
use eframe::egui::{Context, Key, KeyboardShortcut, Modifiers};
use tokio::sync::mpsc::UnboundedSender;

/// Helpers for handling OpenTimeline-specific keyboard shortcuts
pub struct OpenTimelineShortcut {}

impl OpenTimelineShortcut {
    /// Shortcut for creating a new entity window (Cmd + Shift + E)
    pub fn new_create_entity_window(ctx: &Context) -> bool {
        let modifiers = if cfg!(target_os = "macos") {
            Modifiers::MAC_CMD | Modifiers::SHIFT
        } else {
            Modifiers::CTRL | Modifiers::SHIFT
        };
        let new_create_entity_window_shortcut = KeyboardShortcut::new(modifiers, Key::E);
        let shortcut_used =
            ctx.input_mut(|i| i.consume_shortcut(&new_create_entity_window_shortcut));
        if shortcut_used {
            debug!("Create new entity window shortcut");
        }
        shortcut_used
    }

    /// Shortcut for creating a new timeline window (Cmd + Shift + T)
    pub fn new_create_timeline_window(ctx: &Context) -> bool {
        let modifiers = if cfg!(target_os = "macos") {
            Modifiers::MAC_CMD | Modifiers::SHIFT
        } else {
            Modifiers::CTRL | Modifiers::SHIFT
        };
        let create_timeline_window_shortcut = KeyboardShortcut::new(modifiers, Key::T);
        let shortcut_used = ctx.input_mut(|i| i.consume_shortcut(&create_timeline_window_shortcut));
        if shortcut_used {
            debug!("Create new timeline window shortcut");
        }
        shortcut_used
    }
}

/// Check for use of a global shortcut
pub fn global_shortcuts(ctx: &Context, tx_action_request: &mut UnboundedSender<ActionRequest>) {
    // New window for creating an entity
    if OpenTimelineShortcut::new_create_entity_window(ctx) {
        let _ = tx_action_request.send(ActionRequest::Entity(
            EntityOrTimelineActionRequest::CreateNew,
        ));
    }

    // New window for creating a timeline
    if OpenTimelineShortcut::new_create_timeline_window(ctx) {
        let _ = tx_action_request.send(ActionRequest::Timeline(
            EntityOrTimelineActionRequest::CreateNew,
        ));
    }
}