concinnity-dev 0.19.53

The Concinnity dev tooling library: world authoring, the in-engine editor, the debug server, docs and packaging
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

//! EditorHook: the Worlds panel's session state, beside its actions in
//! `worlds.rs`.

use crate::editor::worlds::WorldRow;

// Shown state, the project's worlds as of the last refresh (the listing changes
// only when the panel acts on it, so it is not re-read every frame), the row
// window's scroll, the path of the row whose triple-dot menu is open, and why
// the last preview failed.
#[derive(Debug, Default)]
pub(in crate::editor::hook) struct WorldsState {
    pub(in crate::editor::hook) open: bool,
    pub(in crate::editor::hook) rows: Vec<WorldRow>,
    pub(in crate::editor::hook) scroll: usize,
    pub(in crate::editor::hook) menu: Option<String>,
    pub(in crate::editor::hook) status: Option<String>,
    // The path of the start screen's selected row, and of the world its
    // background preview was compiled from. They part company when the
    // previewed world is deleted (the background drops back to the seeded
    // empty scene) or its compile fails. Both `None` outside the start screen,
    // which has no selection model.
    pub(in crate::editor::hook) selected: Option<String>,
    pub(in crate::editor::hook) preview: Option<String>,
}

impl WorldsState {
    // Show the panel from its top, with no menu or stale failure. The caller
    // refreshes the listing.
    pub(in crate::editor::hook) fn open(&mut self) {
        self.open = true;
        self.status = None;
        self.scroll = 0;
        self.menu = None;
    }

    // Hide the panel, dropping its menu, failure and scroll.
    pub(in crate::editor::hook) fn close(&mut self) {
        self.open = false;
        self.menu = None;
        self.status = None;
        self.scroll = 0;
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn dirty() -> WorldsState {
        WorldsState {
            open: false,
            rows: vec![WorldRow {
                open: true,
                name: "a".into(),
                path: "a.jsonl".into(),
            }],
            scroll: 3,
            menu: Some("a.jsonl".into()),
            status: Some("failed".into()),
            selected: Some("a.jsonl".into()),
            preview: Some("b.jsonl".into()),
        }
    }

    fn assert_listing_kept(s: &WorldsState) {
        assert_eq!(s.rows.len(), 1);
        assert_eq!(s.selected.as_deref(), Some("a.jsonl"));
        assert_eq!(s.preview.as_deref(), Some("b.jsonl"));
    }

    #[test]
    fn open_clears_menu_status_and_scroll() {
        let mut s = dirty();
        s.open();
        assert!(s.open);
        assert_eq!((&s.menu, &s.status, s.scroll), (&None, &None, 0));
        assert_listing_kept(&s);
    }

    #[test]
    fn close_clears_menu_status_and_scroll() {
        let mut s = dirty();
        s.open = true;
        s.close();
        assert!(!s.open);
        assert_eq!((&s.menu, &s.status, s.scroll), (&None, &None, 0));
        assert_listing_kept(&s);
    }
}