Struct AnimationRunner 

pub struct AnimationRunner { /* private fields */ }

Implementations

impl AnimationRunner

pub fn new() -> Self

pub fn start(&mut self, area: Rect, kind: AnimationKind) -> AnimationId

pub fn start_with_id( &mut self, id: AnimationId, area: Rect, kind: AnimationKind, )

Start an effect using a caller-supplied ID. Intended for the plugin bridge, where the plugin-side counter is the source of truth so the JS call can return the ID synchronously.

Replaces any existing active effect covering exactly the same area. Without this, rapid re-triggers over the same Rect (tab cycling, dashboard data refresh) stack effects whose snapshots contaminate each other: the second effect’s “after” snapshot is taken from a buffer the first effect has already shifted, so when both finish the final image is frozen mid-transition. Replacement keeps exactly one effect per area — the latest one wins, its before-snapshot (read from the runner’s last_frame) captures whatever the user is actually seeing right now, including any in-flight shift, and the new push-over-blanks starts from there.

pub fn cancel(&mut self, id: AnimationId)

pub fn has_dismissable(&self) -> bool

True if an interactive, dismiss-on-input effect (the wave) is running.

pub fn cancel_dismissable(&mut self)

Tear down any interactive, dismiss-on-input effect (the wave).

pub fn capture_before_all(&mut self)

Let each active effect snapshot the “before” state of its Rect from the cached last-frame buffer. Called once per render, at the start of the pass. We can’t read the live frame.buffer_mut() here because ratatui resets the current buffer before each draw (see swap_buffers); our own cache is what actually holds what was on screen last frame.

Effects still in their delay window are skipped, and effects whose Rect falls outside the cached buffer (resize shrank the terminal) are skipped too — they fall back to the slide-over- blanks path.

pub fn apply_all(&mut self, buf: &mut Buffer)

pub fn is_active(&self) -> bool

pub fn total_started(&self) -> u64

Cumulative number of effects accepted by either start or start_with_id, since this runner was constructed. Monotonic — never decreases. Tests use this to detect that an effect was kicked off without having to catch the transient is_active() window between two polling ticks.

pub fn next_deadline(&self) -> Option<Instant>

pub fn last_frame_area(&self) -> Option<Rect>

Area of the cached last-frame buffer, i.e. the full screen as of the previous render. None until the first frame has been drawn. Full-screen effects (theme color transition) use this as their Rect so callers don’t need to thread the terminal size through.

pub fn is_animating_at(&self, col: u16, row: u16) -> bool

True if (col, row) falls inside the area of any running effect. Use this to suppress click routing during an animation.

Trait Implementations

impl Default for AnimationRunner

fn default() -> Self

Returns the “default value” for a type.