tachyonfx 0.25.0

A ratatui library for creating shader-like effects in TUIs.
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
143
144
145
146
147
148
149
150

use alloc::boxed::Box;

#[cfg(feature = "dsl")]
use compact_str::ToCompactString;
use ratatui_core::{
    buffer::Buffer,
    layout::{Rect, Size},
};

use crate::{
    effect::Effect, effect_timer::EffectTimer, interpolation::Interpolatable,
    rect_ext::CenteredShrink, shader::Shader, CellFilter, ColorSpace, Duration,
};

#[derive(Clone, Debug)]
pub(super) struct ResizeArea {
    fx: Option<Effect>,
    area: Option<Rect>,
    original_area: Option<Rect>,
    initial_size: Size,
    timer: EffectTimer,
}

impl ResizeArea {
    pub fn new(fx: Option<Effect>, initial_size: Size, timer: EffectTimer) -> Self {
        Self {
            fx,
            initial_size,
            timer,
            original_area: None,
            area: None,
        }
    }
}

impl Shader for ResizeArea {
    fn name(&self) -> &'static str {
        "resize_area"
    }

    fn process(&mut self, duration: Duration, buf: &mut Buffer, area: Rect) -> Option<Duration> {
        if self.original_area.is_none() {
            self.original_area = Some(area);
        }

        let target_area = self.original_area.unwrap();

        let a = self.timer.alpha();
        let overflow = self.timer.process(duration);

        let w = self
            .initial_size
            .width
            .lerp(&target_area.width, a);
        let h = self
            .initial_size
            .height
            .lerp(&target_area.height, a);

        let resized_area = target_area.inner_centered(w, h);
        for y in resized_area.top()..resized_area.bottom() {
            for x in resized_area.left()..resized_area.right() {
                if let Some(cell) = buf.cell_mut((x, y)) {
                    cell.reset();
                }
            }
        }

        self.set_area(resized_area);

        if let Some(fx) = &mut self.fx {
            fx.set_area(resized_area);
            let hosted_overflow = fx.process(duration, buf, resized_area);
            // only return the overflow if the fx is done and this translate is done
            match (overflow, hosted_overflow) {
                (Some(a), Some(b)) => Some(a.min(b)),
                _ => None,
            }
        } else {
            overflow
        }
    }

    fn done(&self) -> bool {
        self.timer.done()
            && (self
                .fx
                .as_ref()
                .is_some_and(super::super::effect::Effect::done)
                || self.fx.is_none())
    }

    fn clone_box(&self) -> Box<dyn Shader> {
        Box::new(self.clone())
    }

    fn area(&self) -> Option<Rect> {
        self.area
    }

    fn set_area(&mut self, area: Rect) {
        self.area = Some(area);
        if let Some(fx) = self.fx.as_mut() {
            fx.set_area(area);
        }
    }

    fn filter(&mut self, strategy: CellFilter) {
        if let Some(fx) = self.fx.as_mut() {
            fx.filter(strategy);
        }
    }

    fn set_color_space(&mut self, color_space: ColorSpace) {
        if let Some(fx) = self.fx.as_mut() {
            fx.set_color_space(color_space);
        }
    }

    fn color_space(&self) -> ColorSpace {
        self.fx
            .as_ref()
            .map(super::super::effect::Effect::color_space)
            .unwrap_or_default()
    }

    fn timer_mut(&mut self) -> Option<&mut EffectTimer> {
        Some(&mut self.timer)
    }

    fn timer(&self) -> Option<EffectTimer> {
        Some(self.timer)
    }

    fn cell_filter(&self) -> Option<&CellFilter> {
        self.fx.as_ref().and_then(Effect::cell_filter)
    }

    fn reset(&mut self) {
        self.timer.reset();
        if let Some(fx) = self.fx.as_mut() {
            fx.reset();
        }
    }

    #[cfg(feature = "dsl")]
    fn to_dsl(&self) -> Result<crate::dsl::EffectExpression, crate::dsl::DslError> {
        Err(crate::dsl::DslError::UnsupportedEffect { name: self.name().to_compact_string() })
    }
}