me/iced
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Replace stateful widgets with new iced_pure API

Browse source
This commit is contained in:
Héctor Ramón Jiménez 2022-07-27 06:49:20 +02:00
parent c44267b85f
commit ff2519b1d4
No known key found for this signature in database
GPG key ID: 140CC052C94F138E
142 changed files with 3631 additions and 14494 deletions
Download patch file Download diff file Expand all files Collapse all files

3
graphics/src/lib.rs
View file

@ -36,9 +36,6 @@ pub mod triangle;
pub mod widget;
pub mod window;
#[doc(no_inline)]
pub use widget::*;
pub use antialiasing::Antialiasing;
pub use backend::Backend;
pub use error::Error;

2
graphics/src/renderer.rs
View file

@ -58,7 +58,7 @@ where
element: &Element<'a, Message, Self>,
limits: &layout::Limits,
) -> layout::Node {
let layout = element.layout(self, limits);
let layout = element.as_widget().layout(self, limits);
self.backend.trim_measurements();

61
graphics/src/widget/canvas.rs
View file

@ -3,8 +3,6 @@
//! A [`Canvas`] widget can be used to draw different kinds of 2D shapes in a
//! [`Frame`]. It can be used for animation, data visualization, game graphics,
//! and more!
use crate::renderer::{self, Renderer};
use crate::{Backend, Primitive};
pub mod event;
pub mod path;
@ -29,42 +27,31 @@ pub use program::Program;
pub use stroke::{LineCap, LineDash, LineJoin, Stroke};
pub use text::Text;
use iced_native::layout;
use crate::{Backend, Primitive, Renderer};
use iced_native::layout::{self, Layout};
use iced_native::mouse;
use iced_native::renderer;
use iced_native::widget::tree::{self, Tree};
use iced_native::{
Clipboard, Element, Layout, Length, Point, Rectangle, Shell, Size, Vector,
Widget,
Clipboard, Element, Length, Point, Rectangle, Shell, Size, Vector, Widget,
};
use std::marker::PhantomData;
/// A widget capable of drawing 2D graphics.
///
/// # Examples
/// The repository has a couple of [examples] showcasing how to use a
/// [`Canvas`]:
///
/// - [`clock`], an application that uses the [`Canvas`] widget to draw a clock
/// and its hands to display the current time.
/// - [`game_of_life`], an interactive version of the Game of Life, invented by
/// John Conway.
/// - [`solar_system`], an animated solar system drawn using the [`Canvas`] widget
/// and showcasing how to compose different transforms.
///
/// [examples]: https://github.com/iced-rs/iced/tree/0.4/examples
/// [`clock`]: https://github.com/iced-rs/iced/tree/0.4/examples/clock
/// [`game_of_life`]: https://github.com/iced-rs/iced/tree/0.4/examples/game_of_life
/// [`solar_system`]: https://github.com/iced-rs/iced/tree/0.4/examples/solar_system
///
/// ## Drawing a simple circle
/// If you want to get a quick overview, here's how we can draw a simple circle:
///
/// ```no_run
/// # mod iced {
/// # pub use iced_graphics::canvas;
/// # pub mod widget {
/// # pub use iced_graphics::widget::canvas;
/// # }
/// # pub use iced_native::{Color, Rectangle, Theme};
/// # }
/// use iced::canvas::{self, Canvas, Cursor, Fill, Frame, Geometry, Path, Program};
/// use iced::widget::canvas::{self, Canvas, Cursor, Fill, Frame, Geometry, Path, Program};
/// use iced::{Color, Rectangle, Theme};
///
/// // First, we define the data we need for drawing
@ -75,7 +62,9 @@ use std::marker::PhantomData;
///
/// // Then, we implement the `Program` trait
/// impl Program<()> for Circle {
/// fn draw(&self, _theme: &Theme, bounds: Rectangle, _cursor: Cursor) -> Vec<Geometry>{
/// type State = ();
///
/// fn draw(&self, _state: &(), _theme: &Theme, bounds: Rectangle, _cursor: Cursor) -> Vec<Geometry>{
/// // We prepare a new `Frame`
/// let mut frame = Frame::new(bounds.size());
///
@ -140,6 +129,15 @@ where
P: Program<Message, T>,
B: Backend,
{
fn tag(&self) -> tree::Tag {
struct Tag<T>(T);
tree::Tag::of::<Tag<P::State>>()
}
fn state(&self) -> tree::State {
tree::State::new(P::State::default())
}
fn width(&self) -> Length {
self.width
}
@ -161,6 +159,7 @@ where
fn on_event(
&mut self,
tree: &mut Tree,
event: iced_native::Event,
layout: Layout<'_>,
cursor_position: Point,
@ -183,8 +182,10 @@ where
let cursor = Cursor::from_window_position(cursor_position);
if let Some(canvas_event) = canvas_event {
let state = tree.state.downcast_mut::<P::State>();
let (event_status, message) =
self.program.update(canvas_event, bounds, cursor);
self.program.update(state, canvas_event, bounds, cursor);
if let Some(message) = message {
shell.publish(message);
@ -198,6 +199,7 @@ where
fn mouse_interaction(
&self,
tree: &Tree,
layout: Layout<'_>,
cursor_position: Point,
_viewport: &Rectangle,
@ -205,12 +207,14 @@ where
) -> mouse::Interaction {
let bounds = layout.bounds();
let cursor = Cursor::from_window_position(cursor_position);
let state = tree.state.downcast_ref::<P::State>();
self.program.mouse_interaction(bounds, cursor)
self.program.mouse_interaction(state, bounds, cursor)
}
fn draw(
&self,
tree: &Tree,
renderer: &mut Renderer<B, T>,
theme: &T,
_style: &renderer::Style,
@ -228,12 +232,13 @@ where
let translation = Vector::new(bounds.x, bounds.y);
let cursor = Cursor::from_window_position(cursor_position);
let state = tree.state.downcast_ref::<P::State>();
renderer.with_translation(translation, |renderer| {
renderer.draw_primitive(Primitive::Group {
primitives: self
.program
.draw(theme, bounds, cursor)
.draw(state, theme, bounds, cursor)
.into_iter()
.map(Geometry::into_primitive)
.collect(),
@ -245,7 +250,7 @@ where
impl<'a, Message, P, B, T> From<Canvas<Message, T, P>>
for Element<'a, Message, Renderer<B, T>>
where
Message: 'static,
Message: 'a,
P: Program<Message, T> + 'a,
B: Backend,
T: 'a,

6
graphics/src/widget/canvas/cache.rs
View file

@ -1,7 +1,5 @@
use crate::{
canvas::{Frame, Geometry},
Primitive,
};
use crate::widget::canvas::{Frame, Geometry};
use crate::Primitive;
use iced_native::Size;
use std::{cell::RefCell, sync::Arc};

9
graphics/src/widget/canvas/frame.rs
View file

@ -2,11 +2,10 @@ use std::borrow::Cow;
use iced_native::{Point, Rectangle, Size, Vector};
use crate::{
canvas::path,
canvas::{Fill, Geometry, Path, Stroke, Text},
triangle, Primitive,
};
use crate::triangle;
use crate::widget::canvas::path;
use crate::widget::canvas::{Fill, Geometry, Path, Stroke, Text};
use crate::Primitive;
use lyon::tessellation;

2
graphics/src/widget/canvas/path.rs
View file

@ -7,7 +7,7 @@ mod builder;
pub use arc::Arc;
pub use builder::Builder;
use crate::canvas::LineDash;
use crate::widget::canvas::LineDash;
use iced_native::{Point, Size};
use lyon::algorithms::walk::{walk_along_path, RepeatedPattern, WalkerEvent};

2
graphics/src/widget/canvas/path/builder.rs
View file

@ -1,4 +1,4 @@
use crate::canvas::path::{arc, Arc, Path};
use crate::widget::canvas::path::{arc, Arc, Path};
use iced_native::{Point, Size};
use lyon::path::builder::SvgPathBuilder;

34
graphics/src/widget/canvas/program.rs
View file

@ -1,8 +1,7 @@
use crate::canvas::event::{self, Event};
use crate::canvas::{Cursor, Geometry};
use iced_native::mouse;
use iced_native::Rectangle;
use crate::widget::canvas::event::{self, Event};
use crate::widget::canvas::mouse;
use crate::widget::canvas::{Cursor, Geometry};
use crate::Rectangle;
/// The state and logic of a [`Canvas`].
///
@ -11,7 +10,10 @@ use iced_native::Rectangle;
///
/// [`Canvas`]: crate::widget::Canvas
pub trait Program<Message, Theme = iced_native::Theme> {
/// Updates the state of the [`Program`].
/// The internal state mutated by the [`Program`].
type State: Default + 'static;
/// Updates the [`State`](Self::State) of the [`Program`].
///
/// When a [`Program`] is used in a [`Canvas`], the runtime will call this
/// method for each [`Event`].
@ -23,7 +25,8 @@ pub trait Program<Message, Theme = iced_native::Theme> {
///
/// [`Canvas`]: crate::widget::Canvas
fn update(
&mut self,
&self,
_state: &mut Self::State,
_event: Event,
_bounds: Rectangle,
_cursor: Cursor,
@ -40,6 +43,7 @@ pub trait Program<Message, Theme = iced_native::Theme> {
/// [`Cache`]: crate::widget::canvas::Cache
fn draw(
&self,
state: &Self::State,
theme: &Theme,
bounds: Rectangle,
cursor: Cursor,
@ -53,6 +57,7 @@ pub trait Program<Message, Theme = iced_native::Theme> {
/// [`Canvas`]: crate::widget::Canvas
fn mouse_interaction(
&self,
_state: &Self::State,
_bounds: Rectangle,
_cursor: Cursor,
) -> mouse::Interaction {
@ -60,33 +65,38 @@ pub trait Program<Message, Theme = iced_native::Theme> {
}
}
impl<T, Message, Theme> Program<Message, Theme> for &mut T
impl<Message, Theme, T> Program<Message, Theme> for &T
where
T: Program<Message, Theme>,
{
type State = T::State;
fn update(
&mut self,
&self,
state: &mut Self::State,
event: Event,
bounds: Rectangle,
cursor: Cursor,
) -> (event::Status, Option<Message>) {
T::update(self, event, bounds, cursor)
T::update(self, state, event, bounds, cursor)
}
fn draw(
&self,
state: &Self::State,
theme: &Theme,
bounds: Rectangle,
cursor: Cursor,
) -> Vec<Geometry> {
T::draw(self, theme, bounds, cursor)
T::draw(self, state, theme, bounds, cursor)
}
fn mouse_interaction(
&self,
state: &Self::State,
bounds: Rectangle,
cursor: Cursor,
) -> mouse::Interaction {
T::mouse_interaction(self, bounds, cursor)
T::mouse_interaction(self, state, bounds, cursor)
}
}

102
graphics/src/widget/pure/canvas/program.rs
View file

@ -1,102 +0,0 @@
use crate::widget::pure::canvas::event::{self, Event};
use crate::widget::pure::canvas::mouse;
use crate::widget::pure::canvas::{Cursor, Geometry};
use crate::Rectangle;
/// The state and logic of a [`Canvas`].
///
/// A [`Program`] can mutate internal state and produce messages for an
/// application.
///
/// [`Canvas`]: crate::widget::Canvas
pub trait Program<Message, Theme = iced_native::Theme> {
/// The internal state mutated by the [`Program`].
type State: Default + 'static;
/// Updates the [`State`](Self::State) of the [`Program`].
///
/// When a [`Program`] is used in a [`Canvas`], the runtime will call this
/// method for each [`Event`].
///
/// This method can optionally return a `Message` to notify an application
/// of any meaningful interactions.
///
/// By default, this method does and returns nothing.
///
/// [`Canvas`]: crate::widget::Canvas
fn update(
&self,
_state: &mut Self::State,
_event: Event,
_bounds: Rectangle,
_cursor: Cursor,
) -> (event::Status, Option<Message>) {
(event::Status::Ignored, None)
}
/// Draws the state of the [`Program`], producing a bunch of [`Geometry`].
///
/// [`Geometry`] can be easily generated with a [`Frame`] or stored in a
/// [`Cache`].
///
/// [`Frame`]: crate::widget::canvas::Frame
/// [`Cache`]: crate::widget::canvas::Cache
fn draw(
&self,
state: &Self::State,
theme: &Theme,
bounds: Rectangle,
cursor: Cursor,
) -> Vec<Geometry>;
/// Returns the current mouse interaction of the [`Program`].
///
/// The interaction returned will be in effect even if the cursor position
/// is out of bounds of the program's [`Canvas`].
///
/// [`Canvas`]: crate::widget::Canvas
fn mouse_interaction(
&self,
_state: &Self::State,
_bounds: Rectangle,
_cursor: Cursor,
) -> mouse::Interaction {
mouse::Interaction::default()
}
}
impl<Message, Theme, T> Program<Message, Theme> for &T
where
T: Program<Message, Theme>,
{
type State = T::State;
fn update(
&self,
state: &mut Self::State,
event: Event,
bounds: Rectangle,
cursor: Cursor,
) -> (event::Status, Option<Message>) {
T::update(self, state, event, bounds, cursor)
}
fn draw(
&self,
state: &Self::State,
theme: &Theme,
bounds: Rectangle,
cursor: Cursor,
) -> Vec<Geometry> {
T::draw(self, state, theme, bounds, cursor)
}
fn mouse_interaction(
&self,
state: &Self::State,
bounds: Rectangle,
cursor: Cursor,
) -> mouse::Interaction {
T::mouse_interaction(self, state, bounds, cursor)
}
}

4
graphics/src/widget/qr_code.rs
View file

@ -1,9 +1,10 @@
//! Encode and display information in a QR code.
use crate::canvas;
use crate::renderer::{self, Renderer};
use crate::widget::canvas;
use crate::Backend;
use iced_native::layout;
use iced_native::widget::Tree;
use iced_native::{
Color, Element, Layout, Length, Point, Rectangle, Size, Vector, Widget,
};
@ -72,6 +73,7 @@ where
fn draw(
&self,
_state: &Tree,
renderer: &mut Renderer<B, T>,
_theme: &T,
_style: &renderer::Style,