oxframe-components 0.20.5

Ready-made blocks for explainer videos: titles, lists, diagrams, code
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

//! An arrow and a caption aimed at another node.

use oxframe_2d::{
    Accent, BaseProps, Group, Len, Line, Md, Muted, Node, NodeBuilder, NodeId, Side, Txt,
};
use oxframe_core::Tween;

use crate::host::{self, Host};

/// A caption above `target`, with an arrow pointing down at it.
/// `next` reveals the caption; the arrow comes in with `enter`.
pub struct Callout {
    host: Host,
}

impl Callout {
    /// The caption stays hidden until `next`.
    #[allow(clippy::new_ret_no_self)]
    pub fn new(target: impl Into<Node>) -> CalloutBuilder {
        CalloutBuilder {
            base: BaseProps::default(),
            target: target.into(),
            text: String::new(),
        }
    }

    /// Fades the arrow in.
    pub fn enter(&self) -> Tween<f64> {
        self.host.enter()
    }
    /// Fades the caption in.
    pub fn next(&self) -> Tween<f64> {
        self.host.next()
    }
    /// Fades the callout out.
    pub fn exit(&self) -> Tween<f64> {
        self.host.exit()
    }
}

/// Builder for [`Callout`].
#[must_use = "a builder does nothing until it is passed to `add`"]
pub struct CalloutBuilder {
    base: BaseProps,
    target: Node,
    text: String,
}

impl CalloutBuilder {
    /// Caption text.
    pub fn text(mut self, text: impl Into<String>) -> Self {
        self.text = text.into();
        self
    }
}

impl NodeBuilder for CalloutBuilder {
    type Handle = Callout;
    fn base(&mut self) -> &mut BaseProps {
        &mut self.base
    }
    fn build(self, _: &oxframe_2d::SceneGraph, parent: NodeId) -> Callout {
        let root: Group = host::root(parent, self.base);
        let root = root.next_to(self.target, Side::Top);
        let gap = Md.px();
        root.add(
            Line::new()
                .points([(0.0, 28.0), (0.0, 28.0 + gap)])
                .end_arrow(true)
                .stroke(Accent)
                .line_width(4.0)
                .name("arrow"),
        );
        let caption = root.add(
            Txt::new()
                .text(self.text)
                .caption()
                .fill(Muted)
                .opacity(0.0)
                .name("caption"),
        );
        Callout {
            host: Host::new(root, vec![caption.node()]),
        }
    }
}