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

//! A name plate at the bottom of the frame, and a chapter label at the top.

use oxframe_2d::{
    BaseProps, Edge, Group, Lg, Md, Muted, NodeBuilder, NodeId, Rect, Surface, Txt, pct,
};
use oxframe_core::Tween;

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

/// Name and role pinned to the bottom safe area. `next` reveals the role.
pub struct LowerThird {
    host: Host,
}

impl LowerThird {
    /// The name is visible after `enter`. The role waits for `next`.
    #[allow(clippy::new_ret_no_self)]
    pub fn new(name: impl Into<String>) -> LowerThirdBuilder {
        LowerThirdBuilder {
            base: BaseProps::default(),
            name: name.into(),
            role: None,
        }
    }

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

/// Builder for [`LowerThird`].
#[must_use = "a builder does nothing until it is passed to `add`"]
pub struct LowerThirdBuilder {
    base: BaseProps,
    name: String,
    role: Option<String>,
}

impl LowerThirdBuilder {
    /// Second line, revealed by `next`.
    pub fn role(mut self, text: impl Into<String>) -> Self {
        self.role = Some(text.into());
        self
    }
}

impl NodeBuilder for LowerThirdBuilder {
    type Handle = LowerThird;
    fn base(&mut self) -> &mut BaseProps {
        &mut self.base
    }
    fn build(self, _: &oxframe_2d::SceneGraph, parent: NodeId) -> LowerThird {
        let root: Group = host::root(parent, self.base);
        let root = root.to_edge(Edge::Bottom);
        root.add(
            Rect::new()
                .width(pct(70))
                .height(140.0)
                .radius(Lg)
                .fill(Surface)
                .elevation(Md)
                .name("plate"),
        );
        root.add(Txt::new().text(self.name).h2().y(-24.0).name("name"));
        let mut reveals = Vec::new();
        if let Some(role) = self.role {
            let line = root.add(
                Txt::new()
                    .text(role)
                    .caption()
                    .fill(Muted)
                    .y(36.0)
                    .opacity(0.0)
                    .name("role"),
            );
            reveals.push(line.node());
        }
        LowerThird {
            host: Host::new(root, reveals),
        }
    }
}

/// A short label pinned to the top safe area.
pub struct ChapterMarker {
    host: Host,
}

impl ChapterMarker {
    /// The label is the whole marker. `next` holds it.
    #[allow(clippy::new_ret_no_self)]
    pub fn new(label: impl Into<String>) -> ChapterMarkerBuilder {
        ChapterMarkerBuilder {
            base: BaseProps::default(),
            label: label.into(),
        }
    }

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

/// Builder for [`ChapterMarker`].
#[must_use = "a builder does nothing until it is passed to `add`"]
pub struct ChapterMarkerBuilder {
    base: BaseProps,
    label: String,
}

impl NodeBuilder for ChapterMarkerBuilder {
    type Handle = ChapterMarker;
    fn base(&mut self) -> &mut BaseProps {
        &mut self.base
    }
    fn build(self, _: &oxframe_2d::SceneGraph, parent: NodeId) -> ChapterMarker {
        let root: Group = host::root(parent, self.base);
        let root = root.to_edge(Edge::Top);
        root.add(Txt::new().text(self.label).h2().name("chapter"));
        ChapterMarker {
            host: Host::new(root, Vec::new()),
        }
    }
}