Remove Builder abstractions for gradients

This commit is contained in:
Héctor Ramón Jiménez 2023-05-19 03:32:21 +02:00
parent 6551a0b2ab
commit 4c1a082f04
No known key found for this signature in database
GPG key ID: 140CC052C94F138E
15 changed files with 167 additions and 213 deletions

View file

@ -12,7 +12,7 @@ pub use stroke::{LineCap, LineDash, LineJoin, Stroke};
pub use style::Style;
pub use text::Text;
pub use crate::core::gradient::{self, Gradient};
pub use crate::gradient::{self, Gradient};
use crate::Primitive;

View file

@ -1,8 +1,8 @@
//! Fill [crate::widget::canvas::Geometry] with a certain style.
use iced_core::Color;
pub use crate::geometry::Style;
use crate::Gradient;
use crate::core::Color;
use crate::gradient::{self, Gradient};
/// The style used to fill geometry.
#[derive(Debug, Clone)]
@ -50,6 +50,15 @@ impl From<Gradient> for Fill {
}
}
impl From<gradient::Linear> for Fill {
fn from(gradient: gradient::Linear) -> Self {
Fill {
style: Style::Gradient(Gradient::Linear(gradient)),
..Default::default()
}
}
}
/// The fill rule defines how to determine what is inside and what is outside of
/// a shape.
///

View file

@ -1,10 +1,11 @@
//! A gradient that can be used as a [`Fill`] for a mesh.
//! A gradient that can be used as a [`Fill`] for some geometry.
//!
//! For a gradient that you can use as a background variant for a widget, see [`Gradient`].
//!
//! [`Gradient`]: crate::core::Gradient;
use crate::core::Point;
pub use linear::Linear;
use crate::core::gradient::ColorStop;
use crate::core::{Color, Point};
use std::cmp::Ordering;
#[derive(Debug, Clone, PartialEq)]
/// A fill which linearly interpolates colors along a direction.
@ -16,104 +17,72 @@ pub enum Gradient {
Linear(Linear),
}
impl Gradient {
/// Creates a new linear [`linear::Builder`].
///
/// The `start` and `end` [`Point`]s define the absolute position of the [`Gradient`].
pub fn linear(start: Point, end: Point) -> linear::Builder {
linear::Builder::new(start, end)
impl From<Linear> for Gradient {
fn from(gradient: Linear) -> Self {
Self::Linear(gradient)
}
}
pub mod linear {
//! Linear gradient builder & definition.
use crate::Gradient;
use iced_core::gradient::ColorStop;
use iced_core::{Color, Point};
use std::cmp::Ordering;
/// A linear gradient that can be used in the style of [`Fill`] or [`Stroke`].
///
/// [`Fill`]: crate::geometry::Fill;
/// [`Stroke`]: crate::geometry::Stroke;
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct Linear {
/// The absolute starting position of the gradient.
pub start: Point,
/// A linear gradient that can be used in the style of [`Fill`] or [`Stroke`].
/// The absolute ending position of the gradient.
pub end: Point,
/// [`ColorStop`]s along the linear gradient direction.
pub stops: [Option<ColorStop>; 8],
}
impl Linear {
/// Creates a new [`Builder`].
pub fn new(start: Point, end: Point) -> Self {
Self {
start,
end,
stops: [None; 8],
}
}
/// Adds a new [`ColorStop`], defined by an offset and a color, to the gradient.
///
/// [`Fill`]: crate::geometry::Fill;
/// [`Stroke`]: crate::geometry::Stroke;
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct Linear {
/// The absolute starting position of the gradient.
pub start: Point,
/// Any `offset` that is not within `0.0..=1.0` will be silently ignored.
///
/// Any stop added after the 8th will be silently ignored.
pub fn add_stop(mut self, offset: f32, color: Color) -> Self {
if offset.is_finite() && (0.0..=1.0).contains(&offset) {
let (Ok(index) | Err(index)) =
self.stops.binary_search_by(|stop| match stop {
None => Ordering::Greater,
Some(stop) => stop.offset.partial_cmp(&offset).unwrap(),
});
/// The absolute ending position of the gradient.
pub end: Point,
if index < 8 {
self.stops[index] = Some(ColorStop { offset, color });
}
} else {
log::warn!("Gradient: ColorStop must be within 0.0..=1.0 range.");
};
/// [`ColorStop`]s along the linear gradient direction.
pub color_stops: [Option<ColorStop>; 8],
self
}
/// A [`Linear`] builder.
#[derive(Debug)]
pub struct Builder {
start: Point,
end: Point,
stops: [Option<ColorStop>; 8],
}
impl Builder {
/// Creates a new [`Builder`].
pub fn new(start: Point, end: Point) -> Self {
Self {
start,
end,
stops: [None; 8],
}
/// Adds multiple [`ColorStop`]s to the gradient.
///
/// Any stop added after the 8th will be silently ignored.
pub fn add_stops(
mut self,
stops: impl IntoIterator<Item = ColorStop>,
) -> Self {
for stop in stops.into_iter() {
self = self.add_stop(stop.offset, stop.color)
}
/// Adds a new [`ColorStop`], defined by an offset and a color, to the gradient.
///
/// Any `offset` that is not within `0.0..=1.0` will be silently ignored.
///
/// Any stop added after the 8th will be silently ignored.
pub fn add_stop(mut self, offset: f32, color: Color) -> Self {
if offset.is_finite() && (0.0..=1.0).contains(&offset) {
let (Ok(index) | Err(index)) =
self.stops.binary_search_by(|stop| match stop {
None => Ordering::Greater,
Some(stop) => stop.offset.partial_cmp(&offset).unwrap(),
});
if index < 8 {
self.stops[index] = Some(ColorStop { offset, color });
}
} else {
log::warn!(
"Gradient: ColorStop must be within 0.0..=1.0 range."
);
};
self
}
/// Adds multiple [`ColorStop`]s to the gradient.
///
/// Any stop added after the 8th will be silently ignored.
pub fn add_stops(
mut self,
stops: impl IntoIterator<Item = ColorStop>,
) -> Self {
for stop in stops.into_iter() {
self = self.add_stop(stop.offset, stop.color)
}
self
}
/// Builds the linear [`Gradient`] of this [`Builder`].
///
/// Returns `BuilderError` if gradient in invalid.
pub fn build(self) -> Gradient {
Gradient::Linear(Linear {
start: self.start,
end: self.end,
color_stops: self.stops,
})
}
self
}
}

View file

@ -23,13 +23,13 @@
#![cfg_attr(docsrs, feature(doc_cfg))]
mod antialiasing;
mod error;
mod gradient;
mod transformation;
mod viewport;
pub mod backend;
pub mod compositor;
pub mod damage;
pub mod gradient;
pub mod primitive;
pub mod renderer;