cosmic/widget/progress_bar/

linear.rs

//! Show a linear progress indicator.
use super::animation::{Animation, Progress};
use super::style::{self, Catalog};
use iced::advanced::widget::tree::{self, Tree};
use iced::advanced::{self, Clipboard, Layout, Shell, Widget, layout, renderer};
use iced::{Border, Color, Element, Event, Length, Pixels, Rectangle, Size, mouse, window};

use std::time::Duration;

const MIN_LENGTH: f32 = 0.15;
const WRAP_LENGTH: f32 = 0.618; // avoids animation repetition

#[must_use]
pub struct Linear<Theme>
where
    Theme: Catalog,
{
    width: Length,
    girth: Length,
    class: Theme::Class,
    cycle_duration: Duration,
    period: Duration,
    progress: Option<f32>,
    markers: Vec<f32>,
    segment_spacing: f32,
}

impl<Theme> Linear<Theme>
where
    Theme: Catalog<Class = style::Class>,
{
    /// Creates a new [`Linear`] with the given content.
    pub fn new() -> Self {
        Linear {
            width: Length::Fixed(100.0),
            girth: Length::Fixed(4.0),
            class: Theme::Class::default(),
            cycle_duration: Duration::from_millis(1500),
            period: Duration::from_secs(2),
            progress: None,
            markers: Vec::new(),
            segment_spacing: 1.0,
        }
    }

    /// Sets the width of the [`Linear`].
    pub fn width(mut self, width: impl Into<Length>) -> Self {
        self.width = width.into();
        self
    }

    /// Sets the girth of the [`Linear`].
    pub fn girth(mut self, girth: impl Into<Length>) -> Self {
        self.girth = girth.into();
        self
    }

    /// Sets the style class of this [`Linear`].
    pub fn class(mut self, class: Theme::Class) -> Self {
        self.class = class;
        self
    }

    /// Sets the cycle duration of this [`Linear`].
    pub fn cycle_duration(mut self, duration: Duration) -> Self {
        self.cycle_duration = duration / 2;
        self
    }

    /// Sets the base period of this [`Linear`]. This is the duration that a full traversal
    /// would take if the cycle duration were set to 0.0 (no expanding or contracting)
    pub fn period(mut self, duration: Duration) -> Self {
        self.period = duration;
        self
    }

    /// Override the default behavior by providing a determinate progress value between `0.0` and `1.0`.
    pub fn progress(mut self, progress: f32) -> Self {
        self.progress = Some(progress.clamp(0.0, 1.0));
        self
    }

    /// Sets the markers of a determinate progress bar, which divide the bar into segments.
    /// Each marker is a value between `0.0` and `1.0` that defines the position of a visual gap.
    pub fn markers(mut self, markers: impl Into<Vec<f32>>) -> Self {
        let mut markers = markers.into();
        for marker in &mut markers {
            *marker = marker.clamp(0.0, 1.0);
        }
        markers.sort_by(f32::total_cmp);
        markers.dedup();

        self.markers = markers;
        self
    }

    /// Sets the spacing between segments at each marker.
    pub fn segment_spacing(mut self, spacing: impl Into<Pixels>) -> Self {
        self.segment_spacing = spacing.into().0.max(1.0);
        self
    }

    /// Sets the track color of this [`Linear`].
    pub fn track_color(mut self, color: impl Into<iced::Color>) -> Self {
        self.class = self.class.track_color(color);
        self
    }

    /// Sets the bar color of this [`Linear`].
    pub fn bar_color(mut self, color: impl Into<iced::Color>) -> Self {
        self.class = self.class.bar_color(color);
        self
    }

    /// Sets the border color of this [`Linear`].
    pub fn border_color(mut self, color: impl Into<iced::Color>) -> Self {
        self.class = self.class.border_color(color);
        self
    }

    /// Sets the border radius of this [`Linear`].
    pub fn border_radius(mut self, radius: f32) -> Self {
        self.class = self.class.border_radius(radius);
        self
    }
}

impl<Theme> Default for Linear<Theme>
where
    Theme: Catalog<Class = style::Class>,
{
    fn default() -> Self {
        Self::new()
    }
}

#[derive(Default)]
struct State {
    animation: Animation,
    progress: Progress,
}

impl<Message, Theme, Renderer> Widget<Message, Theme, Renderer> for Linear<Theme>
where
    Message: Clone,
    Theme: Catalog,
    Renderer: advanced::Renderer,
{
    fn tag(&self) -> tree::Tag {
        tree::Tag::of::<State>()
    }

    fn state(&self) -> tree::State {
        tree::State::new(State::default())
    }

    fn size(&self) -> Size<Length> {
        Size {
            width: self.width,
            height: self.girth,
        }
    }

    fn layout(
        &mut self,
        _tree: &mut Tree,
        _renderer: &Renderer,
        limits: &layout::Limits,
    ) -> layout::Node {
        layout::atomic(limits, self.width, self.girth)
    }

    fn update(
        &mut self,
        tree: &mut Tree,
        event: &Event,
        _layout: Layout<'_>,
        _cursor: mouse::Cursor,
        _renderer: &Renderer,
        _clipboard: &mut dyn Clipboard,
        shell: &mut Shell<'_, Message>,
        _viewport: &Rectangle,
    ) {
        let state = tree.state.downcast_mut::<State>();
        if let Event::Window(window::Event::RedrawRequested(now)) = event {
            if let Some(target) = self.progress {
                if state.progress.update(target, *now) {
                    shell.request_redraw();
                }
            } else {
                state.animation = state.animation.timed_transition(
                    self.cycle_duration,
                    self.period,
                    WRAP_LENGTH,
                    *now,
                );
                shell.request_redraw();
            }
        }
    }

    fn draw(
        &self,
        tree: &Tree,
        renderer: &mut Renderer,
        theme: &Theme,
        _style: &renderer::Style,
        layout: Layout<'_>,
        _cursor: mouse::Cursor,
        _viewport: &Rectangle,
    ) {
        let bounds = layout.bounds();
        let custom_style = theme.style(&self.class, self.progress.is_some(), false);
        let state = tree.state.downcast_ref::<State>();

        let border_width = if custom_style.border_color.is_some() {
            1.0
        } else {
            0.0
        };
        let border_color = custom_style.border_color.unwrap_or(custom_style.bar_color);
        let radius = custom_style.border_radius;
        let track_color = custom_style.track_color;
        let bar_color = custom_style.bar_color;

        let draw_quad = |renderer: &mut Renderer, rect: Rectangle, border: Border, color: Color| {
            renderer.fill_quad(
                renderer::Quad {
                    bounds: rect,
                    border,
                    snap: true,
                    ..renderer::Quad::default()
                },
                color,
            );
        };
        let to_rect = |x: f32, width: f32| Rectangle {
            x: bounds.x + x * bounds.width,
            y: bounds.y,
            width: width * bounds.width,
            height: bounds.height,
        };

        // determinate progress bar
        if self.progress.is_some() {
            let current_p = state.progress.current;
            let len = self.markers.len();
            let spacing = self.segment_spacing;
            let gap = spacing / bounds.width;
            let drawable = 1.0 - gap * len as f32;
            let radius_inner = radius.min(spacing);

            for i in 0..=len {
                let (seg_lo, r_left) = if i == 0 {
                    (0.0, radius)
                } else {
                    (self.markers[i - 1], radius_inner)
                };
                let (seg_hi, r_right) = if i == len {
                    (1.0, radius)
                } else {
                    (self.markers[i], radius_inner)
                };
                let x_start = seg_lo * drawable + i as f32 * gap;
                let x_width = (seg_hi - seg_lo) * drawable;
                let rect = to_rect(x_start, x_width);
                let segment_radius = [r_left, r_right, r_right, r_left].into();

                let border = Border {
                    width: border_width,
                    color: border_color,
                    radius: segment_radius,
                };

                // empty segment
                if current_p < seg_lo {
                    draw_quad(renderer, rect, border, track_color);
                }
                // filled segment
                else if current_p > seg_hi {
                    draw_quad(renderer, rect, border, bar_color);
                }
                // partially filled segment
                else {
                    let fill = (current_p - seg_lo) / (seg_hi - seg_lo);
                    draw_quad(renderer, rect, border, track_color);
                    renderer.with_layer(to_rect(x_start, x_width * fill), |renderer| {
                        draw_quad(renderer, rect, border, bar_color);
                    });
                }
            }
        }
        // indeterminate progress bar
        else {
            // draw track
            draw_quad(
                renderer,
                bounds,
                Border {
                    width: border_width,
                    color: border_color,
                    radius: radius.into(),
                },
                track_color,
            );

            // draw bar
            let (bar_start, bar_end) =
                state
                    .animation
                    .bar_positions(self.cycle_duration, MIN_LENGTH, WRAP_LENGTH);
            let length = bar_end - bar_start;
            let start = bar_start % 1.0;
            let right_width = (1.0 - start).min(length);
            let left_width = length - right_width;
            let border = Border {
                radius: radius.into(),
                ..Border::default()
            };

            renderer.with_layer(to_rect(start, right_width), |renderer| {
                draw_quad(renderer, bounds, border, bar_color);
            });
            renderer.with_layer(to_rect(0.0, left_width), |renderer| {
                draw_quad(renderer, bounds, border, bar_color);
            });
        }
    }
}

impl<'a, Message, Theme, Renderer> From<Linear<Theme>> for Element<'a, Message, Theme, Renderer>
where
    Message: Clone + 'a,
    Theme: Catalog + 'a,
    Renderer: iced::advanced::Renderer + 'a,
{
    fn from(linear: Linear<Theme>) -> Self {
        Self::new(linear)
    }
}