rename to image::Viewer
This commit is contained in:
parent
431171f975
commit
5d045c2e9a
9 changed files with 50 additions and 73 deletions
|
|
@ -25,7 +25,6 @@ pub mod checkbox;
|
||||||
pub mod column;
|
pub mod column;
|
||||||
pub mod container;
|
pub mod container;
|
||||||
pub mod image;
|
pub mod image;
|
||||||
pub mod image_viewer;
|
|
||||||
pub mod pane_grid;
|
pub mod pane_grid;
|
||||||
pub mod progress_bar;
|
pub mod progress_bar;
|
||||||
pub mod radio;
|
pub mod radio;
|
||||||
|
|
@ -48,8 +47,6 @@ pub use container::Container;
|
||||||
#[doc(no_inline)]
|
#[doc(no_inline)]
|
||||||
pub use image::Image;
|
pub use image::Image;
|
||||||
#[doc(no_inline)]
|
#[doc(no_inline)]
|
||||||
pub use image_viewer::ImageViewer;
|
|
||||||
#[doc(no_inline)]
|
|
||||||
pub use pane_grid::PaneGrid;
|
pub use pane_grid::PaneGrid;
|
||||||
#[doc(no_inline)]
|
#[doc(no_inline)]
|
||||||
pub use progress_bar::ProgressBar;
|
pub use progress_bar::ProgressBar;
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,7 @@
|
||||||
//! Display images in your user interface.
|
//! Display images in your user interface.
|
||||||
|
pub mod viewer;
|
||||||
|
pub use viewer::{State, Viewer};
|
||||||
|
|
||||||
use crate::{layout, Element, Hasher, Layout, Length, Point, Size, Widget};
|
use crate::{layout, Element, Hasher, Layout, Length, Point, Size, Widget};
|
||||||
|
|
||||||
use std::{
|
use std::{
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ use std::{f32, hash::Hash, u32};
|
||||||
|
|
||||||
/// A widget that can display an image with the ability to zoom in/out and pan.
|
/// A widget that can display an image with the ability to zoom in/out and pan.
|
||||||
#[allow(missing_debug_implementations)]
|
#[allow(missing_debug_implementations)]
|
||||||
pub struct ImageViewer<'a> {
|
pub struct Viewer<'a> {
|
||||||
state: &'a mut State,
|
state: &'a mut State,
|
||||||
padding: u16,
|
padding: u16,
|
||||||
width: Length,
|
width: Length,
|
||||||
|
|
@ -18,14 +18,14 @@ pub struct ImageViewer<'a> {
|
||||||
handle: image::Handle,
|
handle: image::Handle,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a> ImageViewer<'a> {
|
impl<'a> Viewer<'a> {
|
||||||
/// Creates a new [`ImageViewer`] with the given [`State`] and [`Handle`].
|
/// Creates a new [`Viewer`] with the given [`State`] and [`Handle`].
|
||||||
///
|
///
|
||||||
/// [`ImageViewer`]: struct.ImageViewer.html
|
/// [`Viewer`]: struct.Viewer.html
|
||||||
/// [`State`]: struct.State.html
|
/// [`State`]: struct.State.html
|
||||||
/// [`Handle`]: ../image/struct.Handle.html
|
/// [`Handle`]: ../../image/struct.Handle.html
|
||||||
pub fn new(state: &'a mut State, handle: image::Handle) -> Self {
|
pub fn new(state: &'a mut State, handle: image::Handle) -> Self {
|
||||||
ImageViewer {
|
Viewer {
|
||||||
state,
|
state,
|
||||||
padding: 0,
|
padding: 0,
|
||||||
width: Length::Shrink,
|
width: Length::Shrink,
|
||||||
|
|
@ -36,48 +36,48 @@ impl<'a> ImageViewer<'a> {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Sets the padding of the [`ImageViewer`].
|
/// Sets the padding of the [`Viewer`].
|
||||||
///
|
///
|
||||||
/// [`ImageViewer`]: struct.ImageViewer.html
|
/// [`Viewer`]: struct.Viewer.html
|
||||||
pub fn padding(mut self, units: u16) -> Self {
|
pub fn padding(mut self, units: u16) -> Self {
|
||||||
self.padding = units;
|
self.padding = units;
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Sets the width of the [`ImageViewer`].
|
/// Sets the width of the [`Viewer`].
|
||||||
///
|
///
|
||||||
/// [`ImageViewer`]: struct.ImageViewer.html
|
/// [`Viewer`]: struct.Viewer.html
|
||||||
pub fn width(mut self, width: Length) -> Self {
|
pub fn width(mut self, width: Length) -> Self {
|
||||||
self.width = width;
|
self.width = width;
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Sets the height of the [`ImageViewer`].
|
/// Sets the height of the [`Viewer`].
|
||||||
///
|
///
|
||||||
/// [`ImageViewer`]: struct.ImageViewer.html
|
/// [`Viewer`]: struct.Viewer.html
|
||||||
pub fn height(mut self, height: Length) -> Self {
|
pub fn height(mut self, height: Length) -> Self {
|
||||||
self.height = height;
|
self.height = height;
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Sets the max width of the [`ImageViewer`].
|
/// Sets the max width of the [`Viewer`].
|
||||||
///
|
///
|
||||||
/// [`ImageViewer`]: struct.ImageViewer.html
|
/// [`Viewer`]: struct.Viewer.html
|
||||||
pub fn max_width(mut self, max_width: u32) -> Self {
|
pub fn max_width(mut self, max_width: u32) -> Self {
|
||||||
self.max_width = max_width;
|
self.max_width = max_width;
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Sets the max height of the [`ImageViewer`].
|
/// Sets the max height of the [`Viewer`].
|
||||||
///
|
///
|
||||||
/// [`ImageViewer`]: struct.ImageViewer.html
|
/// [`Viewer`]: struct.Viewer.html
|
||||||
pub fn max_height(mut self, max_height: u32) -> Self {
|
pub fn max_height(mut self, max_height: u32) -> Self {
|
||||||
self.max_height = max_height;
|
self.max_height = max_height;
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a, Message, Renderer> Widget<Message, Renderer> for ImageViewer<'a>
|
impl<'a, Message, Renderer> Widget<Message, Renderer> for Viewer<'a>
|
||||||
where
|
where
|
||||||
Renderer: self::Renderer + image::Renderer,
|
Renderer: self::Renderer + image::Renderer,
|
||||||
{
|
{
|
||||||
|
|
@ -263,9 +263,9 @@ where
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The local state of an [`ImageViewer`].
|
/// The local state of a [`Viewer`].
|
||||||
///
|
///
|
||||||
/// [`ImageViewer`]: struct.ImageViewer.html
|
/// [`Viewer`]: struct.Viewer.html
|
||||||
#[derive(Debug, Clone, Copy, Default)]
|
#[derive(Debug, Clone, Copy, Default)]
|
||||||
pub struct State {
|
pub struct State {
|
||||||
scale: Option<f32>,
|
scale: Option<f32>,
|
||||||
|
|
@ -283,9 +283,9 @@ impl State {
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Apply a panning offset to the current [`State`], given the bounds of
|
/// Apply a panning offset to the current [`State`], given the bounds of
|
||||||
/// the [`ImageViewer`] and its image.
|
/// the [`Viewer`] and its image.
|
||||||
///
|
///
|
||||||
/// [`ImageViewer`]: struct.ImageViewer.html
|
/// [`Viewer`]: struct.Viewer.html
|
||||||
/// [`State`]: struct.State.html
|
/// [`State`]: struct.State.html
|
||||||
fn pan(
|
fn pan(
|
||||||
&mut self,
|
&mut self,
|
||||||
|
|
@ -311,9 +311,9 @@ impl State {
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns the current clipping offset of the [`State`], given the bounds
|
/// Returns the current clipping offset of the [`State`], given the bounds
|
||||||
/// of the [`ImageViewer`] and its contents.
|
/// of the [`Viewer`] and its contents.
|
||||||
///
|
///
|
||||||
/// [`ImageViewer`]: struct.ImageViewer.html
|
/// [`Viewer`]: struct.Viewer.html
|
||||||
/// [`State`]: struct.State.html
|
/// [`State`]: struct.State.html
|
||||||
fn offset(&self, bounds: Rectangle, image_bounds: Rectangle) -> (u32, u32) {
|
fn offset(&self, bounds: Rectangle, image_bounds: Rectangle) -> (u32, u32) {
|
||||||
let hidden_width = ((image_bounds.width - bounds.width) as f32)
|
let hidden_width = ((image_bounds.width - bounds.width) as f32)
|
||||||
|
|
@ -331,36 +331,36 @@ impl State {
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns if the left mouse button is still held down since clicking inside
|
/// Returns if the left mouse button is still held down since clicking inside
|
||||||
/// the [`ImageViewer`].
|
/// the [`Viewer`].
|
||||||
///
|
///
|
||||||
/// [`ImageViewer`]: struct.ImageViewer.html
|
/// [`Viewer`]: struct.Viewer.html
|
||||||
/// [`State`]: struct.State.html
|
/// [`State`]: struct.State.html
|
||||||
pub fn is_cursor_clicked(&self) -> bool {
|
pub fn is_cursor_clicked(&self) -> bool {
|
||||||
self.starting_cursor_pos.is_some()
|
self.starting_cursor_pos.is_some()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The renderer of an [`ImageViewer`].
|
/// The renderer of an [`Viewer`].
|
||||||
///
|
///
|
||||||
/// Your [renderer] will need to implement this trait before being
|
/// Your [renderer] will need to implement this trait before being
|
||||||
/// able to use a [`ImageViewer`] in your user interface.
|
/// able to use a [`Viewer`] in your user interface.
|
||||||
///
|
///
|
||||||
/// [`ImageViewer`]: struct.ImageViewer.html
|
/// [`Viewer`]: struct.Viewer.html
|
||||||
/// [renderer]: ../../renderer/index.html
|
/// [renderer]: ../../../renderer/index.html
|
||||||
pub trait Renderer: crate::Renderer + Sized {
|
pub trait Renderer: crate::Renderer + Sized {
|
||||||
/// Draws the [`ImageViewer`].
|
/// Draws the [`Viewer`].
|
||||||
///
|
///
|
||||||
/// It receives:
|
/// It receives:
|
||||||
/// - the [`State`] of the [`ImageViewer`]
|
/// - the [`State`] of the [`Viewer`]
|
||||||
/// - the bounds of the [`ImageViewer`] widget
|
/// - the bounds of the [`Viewer`] widget
|
||||||
/// - the bounds of the scaled [`ImageViewer`] image
|
/// - the bounds of the scaled [`Viewer`] image
|
||||||
/// - the clipping x,y offset
|
/// - the clipping x,y offset
|
||||||
/// - the [`Handle`] to the underlying image
|
/// - the [`Handle`] to the underlying image
|
||||||
/// - whether the mouse is over the [`ImageViewer`] or not
|
/// - whether the mouse is over the [`Viewer`] or not
|
||||||
///
|
///
|
||||||
/// [`ImageViewer`]: struct.ImageViewer.html
|
/// [`Viewer`]: struct.Viewer.html
|
||||||
/// [`State`]: struct.State.html
|
/// [`State`]: struct.State.html
|
||||||
/// [`Handle`]: ../image/struct.Handle.html
|
/// [`Handle`]: ../../image/struct.Handle.html
|
||||||
fn draw(
|
fn draw(
|
||||||
&mut self,
|
&mut self,
|
||||||
state: &State,
|
state: &State,
|
||||||
|
|
@ -372,13 +372,12 @@ pub trait Renderer: crate::Renderer + Sized {
|
||||||
) -> Self::Output;
|
) -> Self::Output;
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'a, Message, Renderer> From<ImageViewer<'a>>
|
impl<'a, Message, Renderer> From<Viewer<'a>> for Element<'a, Message, Renderer>
|
||||||
for Element<'a, Message, Renderer>
|
|
||||||
where
|
where
|
||||||
Renderer: 'a + self::Renderer + image::Renderer,
|
Renderer: 'a + self::Renderer + image::Renderer,
|
||||||
Message: 'a,
|
Message: 'a,
|
||||||
{
|
{
|
||||||
fn from(viewer: ImageViewer<'a>) -> Element<'a, Message, Renderer> {
|
fn from(viewer: Viewer<'a>) -> Element<'a, Message, Renderer> {
|
||||||
Element::new(viewer)
|
Element::new(viewer)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
@ -30,8 +30,7 @@ mod platform {
|
||||||
#[cfg_attr(docsrs, doc(cfg(feature = "image")))]
|
#[cfg_attr(docsrs, doc(cfg(feature = "image")))]
|
||||||
pub mod image {
|
pub mod image {
|
||||||
//! Display images in your user interface.
|
//! Display images in your user interface.
|
||||||
pub use iced_winit::image::{Handle, Image};
|
pub use iced_winit::image::{Handle, Image, State, Viewer};
|
||||||
pub use iced_winit::image_viewer::{ImageViewer, State};
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg_attr(docsrs, doc(cfg(feature = "svg")))]
|
#[cfg_attr(docsrs, doc(cfg(feature = "svg")))]
|
||||||
|
|
@ -44,16 +43,9 @@ mod platform {
|
||||||
|
|
||||||
#[doc(no_inline)]
|
#[doc(no_inline)]
|
||||||
pub use {
|
pub use {
|
||||||
button::Button,
|
button::Button, checkbox::Checkbox, container::Container, image::Image,
|
||||||
checkbox::Checkbox,
|
pane_grid::PaneGrid, progress_bar::ProgressBar, radio::Radio,
|
||||||
container::Container,
|
scrollable::Scrollable, slider::Slider, svg::Svg,
|
||||||
image::{Image, ImageViewer},
|
|
||||||
pane_grid::PaneGrid,
|
|
||||||
progress_bar::ProgressBar,
|
|
||||||
radio::Radio,
|
|
||||||
scrollable::Scrollable,
|
|
||||||
slider::Slider,
|
|
||||||
svg::Svg,
|
|
||||||
text_input::TextInput,
|
text_input::TextInput,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -17,5 +17,3 @@ mod svg;
|
||||||
|
|
||||||
#[cfg(feature = "image")]
|
#[cfg(feature = "image")]
|
||||||
mod image;
|
mod image;
|
||||||
#[cfg(feature = "image")]
|
|
||||||
mod image_viewer;
|
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,5 @@
|
||||||
|
mod viewer;
|
||||||
|
|
||||||
use crate::{Primitive, Renderer};
|
use crate::{Primitive, Renderer};
|
||||||
use iced_native::{image, mouse, Layout};
|
use iced_native::{image, mouse, Layout};
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,10 +1,10 @@
|
||||||
use crate::{Primitive, Renderer};
|
use crate::{Primitive, Renderer};
|
||||||
use iced_native::{image, image_viewer, mouse, Rectangle, Vector};
|
use iced_native::{image, mouse, Rectangle, Vector};
|
||||||
|
|
||||||
impl image_viewer::Renderer for Renderer {
|
impl image::viewer::Renderer for Renderer {
|
||||||
fn draw(
|
fn draw(
|
||||||
&mut self,
|
&mut self,
|
||||||
state: &image_viewer::State,
|
state: &image::State,
|
||||||
bounds: Rectangle,
|
bounds: Rectangle,
|
||||||
image_bounds: Rectangle,
|
image_bounds: Rectangle,
|
||||||
offset: (u32, u32),
|
offset: (u32, u32),
|
||||||
|
|
@ -47,11 +47,3 @@ pub mod canvas;
|
||||||
#[cfg(feature = "canvas")]
|
#[cfg(feature = "canvas")]
|
||||||
#[doc(no_inline)]
|
#[doc(no_inline)]
|
||||||
pub use canvas::Canvas;
|
pub use canvas::Canvas;
|
||||||
|
|
||||||
#[cfg(feature = "image")]
|
|
||||||
#[doc(no_inline)]
|
|
||||||
pub mod image_viewer;
|
|
||||||
|
|
||||||
#[cfg(feature = "image")]
|
|
||||||
#[doc(no_inline)]
|
|
||||||
pub use image_viewer::ImageViewer;
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +0,0 @@
|
||||||
//! Zoom and pan on an image.
|
|
||||||
|
|
||||||
pub use iced_native::image_viewer::State;
|
|
||||||
|
|
||||||
/// A widget that can display an image with the ability to zoom in/out and pan.
|
|
||||||
pub type ImageViewer<'a> = iced_native::ImageViewer<'a>;
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue