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
151
152
153
154

use alloc::boxed::Box;

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

use crate::{
    default_shader_impl,
    fx::{
        expand::ExpandDirection::{Horizontal, Vertical},
        stretch::Stretch,
    },
    CellFilter, Duration, EffectTimer, Motion, Shader,
};

/// Direction for bidirectional expansion effects.
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum ExpandDirection {
    /// Expands horizontally from center (left and right simultaneously)
    Horizontal,
    /// Expands vertically from center (up and down simultaneously)
    Vertical,
}

/// A shader that applies bidirectional expansion effects using two opposing stretch
/// shaders.
///
/// Creates expansion animations that grow outward from the center in both directions
/// simultaneously, either horizontally or vertically.
#[derive(Clone, Debug)]
pub(super) struct Expand {
    direction: ExpandDirection,
    stretch_a: Stretch,
    stretch_b: Stretch,
    /// The area within which the effect is applied.
    area: Option<Rect>,
}

impl Expand {
    /// Creates a new expand effect with the specified direction, style, and timing.
    pub(super) fn new(direction: ExpandDirection, style: Style, timer: EffectTimer) -> Self {
        use ExpandDirection::*;

        Self {
            direction,
            stretch_a: Stretch::builder()
                .style(style)
                .timer(timer)
                .direction(match direction {
                    Horizontal => Motion::RightToLeft,
                    Vertical => Motion::DownToUp,
                })
                .build(),
            stretch_b: Stretch::builder()
                .style(style)
                .timer(timer)
                .direction(match direction {
                    Horizontal => Motion::LeftToRight,
                    Vertical => Motion::UpToDown,
                })
                .build(),
            area: None,
        }
    }
}

impl Shader for Expand {
    default_shader_impl!(area, clone);

    fn name(&self) -> &'static str {
        "Expand"
    }

    fn cell_filter(&self) -> Option<&CellFilter> {
        self.stretch_a.cell_filter()
    }

    fn done(&self) -> bool {
        self.stretch_a.done()
    }

    fn filter(&mut self, filter: CellFilter) {
        self.stretch_a.filter(filter.clone());
        self.stretch_b.filter(filter);
    }

    fn reset(&mut self) {
        self.stretch_a.reset();
        self.stretch_b.reset();
    }

    fn process(&mut self, duration: Duration, buf: &mut Buffer, area: Rect) -> Option<Duration> {
        // safe area
        let area = self.area.unwrap_or(area).intersection(buf.area);

        let (area_a, area_b) = match self.direction {
            Horizontal => {
                let area_a = Rect {
                    x: area.x,
                    y: area.y,
                    width: area.width / 2,
                    height: area.height,
                };
                let area_b = Rect {
                    x: area_a.right(),
                    y: area.y,
                    width: area.width - area_a.width,
                    height: area.height,
                };
                (area_a, area_b)
            },
            Vertical => {
                let area_a = Rect {
                    x: area.x,
                    y: area.y,
                    width: area.width,
                    height: area.height / 2,
                };
                let area_b = Rect {
                    x: area.x,
                    y: area_a.bottom(),
                    width: area.width,
                    height: area.height - area_a.height,
                };
                (area_a, area_b)
            },
        };

        self.stretch_a.process(duration, buf, area_a);
        self.stretch_b.process(duration, buf, area_b)
    }

    fn reverse(&mut self) {
        self.stretch_a.reverse();
        self.stretch_b.reverse();
    }

    #[cfg(feature = "dsl")]
    fn to_dsl(&self) -> Result<crate::dsl::EffectExpression, crate::dsl::DslError> {
        use crate::dsl::{DslFormat, EffectExpression};

        let direction_str = match self.direction {
            Horizontal => "ExpandDirection::Horizontal",
            Vertical => "ExpandDirection::Vertical",
        };

        EffectExpression::parse(&compact_str::format_compact!(
            "fx::expand({}, {}, {})",
            direction_str,
            self.stretch_a.style.dsl_format(),
            self.stretch_a.timer.dsl_format(),
        ))
    }
}