Skip to main content

PanZoomView

Struct PanZoomView 

Source
pub struct PanZoomView<State>
where State: 'static,
{ /* private fields */ }
Expand description

A pan/zoom viewport over one child — a node-and-edge graph, a map, a large image — without hand-rolling the gesture math. pan_zoom lays its child out at its natural size and places it under a scale-then-translate transform (PanZoomTransform) the user drives: primary drag pans (unless the child claims the press), a touch pinch or a desktop ctrl/⌘+wheel and trackpad pinch zooms about the gesture’s focal point, clamped to .min_scale/.max_scale. A plain wheel still reaches the child, and the child sees its own unscaled local coordinates at any zoom. Flat-re-exported from frust-widgets so app code never names that crate directly; see PanZoomView’s own doc for the full contract (.inertia glide, .on_transform notification, and the PanZoomController handle’s jump_to/fit_to_bounds/fit_rect).

use frust::authoring::{PaintCtx, PaintScene};
use frust::{AnyView, Component, PanZoomController, PanZoomTransform, any, canvas, pan_zoom};
use kurbo::{Point, Size};
use peniko::Color;

#[derive(Default)]
struct Board;

struct BoardState {
    zoom: PanZoomController,
    transform: PanZoomTransform,
}

impl Component for Board {
    type State = BoardState;

    fn init(&self) -> Self::State {
        BoardState {
            zoom: PanZoomController::new(),
            transform: PanZoomTransform::IDENTITY,
        }
    }

    fn build(&self, state: &mut Self::State) -> AnyView<Self::State> {
        let board = canvas(|scene: &mut dyn PaintScene, size: Size, _ctx: &PaintCtx| {
            scene.fill_rect(Point::ZERO, size, Color::from_rgb8(0x20, 0x20, 0x20));
        })
        .size(Size::new(2000.0, 1500.0));
        any(pan_zoom(board)
            .max_scale(4.0)
            .inertia(true)
            .controller(state.zoom.clone())
            .on_transform(|state: &mut BoardState, t| state.transform = t))
    }
}

frust::app!(Board);

A declarative pan/zoom container. See the module docs.

Implementations§

Source§

impl<State> PanZoomView<State>
where State: 'static,

Source

pub fn min_scale(self, scale: f64) -> PanZoomView<State>

The smallest scale a zoom may reach (default DEFAULT_MIN_SCALE). Non-positive or non-finite values are ignored.

Source

pub fn max_scale(self, scale: f64) -> PanZoomView<State>

The largest scale a zoom may reach (default DEFAULT_MAX_SCALE). Non-positive or non-finite values are ignored.

Source

pub fn inertia(self, inertia: bool) -> PanZoomView<State>

Let a released pan glide to rest (default false).

Source

pub fn on_transform<F>(self, on_transform: F) -> PanZoomView<State>
where F: Fn(&mut State, PanZoomTransform) + 'static,

Run on_transform(state, transform) after every change to the transform (see the module docs).

Source

pub fn controller(self, controller: PanZoomController) -> PanZoomView<State>

Trait Implementations§

Source§

impl<State> View<State> for PanZoomView<State>
where State: 'static,

Source§

type Element = PanZoomWidget

The retained widget this view produces.
Source§

fn build(&self, ctx: &mut BuildCtx<'_>) -> PanZoomWidget

Materialise a fresh widget for this view.
Source§

fn rebuild( &self, prev: &PanZoomView<State>, element: &mut PanZoomWidget, ctx: &mut BuildCtx<'_>, ) -> ChangeFlags

Reconcile prev (the previous view of the same type) against the live element, mutating it in place and reporting what changed.
Source§

fn teardown(&self, element: &mut PanZoomWidget, ctx: &mut BuildCtx<'_>)

Tear down element when this view is being removed. Read more
Source§

fn message(&self, _element: &mut Self::Element, _state: &mut State)

Deliver an event message to this view, mutating application state. Read more

Auto Trait Implementations§

§

impl<State> !RefUnwindSafe for PanZoomView<State>

§

impl<State> !Send for PanZoomView<State>

§

impl<State> !Sync for PanZoomView<State>

§

impl<State> !UnwindSafe for PanZoomView<State>

§

impl<State> Freeze for PanZoomView<State>

§

impl<State> Unpin for PanZoomView<State>

§

impl<State> UnsafeUnpin for PanZoomView<State>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more