gantz_egui 0.6.0

UI traits and widgets that make up the GUI for gantz, an environment for creative systems.
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

use crate::{Env, NodeCtx, NodeUi, NodeUiResponse, SocketDoc, SocketKind, node, ui_tree::UiTree};

impl NodeUi for gantz_std::Bang {
    fn name(&self, _: &Env<'_>) -> std::borrow::Cow<'_, str> {
        "!".into()
    }

    fn description(&self) -> Option<&'static str> {
        Some("Trigger downstream evaluation")
    }

    fn ui(&mut self, mut ctx: NodeCtx, uictx: egui_graph::NodeCtx) -> NodeUiResponse {
        // A bang only triggers downstream evaluation; it never edits the
        // node's content address, so the button pushes but never `changed`.
        let (&id, prefix) = ctx.path().split_last().expect("a node path is never empty");
        let tree = fragment(id);
        let root_id = uictx.egui_id().with("gui");
        let mut payloads = Vec::new();
        let framed = uictx.framed(|ui, _sockets| {
            let r = UiTree::new(root_id)
                .instance_prefix(prefix)
                .n_outputs(&|_: &[node::Id]| Some(1))
                .show(&tree, &mut ctx, ui);
            payloads = r.payloads;
            r.inner.unwrap_or_else(|| ui.response())
        });
        let mut resp = NodeUiResponse::new(framed);
        resp.payloads.extend(payloads);
        resp
    }

    fn socket_doc(&self, _: &Env<'_>, kind: SocketKind, _ix: usize) -> Option<SocketDoc> {
        match kind {
            SocketKind::Output => Some(
                SocketDoc::ty("bang")
                    .with_description("empty list '() emitted to trigger downstream evaluation"),
            ),
            SocketKind::Input => {
                Some(SocketDoc::ty("trigger").with_description("ignored; emits a bang when pushed"))
            }
        }
    }
}

/// The bang's button fragment, bound to its own id. The padded label is the
/// bang's visual, not an interpreter default.
fn fragment(id: node::Id) -> gantz_ui::Element {
    gantz_ui::Element::Button(gantz_ui::Button {
        bind: Some(gantz_ui::BindPath(vec![id])),
        label: Some(" ! ".to_string()),
        key: None,
    })
}

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

    #[test]
    fn fragment_bakes_bind_and_label() {
        let expected = gantz_ui::Element::Button(gantz_ui::Button {
            bind: Some(gantz_ui::BindPath(vec![5])),
            label: Some(" ! ".to_string()),
            key: None,
        });
        assert_eq!(fragment(5), expected);
    }
}