Struct CellAnimation 

pub struct CellAnimation { /* private fields */ }

A one-cell animation. See the module documentation for the file format.

use qframe::animation::{AnimationFrame, CellAnimation, CellColor, Playback};

let blink = CellAnimation::new()
    .frame(AnimationFrame::new("*").unicode("●"))
    .frame(AnimationFrame::new(".").unicode("·").color(CellColor::parse("$muted").expect("colour")))
    .playback(Playback::Bounce);
assert_eq!(blink.frames().len(), 2);

Implementations

impl CellAnimation

pub fn sample( &self, theme: &Theme, fg: Option<Rgb>, now: Duration, since: Option<Duration>, ) -> CellFrame

The frame and colour at now.

since is when the animation started (a time on the same clock as now, such as PaintCx::now); None shows the rest frame standing still, which is what reduced motion asks for. Looping spinners pass Duration::ZERO, so every spinner on screen turns in step. Frames without a colour, and $fg in colour expressions, take fg; a colour naming a token the theme lacks is treated the same way. Pulses breathe over the theme’s motion.pulse-period on the now clock.

impl CellAnimation

pub fn to_toml(&self, name: &str) -> String

The [animations.<name>] table for this animation, ready to paste into an icon set, theme or animation file. Reading it back gives the same animation. Glyphs a frame leaves to its fallback are left out, and Nerd Font glyphs from the private use areas are written as \u escapes so they survive fonts and clipboards that cannot show them.

impl CellAnimation

pub fn new() -> Self

An animation without frames, looping at the theme’s motion.spinner with step colours.

pub fn frame(self, frame: AnimationFrame) -> Self

Adds a frame at the end.

pub fn frame_time(self, time: FrameTime) -> Self

How long each frame is shown, unless the frame has its own duration.

pub fn playback(self, playback: Playback) -> Self

How the frames follow one another.

pub fn colors(self, colors: ColorMode) -> Self

How colours move between frames.

pub fn rest(self, index: usize) -> Self

The frame shown with reduced motion, counted from 0. Without it the first frame rests, or the last for Playback::Once.

pub fn frames(&self) -> &[AnimationFrame]

The frames in order.

pub fn time(&self) -> FrameTime

The frame time.

pub fn play_mode(&self) -> Playback

The playback.

pub fn color_mode(&self) -> ColorMode

The colour mode.

pub fn rest_frame(&self) -> Option<usize>

The rest frame as set, counted from 0.

pub fn rest_index(&self) -> usize

The frame shown standing still: the rest frame, else the first, or the last for Playback::Once; always a valid index of a non-empty animation.

pub fn glyph(&self, index: usize, mode: GlyphMode) -> &str

The glyph of frame index in mode; empty when there is no such frame.

Trait Implementations

impl Clone for CellAnimation

fn clone(&self) -> CellAnimation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CellAnimation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CellAnimation

fn default() -> CellAnimation

Returns the “default value” for a type.

impl Eq for CellAnimation

impl PartialEq for CellAnimation

fn eq(&self, other: &CellAnimation) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CellAnimation