zng_wgt_scroll/
node.rs

1//! UI nodes used for building the scroll widget.
2//!
3
4use std::sync::Arc;
5
6use parking_lot::Mutex;
7use zng_app::{
8    access::ACCESS_SCROLL_EVENT,
9    view_process::raw_events::{RAW_MOUSE_INPUT_EVENT, RAW_MOUSE_MOVED_EVENT},
10};
11use zng_color::Rgba;
12use zng_ext_input::{
13    focus::{FOCUS, FOCUS_CHANGED_EVENT},
14    keyboard::{KEY_INPUT_EVENT, Key, KeyState},
15    mouse::{ButtonState, MOUSE_INPUT_EVENT, MOUSE_WHEEL_EVENT, MouseButton, MouseScrollDelta},
16    touch::{TOUCH_TRANSFORM_EVENT, TouchPhase},
17};
18use zng_wgt::prelude::{
19    gradient::{ExtendMode, RenderGradientStop},
20    *,
21};
22use zng_wgt_container::Container;
23use zng_wgt_layer::{AnchorMode, LAYERS, LayerIndex};
24
25use super::cmd::*;
26use super::scroll_properties::*;
27use super::scrollbar::Orientation;
28use super::types::*;
29
30/// The actual content presenter.
31pub fn viewport(child: impl IntoUiNode, mode: impl IntoVar<ScrollMode>, child_align: impl IntoVar<Align>) -> UiNode {
32    let mode = mode.into_var();
33    let child_align = child_align.into_var();
34    let binding_key = FrameValueKey::new_unique();
35
36    let mut viewport_size = PxSize::zero();
37    let mut content_offset = PxVector::zero();
38    let mut content_scale = 1.fct();
39    let mut auto_hide_extra = PxSideOffsets::zero();
40    let mut last_render_offset = PxVector::zero();
41    let mut scroll_info = None;
42    let mut scroll_info = move || {
43        scroll_info
44            .get_or_insert_with(|| WIDGET.info().meta().get_clone(*SCROLL_INFO_ID).unwrap())
45            .clone()
46    };
47
48    match_node(child, move |child, op| match op {
49        UiNodeOp::Init => {
50            WIDGET
51                .sub_var_layout(&mode)
52                .sub_var_layout(&SCROLL_VERTICAL_OFFSET_VAR)
53                .sub_var_layout(&SCROLL_HORIZONTAL_OFFSET_VAR)
54                .sub_var_layout(&SCROLL_SCALE_VAR)
55                .sub_var_layout(&child_align);
56        }
57
58        UiNodeOp::Measure { wm, desired_size } => {
59            let constraints = LAYOUT.constraints();
60            if constraints.is_fill_max().all() {
61                *desired_size = constraints.fill_size();
62                child.delegated();
63                return;
64            }
65
66            let mode = mode.get();
67            let mut child_align = child_align.get();
68            if mode.contains(ScrollMode::VERTICAL) && child_align.is_fill_y() {
69                child_align.y = 0.fct();
70            }
71            if mode.contains(ScrollMode::HORIZONTAL) && child_align.is_fill_x() {
72                child_align.x = 0.fct();
73            }
74
75            let vp_unit = constraints.fill_size();
76            let has_fill_size = !vp_unit.is_empty() && constraints.max_size() == Some(vp_unit);
77            let define_vp_unit = has_fill_size && DEFINE_VIEWPORT_UNIT_VAR.get();
78
79            let mut content_size = LAYOUT.with_constraints(
80                {
81                    let mut c = constraints;
82                    if mode.contains(ScrollMode::VERTICAL) {
83                        c = c.with_unbounded_y();
84                    }
85                    if mode.contains(ScrollMode::HORIZONTAL) {
86                        c = c.with_unbounded_x();
87                    }
88
89                    child_align.child_constraints(c)
90                },
91                || {
92                    if define_vp_unit {
93                        LAYOUT.with_viewport(vp_unit, || child.measure(wm))
94                    } else {
95                        child.measure(wm)
96                    }
97                },
98            );
99
100            if mode.contains(ScrollMode::ZOOM) {
101                let scale = SCROLL_SCALE_VAR.get();
102                content_size.width *= scale;
103                content_size.height *= scale;
104            }
105
106            *desired_size = constraints.fill_size_or(content_size);
107        }
108        UiNodeOp::Layout { wl, final_size } => {
109            let mode = mode.get();
110            let mut child_align = child_align.get();
111            if mode.contains(ScrollMode::VERTICAL) && child_align.is_fill_y() {
112                child_align.y = 0.fct();
113            }
114            if mode.contains(ScrollMode::HORIZONTAL) && child_align.is_fill_x() {
115                child_align.x = 0.fct();
116            }
117
118            let constraints = LAYOUT.constraints();
119            let vp_unit = constraints.fill_size();
120
121            let has_fill_size = !vp_unit.is_empty() && constraints.max_size() == Some(vp_unit);
122            let define_vp_unit = has_fill_size && DEFINE_VIEWPORT_UNIT_VAR.get();
123
124            let joiner_size = scroll_info().joiner_size();
125
126            let mut content_size = LAYOUT.with_constraints(
127                {
128                    let mut c = constraints;
129                    if mode.contains(ScrollMode::VERTICAL) {
130                        c = c.with_unbounded_y();
131                    } else {
132                        // If not scrollable Align::FILL works like normal `Container!` widgets.
133                        // c = c.with_new_min_y(Px(0));
134                        if has_fill_size {
135                            c = c.with_new_max_y(vp_unit.height);
136                        }
137                    }
138                    if mode.contains(ScrollMode::HORIZONTAL) {
139                        c = c.with_unbounded_x();
140                    } else {
141                        // c = c.with_new_min_x(Px(0));
142                        if has_fill_size {
143                            c = c.with_new_max_x(vp_unit.width);
144                        }
145                    }
146
147                    child_align.child_constraints(c)
148                },
149                || {
150                    if define_vp_unit {
151                        LAYOUT.with_viewport(vp_unit, || child.layout(wl))
152                    } else {
153                        child.layout(wl)
154                    }
155                },
156            );
157            let content_original_size = content_size;
158            if mode.contains(ScrollMode::ZOOM) {
159                content_scale = SCROLL_SCALE_VAR.get();
160                content_size.width *= content_scale;
161                content_size.height *= content_scale;
162            } else {
163                content_scale = 1.fct();
164            }
165            let content_size = content_size;
166            let content_scale = content_scale;
167
168            let vp_size = constraints.fill_size_or(content_size);
169            if viewport_size != vp_size {
170                viewport_size = vp_size;
171                SCROLL_VIEWPORT_SIZE_VAR.set(vp_size);
172                WIDGET.render();
173            }
174
175            auto_hide_extra = LAYOUT.with_viewport(vp_size, || {
176                LAYOUT.with_constraints(PxConstraints2d::new_fill_size(vp_size), || {
177                    AUTO_HIDE_EXTRA_VAR.layout_dft(PxSideOffsets::new(vp_size.height, vp_size.width, vp_size.height, vp_size.width))
178                })
179            });
180            auto_hide_extra.top = auto_hide_extra.top.max(Px(0));
181            auto_hide_extra.right = auto_hide_extra.right.max(Px(0));
182            auto_hide_extra.bottom = auto_hide_extra.bottom.max(Px(0));
183            auto_hide_extra.left = auto_hide_extra.left.max(Px(0));
184
185            scroll_info().set_viewport_size(vp_size);
186
187            let align_offset = child_align.child_offset(content_size, viewport_size, LAYOUT.direction());
188
189            let mut ct_offset = PxVector::zero();
190
191            if mode.contains(ScrollMode::VERTICAL) && content_size.height > vp_size.height {
192                let v_offset = SCROLL_VERTICAL_OFFSET_VAR.get();
193                ct_offset.y = (viewport_size.height - content_size.height) * v_offset;
194            } else {
195                ct_offset.y = align_offset.y;
196            }
197            if mode.contains(ScrollMode::HORIZONTAL) && content_size.width > vp_size.width {
198                let h_offset = SCROLL_HORIZONTAL_OFFSET_VAR.get();
199                ct_offset.x = (viewport_size.width - content_size.width) * h_offset;
200            } else {
201                ct_offset.x = align_offset.x;
202            }
203
204            if ct_offset != content_offset {
205                content_offset = ct_offset;
206
207                // check if scrolled using only `render_update` to the end of the `auto_hide_extra` space.
208                let update_only_offset = (last_render_offset - content_offset).abs();
209                const OFFSET_EXTRA: Px = Px(20); // give a margin of error for widgets that render outside bounds.
210                let mut need_full_render = if update_only_offset.y < Px(0) {
211                    update_only_offset.y.abs() + OFFSET_EXTRA > auto_hide_extra.top
212                } else {
213                    update_only_offset.y + OFFSET_EXTRA > auto_hide_extra.bottom
214                };
215                if !need_full_render {
216                    need_full_render = if update_only_offset.x < Px(0) {
217                        update_only_offset.x.abs() + OFFSET_EXTRA > auto_hide_extra.left
218                    } else {
219                        update_only_offset.x + OFFSET_EXTRA > auto_hide_extra.right
220                    };
221                }
222
223                if need_full_render {
224                    // need to render more widgets, `auto_hide_extra` was reached using only `render_update`
225                    WIDGET.render();
226                } else {
227                    WIDGET.render_update();
228                }
229            }
230
231            let v_ratio = viewport_size.height.0 as f32 / content_size.height.0 as f32;
232            let h_ratio = viewport_size.width.0 as f32 / content_size.width.0 as f32;
233
234            SCROLL_VERTICAL_RATIO_VAR.set(v_ratio.fct());
235            SCROLL_HORIZONTAL_RATIO_VAR.set(h_ratio.fct());
236            SCROLL_CONTENT_ORIGINAL_SIZE_VAR.set(content_original_size);
237
238            let full_size = viewport_size + joiner_size;
239
240            SCROLL_VERTICAL_CONTENT_OVERFLOWS_VAR.set(mode.contains(ScrollMode::VERTICAL) && content_size.height > full_size.height);
241            SCROLL_HORIZONTAL_CONTENT_OVERFLOWS_VAR.set(mode.contains(ScrollMode::HORIZONTAL) && content_size.width > full_size.width);
242
243            *final_size = viewport_size;
244
245            scroll_info().set_content(content_offset.to_point(), content_scale, content_original_size);
246        }
247        UiNodeOp::Render { frame } => {
248            scroll_info().set_viewport_transform(*frame.transform());
249            last_render_offset = content_offset;
250
251            let mut culling_rect = PxBox::from_size(viewport_size);
252            culling_rect.min.y -= auto_hide_extra.top;
253            culling_rect.max.x += auto_hide_extra.right;
254            culling_rect.max.y += auto_hide_extra.bottom;
255            culling_rect.min.x -= auto_hide_extra.left;
256            let culling_rect = frame.transform().outer_transformed(culling_rect).unwrap_or(culling_rect).to_rect();
257
258            let transform = if content_scale != 1.fct() {
259                PxTransform::scale(content_scale.0, content_scale.0).then_translate(content_offset.cast())
260            } else {
261                content_offset.into()
262            };
263            frame.push_reference_frame(binding_key.into(), binding_key.bind(transform, true), true, false, |frame| {
264                frame.with_auto_hide_rect(culling_rect, |frame| {
265                    child.render(frame);
266                });
267            });
268        }
269        UiNodeOp::RenderUpdate { update } => {
270            scroll_info().set_viewport_transform(*update.transform());
271
272            let transform = if content_scale != 1.fct() {
273                PxTransform::scale(content_scale.0, content_scale.0).then_translate(content_offset.cast())
274            } else {
275                content_offset.into()
276            };
277            update.with_transform(binding_key.update(transform, true), false, |update| {
278                child.render_update(update);
279            });
280        }
281        _ => {}
282    })
283}
284
285/// Create a node that generates and presents the [vertical scrollbar].
286///
287/// [vertical scrollbar]: VERTICAL_SCROLLBAR_FN_VAR
288pub fn v_scrollbar_presenter() -> UiNode {
289    scrollbar_presenter(VERTICAL_SCROLLBAR_FN_VAR, Orientation::Vertical)
290}
291
292/// Create a node that generates and presents the [horizontal scrollbar].
293///
294/// [horizontal scrollbar]: HORIZONTAL_SCROLLBAR_FN_VAR
295pub fn h_scrollbar_presenter() -> UiNode {
296    scrollbar_presenter(HORIZONTAL_SCROLLBAR_FN_VAR, Orientation::Horizontal)
297}
298
299fn scrollbar_presenter(var: impl IntoVar<WidgetFn<ScrollBarArgs>>, orientation: Orientation) -> UiNode {
300    presenter(ScrollBarArgs::new(orientation), var)
301}
302
303/// Create a node that generates and presents the [scrollbar joiner].
304///
305/// [scrollbar joiner]: SCROLLBAR_JOINER_FN_VAR
306pub fn scrollbar_joiner_presenter() -> UiNode {
307    SCROLLBAR_JOINER_FN_VAR.present_data(())
308}
309
310macro_rules! skip_animation {
311    ($skip:expr, $op:expr) => {
312        if $skip {
313            SMOOTH_SCROLLING_VAR.with_context_var(zng_var::ContextInitHandle::current(), false, || $op)
314        } else {
315            $op
316        }
317    };
318}
319
320/// Create a node that implements [`SCROLL_UP_CMD`], [`SCROLL_DOWN_CMD`],
321/// [`SCROLL_LEFT_CMD`] and [`SCROLL_RIGHT_CMD`] scoped on the widget.
322pub fn scroll_commands_node(child: impl IntoUiNode) -> UiNode {
323    let mut up = CommandHandle::dummy();
324    let mut down = CommandHandle::dummy();
325    let mut left = CommandHandle::dummy();
326    let mut right = CommandHandle::dummy();
327
328    let mut layout_line = PxVector::zero();
329
330    match_node(child, move |child, op| match op {
331        UiNodeOp::Init => {
332            WIDGET
333                .sub_var_layout(&VERTICAL_LINE_UNIT_VAR)
334                .sub_var_layout(&HORIZONTAL_LINE_UNIT_VAR);
335
336            let scope = WIDGET.id();
337
338            up = SCROLL_UP_CMD.scoped(scope).subscribe(SCROLL.can_scroll_up().get());
339            down = SCROLL_DOWN_CMD.scoped(scope).subscribe(SCROLL.can_scroll_down().get());
340            left = SCROLL_LEFT_CMD.scoped(scope).subscribe(SCROLL.can_scroll_left().get());
341            right = SCROLL_RIGHT_CMD.scoped(scope).subscribe(SCROLL.can_scroll_right().get());
342        }
343        UiNodeOp::Deinit => {
344            child.deinit();
345
346            up = CommandHandle::dummy();
347            down = CommandHandle::dummy();
348            left = CommandHandle::dummy();
349            right = CommandHandle::dummy();
350        }
351        UiNodeOp::Update { updates } => {
352            child.update(updates);
353
354            if VERTICAL_LINE_UNIT_VAR.is_new() || HORIZONTAL_LINE_UNIT_VAR.is_new() {
355                WIDGET.layout();
356            }
357
358            let scope = WIDGET.id();
359
360            if up.enabled().get() {
361                SCROLL_UP_CMD.scoped(scope).each_update(true, false, |args| {
362                    args.propagation.stop();
363
364                    let mut offset = -layout_line.y;
365                    let args = ScrollRequest::from_args(args).unwrap_or_default();
366                    if args.alternate {
367                        offset *= ALT_FACTOR_VAR.get();
368                    }
369                    skip_animation! {
370                        args.skip_animation,
371                        SCROLL.scroll_vertical_clamp(ScrollFrom::VarTarget(offset), args.clamp.0, args.clamp.1)
372                    }
373                });
374            }
375            if down.enabled().get() {
376                SCROLL_DOWN_CMD.scoped(scope).each_update(true, false, |args| {
377                    args.propagation.stop();
378
379                    let mut offset = layout_line.y;
380                    let args = ScrollRequest::from_args(args).unwrap_or_default();
381                    if args.alternate {
382                        offset *= ALT_FACTOR_VAR.get();
383                    }
384                    skip_animation! {
385                        args.skip_animation,
386                        SCROLL.scroll_vertical_clamp(ScrollFrom::VarTarget(offset), args.clamp.0, args.clamp.1)
387                    }
388                });
389            }
390            if left.enabled().get() {
391                SCROLL_LEFT_CMD.scoped(scope).each_update(true, false, |args| {
392                    args.propagation.stop();
393
394                    let mut offset = -layout_line.x;
395                    let args = ScrollRequest::from_args(args).unwrap_or_default();
396                    if args.alternate {
397                        offset *= ALT_FACTOR_VAR.get();
398                    }
399                    skip_animation! {
400                        args.skip_animation,
401                        SCROLL.scroll_horizontal_clamp(ScrollFrom::VarTarget(offset), args.clamp.0, args.clamp.1)
402                    }
403                });
404            }
405            if right.enabled().get() {
406                SCROLL_RIGHT_CMD.scoped(scope).each_update(true, false, |args| {
407                    args.propagation.stop();
408
409                    let mut offset = layout_line.x;
410                    let args = ScrollRequest::from_args(args).unwrap_or_default();
411                    if args.alternate {
412                        offset *= ALT_FACTOR_VAR.get();
413                    }
414                    skip_animation! {
415                        args.skip_animation,
416                        SCROLL.scroll_horizontal_clamp(ScrollFrom::VarTarget(offset), args.clamp.0, args.clamp.1)
417                    }
418                });
419            }
420        }
421        UiNodeOp::Layout { wl, final_size } => {
422            *final_size = child.layout(wl);
423
424            up.enabled().set(SCROLL.can_scroll_up().get());
425            down.enabled().set(SCROLL.can_scroll_down().get());
426            left.enabled().set(SCROLL.can_scroll_left().get());
427            right.enabled().set(SCROLL.can_scroll_right().get());
428
429            let viewport = SCROLL_VIEWPORT_SIZE_VAR.get();
430            LAYOUT.with_constraints(PxConstraints2d::new_fill_size(viewport), || {
431                layout_line = PxVector::new(
432                    HORIZONTAL_LINE_UNIT_VAR.layout_dft_x(Px(20)),
433                    VERTICAL_LINE_UNIT_VAR.layout_dft_y(Px(20)),
434                );
435            });
436        }
437        _ => {}
438    })
439}
440
441/// Create a node that implements [`PAGE_UP_CMD`], [`PAGE_DOWN_CMD`],
442/// [`PAGE_LEFT_CMD`] and [`PAGE_RIGHT_CMD`] scoped on the widget.
443pub fn page_commands_node(child: impl IntoUiNode) -> UiNode {
444    let mut up = CommandHandle::dummy();
445    let mut down = CommandHandle::dummy();
446    let mut left = CommandHandle::dummy();
447    let mut right = CommandHandle::dummy();
448
449    let mut layout_page = PxVector::zero();
450
451    match_node(child, move |child, op| match op {
452        UiNodeOp::Init => {
453            WIDGET
454                .sub_var_layout(&VERTICAL_PAGE_UNIT_VAR)
455                .sub_var_layout(&HORIZONTAL_PAGE_UNIT_VAR);
456
457            let scope = WIDGET.id();
458
459            up = PAGE_UP_CMD.scoped(scope).subscribe(SCROLL.can_scroll_up().get());
460            down = PAGE_DOWN_CMD.scoped(scope).subscribe(SCROLL.can_scroll_down().get());
461            left = PAGE_LEFT_CMD.scoped(scope).subscribe(SCROLL.can_scroll_left().get());
462            right = PAGE_RIGHT_CMD.scoped(scope).subscribe(SCROLL.can_scroll_right().get());
463        }
464        UiNodeOp::Deinit => {
465            child.deinit();
466
467            up = CommandHandle::dummy();
468            down = CommandHandle::dummy();
469            left = CommandHandle::dummy();
470            right = CommandHandle::dummy();
471        }
472        UiNodeOp::Update { updates } => {
473            child.update(updates);
474
475            let scope = WIDGET.id();
476
477            if up.enabled().get() {
478                PAGE_UP_CMD.scoped(scope).each_update(true, false, |args| {
479                    args.propagation.stop();
480
481                    let mut offset = -layout_page.y;
482                    let args = ScrollRequest::from_args(args).unwrap_or_default();
483                    if args.alternate {
484                        offset *= ALT_FACTOR_VAR.get();
485                    }
486                    skip_animation! {
487                        args.skip_animation,
488                        SCROLL.scroll_vertical_clamp(ScrollFrom::VarTarget(offset), args.clamp.0, args.clamp.1)
489                    }
490                });
491            }
492            if down.enabled().get() {
493                PAGE_DOWN_CMD.scoped(scope).each_update(true, false, |args| {
494                    args.propagation.stop();
495
496                    let mut offset = layout_page.y;
497                    let args = ScrollRequest::from_args(args).unwrap_or_default();
498                    if args.alternate {
499                        offset *= ALT_FACTOR_VAR.get();
500                    }
501                    skip_animation! {
502                        args.skip_animation,
503                        SCROLL.scroll_vertical_clamp(ScrollFrom::VarTarget(offset), args.clamp.0, args.clamp.1)
504                    }
505                });
506            }
507            if left.enabled().get() {
508                PAGE_LEFT_CMD.scoped(scope).each_update(true, false, |args| {
509                    args.propagation.stop();
510
511                    let mut offset = -layout_page.x;
512                    let args = ScrollRequest::from_args(args).unwrap_or_default();
513                    if args.alternate {
514                        offset *= ALT_FACTOR_VAR.get();
515                    }
516                    skip_animation! {
517                        args.skip_animation,
518                        SCROLL.scroll_horizontal_clamp(ScrollFrom::VarTarget(offset), args.clamp.0, args.clamp.1)
519                    }
520                });
521            }
522            if right.enabled().get() {
523                PAGE_RIGHT_CMD.scoped(scope).each_update(true, false, |args| {
524                    args.propagation.stop();
525
526                    let mut offset = layout_page.x;
527                    let args = ScrollRequest::from_args(args).unwrap_or_default();
528                    if args.alternate {
529                        offset *= ALT_FACTOR_VAR.get();
530                    }
531                    skip_animation! {
532                        args.skip_animation,
533                        SCROLL.scroll_horizontal_clamp(ScrollFrom::VarTarget(offset), args.clamp.0, args.clamp.1)
534                    }
535                });
536            }
537        }
538        UiNodeOp::Layout { wl, final_size } => {
539            *final_size = child.layout(wl);
540
541            up.enabled().set(SCROLL.can_scroll_up().get());
542            down.enabled().set(SCROLL.can_scroll_down().get());
543            left.enabled().set(SCROLL.can_scroll_left().get());
544            right.enabled().set(SCROLL.can_scroll_right().get());
545
546            let viewport = SCROLL_VIEWPORT_SIZE_VAR.get();
547            LAYOUT.with_constraints(PxConstraints2d::new_fill_size(viewport), || {
548                layout_page = PxVector::new(
549                    HORIZONTAL_PAGE_UNIT_VAR.layout_dft_x(Px(20)),
550                    VERTICAL_PAGE_UNIT_VAR.layout_dft_y(Px(20)),
551                );
552            });
553        }
554        _ => {}
555    })
556}
557
558/// Create a node that implements [`SCROLL_TO_TOP_CMD`], [`SCROLL_TO_BOTTOM_CMD`],
559/// [`SCROLL_TO_LEFTMOST_CMD`] and [`SCROLL_TO_RIGHTMOST_CMD`] scoped on the widget.
560pub fn scroll_to_edge_commands_node(child: impl IntoUiNode) -> UiNode {
561    let mut top = CommandHandle::dummy();
562    let mut bottom = CommandHandle::dummy();
563    let mut leftmost = CommandHandle::dummy();
564    let mut rightmost = CommandHandle::dummy();
565
566    match_node(child, move |child, op| match op {
567        UiNodeOp::Init => {
568            let scope = WIDGET.id();
569
570            top = SCROLL_TO_TOP_CMD.scoped(scope).subscribe(SCROLL.can_scroll_up().get());
571            bottom = SCROLL_TO_BOTTOM_CMD.scoped(scope).subscribe(SCROLL.can_scroll_down().get());
572            leftmost = SCROLL_TO_LEFTMOST_CMD.scoped(scope).subscribe(SCROLL.can_scroll_left().get());
573            rightmost = SCROLL_TO_RIGHTMOST_CMD.scoped(scope).subscribe(SCROLL.can_scroll_right().get());
574        }
575        UiNodeOp::Deinit => {
576            child.deinit();
577
578            top = CommandHandle::dummy();
579            bottom = CommandHandle::dummy();
580            leftmost = CommandHandle::dummy();
581            rightmost = CommandHandle::dummy();
582        }
583        UiNodeOp::Layout { .. } => {
584            top.enabled().set(SCROLL.can_scroll_up().get());
585            bottom.enabled().set(SCROLL.can_scroll_down().get());
586            leftmost.enabled().set(SCROLL.can_scroll_left().get());
587            rightmost.enabled().set(SCROLL.can_scroll_right().get());
588        }
589        UiNodeOp::Update { updates } => {
590            child.update(updates);
591
592            let scope = WIDGET.id();
593
594            if top.enabled().get() {
595                SCROLL_TO_TOP_CMD.scoped(scope).each_update(true, false, |args| {
596                    args.propagation.stop();
597                    SCROLL.chase_vertical(|_| 0.fct());
598                });
599            }
600            if bottom.enabled().get() {
601                SCROLL_TO_BOTTOM_CMD.scoped(scope).each_update(true, false, |args| {
602                    args.propagation.stop();
603                    SCROLL.chase_vertical(|_| 1.fct());
604                });
605            }
606            if leftmost.enabled().get() {
607                SCROLL_TO_LEFTMOST_CMD.scoped(scope).each_update(true, false, |args| {
608                    args.propagation.stop();
609                    SCROLL.chase_horizontal(|_| 0.fct());
610                });
611            }
612            if rightmost.enabled().get() {
613                SCROLL_TO_RIGHTMOST_CMD.scoped(scope).each_update(true, false, |args| {
614                    args.propagation.stop();
615                    SCROLL.chase_horizontal(|_| 1.fct());
616                });
617            }
618        }
619        _ => {}
620    })
621}
622
623/// Create a node that implements [`ZOOM_IN_CMD`], [`ZOOM_OUT_CMD`], [`ZOOM_TO_FIT_CMD`],
624/// and [`ZOOM_RESET_CMD`] scoped on the widget.
625pub fn zoom_commands_node(child: impl IntoUiNode) -> UiNode {
626    let mut zoom_in = CommandHandle::dummy();
627    let mut zoom_out = CommandHandle::dummy();
628    let mut zoom_to_fit = CommandHandle::dummy();
629    let mut zoom_reset = CommandHandle::dummy();
630
631    let mut scale_delta = 0.fct();
632    let mut origin = Point::default();
633
634    fn fit_scale() -> Factor {
635        let scroll = WIDGET.info().scroll_info().unwrap();
636        let viewport = (scroll.viewport_size() + scroll.joiner_size()).to_f32(); // viewport without scrollbars
637        let content = scroll.content_original_size().max(PxSize::splat(Px(1))).to_f32();
638        let scale = (viewport.width / content.width).min(viewport.height / content.height).fct();
639        match ZOOM_TO_FIT_MODE_VAR.get() {
640            ZoomToFitMode::Contain => scale,
641            ZoomToFitMode::ScaleDown => scale.min(1.fct()),
642        }
643    }
644
645    match_node(child, move |child, op| match op {
646        UiNodeOp::Init => {
647            let scope = WIDGET.id();
648
649            zoom_in = ZOOM_IN_CMD.scoped(scope).subscribe(SCROLL.can_zoom_in());
650            zoom_out = ZOOM_OUT_CMD.scoped(scope).subscribe(SCROLL.can_zoom_out());
651            zoom_to_fit = ZOOM_TO_FIT_CMD.scoped(scope).subscribe(true);
652            zoom_reset = ZOOM_RESET_CMD.scoped(scope).subscribe(true);
653        }
654        UiNodeOp::Deinit => {
655            child.deinit();
656
657            zoom_in = CommandHandle::dummy();
658            zoom_out = CommandHandle::dummy();
659            zoom_to_fit = CommandHandle::dummy();
660            zoom_reset = CommandHandle::dummy();
661        }
662        UiNodeOp::Update { updates } => {
663            child.update(updates);
664
665            let scope = WIDGET.id();
666
667            if zoom_in.enabled().get() {
668                ZOOM_IN_CMD.scoped(scope).each_update(true, false, |args| {
669                    args.propagation.stop();
670
671                    origin = args.param::<Point>().cloned().unwrap_or_default();
672                    scale_delta += ZOOM_WHEEL_UNIT_VAR.get();
673
674                    WIDGET.layout();
675                });
676            }
677            if zoom_out.enabled().get() {
678                ZOOM_OUT_CMD.scoped(scope).each_update(true, false, |args| {
679                    args.propagation.stop();
680
681                    origin = args.param::<Point>().cloned().unwrap_or_default();
682                    scale_delta -= ZOOM_WHEEL_UNIT_VAR.get();
683
684                    WIDGET.layout();
685                });
686            }
687            if zoom_to_fit.enabled().get() {
688                ZOOM_TO_FIT_CMD.scoped(scope).each_update(true, false, |args| {
689                    args.propagation.stop();
690
691                    let scale = fit_scale();
692                    if let Some(p) = ZoomToFitRequest::from_args(args) {
693                        skip_animation! {
694                            p.skip_animation,
695                            SCROLL.chase_zoom(|_| scale)
696                        }
697                    } else {
698                        SCROLL.chase_zoom(|_| scale);
699                    }
700                });
701            }
702            if zoom_reset.enabled().get() {
703                ZOOM_RESET_CMD.scoped(scope).each_update(true, false, |args| {
704                    args.propagation.stop();
705
706                    SCROLL.chase_zoom(|_| 1.fct());
707                    scale_delta = 0.fct();
708                });
709            }
710        }
711        UiNodeOp::Layout { wl, final_size } => {
712            *final_size = child.layout(wl);
713
714            zoom_in.enabled().set(SCROLL.can_zoom_in());
715            zoom_out.enabled().set(SCROLL.can_zoom_out());
716            let scale = SCROLL.zoom_scale().get();
717            zoom_to_fit.enabled().set(scale != fit_scale());
718            zoom_reset.enabled().set(scale != 1.fct());
719
720            if scale_delta != 0.fct() {
721                let scroll_info = WIDGET.info().scroll_info().unwrap();
722                let viewport_size = scroll_info.viewport_size();
723
724                let default = PxPoint::new(
725                    Px(0),
726                    match LAYOUT.direction() {
727                        LayoutDirection::LTR => Px(0),
728                        LayoutDirection::RTL => viewport_size.width,
729                    },
730                );
731                let center_in_viewport =
732                    LAYOUT.with_constraints(PxConstraints2d::new_fill_size(viewport_size), || origin.layout_dft(default));
733
734                SCROLL.zoom(|f| f + scale_delta, center_in_viewport);
735                scale_delta = 0.fct();
736            }
737        }
738        _ => {}
739    })
740}
741
742/// Create a node that implements [`SCROLL_TO_CMD`] scoped on the widget and scroll to focused.
743pub fn scroll_to_node(child: impl IntoUiNode) -> UiNode {
744    let mut _handle = CommandHandle::dummy();
745    let mut scroll_to = None;
746    let mut scroll_to_from_cmd = false;
747
748    match_node(child, move |child, op| match op {
749        UiNodeOp::Init => {
750            _handle = SCROLL_TO_CMD.scoped(WIDGET.id()).subscribe(true);
751            let self_id = WIDGET.id();
752            WIDGET.sub_event_when(&FOCUS_CHANGED_EVENT, move |args| {
753                matches!(&args.new_focus, Some(path) if path.contains(self_id))
754                    && !args.is_enabled_change()
755                    && !args.is_highlight_changed()
756                    && !args.is_focus_leave_enabled(self_id)
757            });
758        }
759        UiNodeOp::Deinit => {
760            _handle = CommandHandle::dummy();
761        }
762        UiNodeOp::Update { .. } => {
763            let self_id = WIDGET.id();
764
765            FOCUS_CHANGED_EVENT.each_update(true, |args| {
766                if let Some(path) = &args.new_focus
767                    && (scroll_to.is_none() || !scroll_to_from_cmd)
768                    && path.contains(self_id)
769                    && path.widget_id() != self_id
770                    && !args.is_enabled_change()
771                    && !args.is_highlight_changed()
772                    && !args.is_focus_leave_enabled(self_id)
773                {
774                    // focus move inside.
775                    if let Some(mode) = SCROLL_TO_FOCUSED_MODE_VAR.get() {
776                        // scroll_to_focused enabled
777
778                        let can_scroll_v = SCROLL.can_scroll_vertical().get();
779                        let can_scroll_h = SCROLL.can_scroll_horizontal().get();
780                        if can_scroll_v || can_scroll_h {
781                            // auto scroll if can scroll AND focus did not change by a click on the
782                            // Scroll! scope restoring focus back to a child AND the target is not already visible.
783
784                            let tree = WINDOW.info();
785                            if let Some(mut target) = tree.get(path.widget_id()) {
786                                let mut is_focus_restore = false;
787
788                                if args.prev_focus.as_ref().map(|p| p.widget_id()) == Some(self_id) {
789                                    // focus moved to child from Scroll! scope (self)
790
791                                    // Check if not caused by a click on a non-focusable child:
792                                    // - On a click in a non-focusable child the focus goes back to the Scroll!.
793                                    // - The Scroll! is a focus scope, it restores the focus to the previous focused child.
794                                    // - The clicked non-focusable becomes the `navigation_origin`.
795                                    // - We don't want to scroll back to the focusable child in this case.
796                                    if let Some(id) = FOCUS.navigation_origin().get()
797                                        && let Some(origin) = tree.get(id)
798                                    {
799                                        for a in origin.ancestors() {
800                                            if a.id() == self_id {
801                                                is_focus_restore = true;
802                                                break;
803                                            }
804                                        }
805                                    }
806                                }
807
808                                if !is_focus_restore {
809                                    for a in target.ancestors() {
810                                        if a.is_scroll() {
811                                            if a.id() == self_id {
812                                                break;
813                                            } else {
814                                                // actually focus move inside an inner scroll,
815                                                // the inner-most scroll scrolls to the target,
816                                                // the outer scrolls scroll to the child scroll.
817                                                target = a;
818                                            }
819                                        }
820                                    }
821
822                                    // check if widget is not large and already visible.
823                                    let mut scroll = true;
824                                    let scroll_bounds = tree.get(self_id).unwrap().inner_bounds();
825                                    let target_bounds = target.inner_bounds();
826                                    if let Some(r) = scroll_bounds.intersection(&target_bounds) {
827                                        let is_large_visible_v =
828                                            can_scroll_v && r.height() > Px(20) && target_bounds.height() > scroll_bounds.height();
829                                        let is_large_visible_h =
830                                            can_scroll_h && r.width() > Px(20) && target_bounds.width() > scroll_bounds.width();
831
832                                        scroll = !is_large_visible_v && !is_large_visible_h;
833                                    }
834                                    if scroll {
835                                        scroll_to = Some((Rect::from(target_bounds), mode, None, false, false));
836                                        WIDGET.layout();
837                                    }
838                                }
839                            }
840                        }
841                    }
842                }
843            });
844
845            SCROLL_TO_CMD.scoped(self_id).each_update(true, false, |args| {
846                // event send to us and enabled
847                if let Some(request) = ScrollToRequest::from_args(args) {
848                    args.propagation.stop();
849
850                    // has unhandled request
851                    let tree = WINDOW.info();
852                    match request.target {
853                        ScrollToTarget::Descendant(target) => {
854                            if let Some(target) = tree.get(target) {
855                                // target exists
856                                if let Some(us) = target.ancestors().find(|w| w.id() == self_id) {
857                                    // target is descendant
858                                    if us.is_scroll() {
859                                        scroll_to = Some((
860                                            Rect::from(target.inner_bounds()),
861                                            request.mode,
862                                            request.zoom,
863                                            false,
864                                            request.skip_animation,
865                                        ));
866                                        scroll_to_from_cmd = true;
867                                        WIDGET.layout();
868
869                                        args.propagation.stop();
870                                    }
871                                }
872                            }
873                        }
874                        ScrollToTarget::Rect(rect) => {
875                            scroll_to = Some((rect, request.mode, request.zoom, true, request.skip_animation));
876                            scroll_to_from_cmd = true;
877                            WIDGET.layout();
878
879                            args.propagation.stop();
880                        }
881                    }
882                }
883            });
884        }
885        UiNodeOp::Layout { wl, final_size } => {
886            *final_size = child.layout(wl);
887
888            if let Some((bounds, mode, mut zoom, in_content, skip_animation)) = scroll_to.take() {
889                scroll_to_from_cmd = false;
890                let tree = WINDOW.info();
891                let us = tree.get(WIDGET.id()).unwrap();
892
893                if let Some(scroll_info) = us.scroll_info() {
894                    if let Some(s) = &mut zoom {
895                        *s = (*s).clamp(SCROLL.actual_min_zoom(), MAX_ZOOM_VAR.get());
896                    }
897
898                    let rendered_content = scroll_info.content();
899
900                    let mut bounds = {
901                        let content = rendered_content;
902                        let mut rect = LAYOUT.with_constraints(PxConstraints2d::new_exact_size(content.size), || bounds.layout());
903                        if in_content {
904                            rect.origin += content.origin.to_vector();
905                        }
906                        rect
907                    };
908
909                    // remove viewport transform
910                    bounds = scroll_info
911                        .viewport_transform()
912                        .inverse()
913                        .and_then(|t| t.outer_transformed(bounds.to_box2d()))
914                        .map(|b| b.to_rect())
915                        .unwrap_or(bounds);
916
917                    let current_bounds = bounds;
918
919                    // remove offset
920                    let rendered_offset = rendered_content.origin.to_vector();
921                    bounds.origin -= rendered_offset;
922
923                    // replace scale
924                    let rendered_scale = SCROLL.rendered_zoom_scale();
925                    if let Some(s) = zoom {
926                        let s = s / rendered_scale;
927                        bounds.origin *= s;
928                        bounds.size *= s;
929                    }
930                    // target bounds is now in the content space at future scale
931
932                    let viewport_size = scroll_info.viewport_size();
933
934                    let mut offset = PxVector::splat(Px::MAX);
935
936                    match mode {
937                        ScrollToMode::Minimal { margin } => {
938                            // add minimal margin at new scale to target bounds
939                            let scaled_margin = LAYOUT.with_constraints(PxConstraints2d::new_fill_size(bounds.size), || margin.layout());
940                            let bounds = inflate_margin(bounds, scaled_margin);
941
942                            // add minimal margin, at current scale to the current bounds
943                            let cur_margin = if zoom.is_some() {
944                                LAYOUT.with_constraints(PxConstraints2d::new_fill_size(current_bounds.size), || margin.layout())
945                            } else {
946                                scaled_margin
947                            };
948                            let current_bounds = inflate_margin(current_bounds, cur_margin);
949
950                            // vertical scroll
951                            if bounds.size.height < viewport_size.height {
952                                if current_bounds.origin.y < Px(0) {
953                                    // scroll up
954                                    offset.y = bounds.origin.y;
955                                } else if current_bounds.max_y() > viewport_size.height {
956                                    // scroll down
957                                    offset.y = bounds.max_y() - viewport_size.height;
958                                } else if zoom.is_some() {
959                                    // scale around center
960                                    let center_in_vp = current_bounds.center().y;
961                                    let center = bounds.center().y;
962                                    offset.y = center - center_in_vp;
963
964                                    // offset minimal if needed
965                                    let mut bounds_final = bounds;
966                                    bounds_final.origin.y -= offset.y;
967                                    if bounds_final.origin.y < Px(0) {
968                                        offset.y = bounds.origin.y;
969                                    } else if bounds_final.max_y() > viewport_size.height {
970                                        offset.y = bounds.max_y() - viewport_size.height;
971                                    }
972                                }
973                            } else {
974                                // center
975                                offset.y = viewport_size.height / Px(2) - bounds.center().y;
976                            };
977
978                            // horizontal scroll
979                            if bounds.size.width < viewport_size.width {
980                                if current_bounds.origin.x < Px(0) {
981                                    // scroll left
982                                    offset.x = bounds.origin.x;
983                                } else if current_bounds.max_x() > viewport_size.width {
984                                    // scroll right
985                                    offset.x = bounds.max_x() - viewport_size.width;
986                                } else if zoom.is_some() {
987                                    // scale around center
988                                    let center_in_vp = current_bounds.center().x;
989                                    let center = bounds.center().x;
990                                    offset.x = center - center_in_vp;
991
992                                    // offset minimal if needed
993                                    let mut bounds_final = bounds;
994                                    bounds_final.origin.x -= offset.x;
995                                    if bounds_final.origin.x < Px(0) {
996                                        offset.x = bounds.origin.x;
997                                    } else if bounds_final.max_x() > viewport_size.width {
998                                        offset.x = bounds.max_x() - viewport_size.width;
999                                    }
1000                                }
1001                            } else {
1002                                // center
1003                                offset.x = viewport_size.width / Px(2) - bounds.center().x;
1004                            };
1005                        }
1006                        ScrollToMode::Center {
1007                            widget_point,
1008                            scroll_point,
1009                        } => {
1010                            // find the two points
1011                            let default = (bounds.size / Px(2)).to_vector().to_point();
1012                            let widget_point =
1013                                LAYOUT.with_constraints(PxConstraints2d::new_fill_size(bounds.size), || widget_point.layout_dft(default));
1014                            let default = (viewport_size / Px(2)).to_vector().to_point();
1015                            let scroll_point =
1016                                LAYOUT.with_constraints(PxConstraints2d::new_fill_size(viewport_size), || scroll_point.layout_dft(default));
1017
1018                            offset = (widget_point + bounds.origin.to_vector()) - scroll_point;
1019                        }
1020                    }
1021
1022                    // scroll range
1023                    let mut content_size = SCROLL.content_size().get();
1024                    if let Some(scale) = zoom {
1025                        content_size *= scale / rendered_scale;
1026                    }
1027                    let max_scroll = content_size - viewport_size;
1028
1029                    // apply
1030                    skip_animation! {
1031                        skip_animation,
1032                        {
1033                            if let Some(scale) = zoom {
1034                        SCROLL.chase_zoom(|_| scale);
1035                    }
1036                    if offset.y != Px::MAX && max_scroll.height > Px(0) {
1037                        let offset_y = offset.y.0 as f32 / max_scroll.height.0 as f32;
1038                        SCROLL.chase_vertical(|_| offset_y.fct());
1039                    }
1040                    if offset.x != Px::MAX && max_scroll.width > Px(0) {
1041                        let offset_x = offset.x.0 as f32 / max_scroll.width.0 as f32;
1042                        SCROLL.chase_horizontal(|_| offset_x.fct());
1043                    }
1044                        }
1045                    }
1046                }
1047            }
1048        }
1049        _ => {}
1050    })
1051}
1052fn inflate_margin(mut r: PxRect, margin: PxSideOffsets) -> PxRect {
1053    r.origin.x -= margin.left;
1054    r.origin.y -= margin.top;
1055    r.size.width += margin.horizontal();
1056    r.size.height += margin.vertical();
1057    r
1058}
1059
1060/// Create a node that implements scroll by touch gestures for the widget.
1061pub fn scroll_touch_node(child: impl IntoUiNode) -> UiNode {
1062    let mut applied_offset = PxVector::zero();
1063    match_node(child, move |child, op| match op {
1064        UiNodeOp::Init => {
1065            WIDGET.sub_event(&TOUCH_TRANSFORM_EVENT);
1066        }
1067        UiNodeOp::Update { updates } => {
1068            child.update(updates);
1069
1070            TOUCH_TRANSFORM_EVENT.each_update(false, |args| {
1071                let mut pending_translate = true;
1072
1073                if SCROLL.mode().get().contains(ScrollMode::ZOOM) {
1074                    let f = args.scale();
1075                    if f != 1.fct() {
1076                        let center = WIDGET
1077                            .info()
1078                            .scroll_info()
1079                            .unwrap()
1080                            .viewport_transform()
1081                            .inverse()
1082                            .and_then(|t| t.transform_point_f32(args.latest_info.center))
1083                            .unwrap_or(args.latest_info.center);
1084
1085                        SCROLL.zoom_touch(args.phase, f, center);
1086                        pending_translate = false;
1087                    }
1088                }
1089
1090                if pending_translate {
1091                    let new_offset = args.translation().cast::<Px>();
1092                    let delta = new_offset - applied_offset;
1093                    applied_offset = new_offset;
1094
1095                    if delta.y != Px(0) {
1096                        SCROLL.scroll_vertical_touch(-delta.y);
1097                    }
1098                    if delta.x != Px(0) {
1099                        SCROLL.scroll_horizontal_touch(-delta.x);
1100                    }
1101                }
1102
1103                match args.phase {
1104                    TouchPhase::Start => {}
1105                    TouchPhase::Move => {}
1106                    TouchPhase::End => {
1107                        applied_offset = PxVector::zero();
1108
1109                        let friction = Dip::new(1000);
1110                        let mode = SCROLL.mode().get();
1111                        if mode.contains(ScrollMode::VERTICAL) {
1112                            let (delta, duration) = args.translation_inertia_y(friction);
1113
1114                            if delta != Px(0) {
1115                                SCROLL.scroll_vertical_touch_inertia(-delta, duration);
1116                            }
1117                            SCROLL.clear_vertical_overscroll();
1118                        }
1119                        if mode.contains(ScrollMode::HORIZONTAL) {
1120                            let (delta, duration) = args.translation_inertia_x(friction);
1121                            if delta != Px(0) {
1122                                SCROLL.scroll_horizontal_touch_inertia(-delta, duration);
1123                            }
1124                            SCROLL.clear_horizontal_overscroll();
1125                        }
1126                    }
1127                    TouchPhase::Cancel => {
1128                        applied_offset = PxVector::zero();
1129
1130                        SCROLL.clear_vertical_overscroll();
1131                        SCROLL.clear_horizontal_overscroll();
1132                    }
1133                }
1134            });
1135        }
1136        _ => {}
1137    })
1138}
1139
1140/// Create a node that implements scroll-wheel handling for the widget.
1141pub fn scroll_wheel_node(child: impl IntoUiNode) -> UiNode {
1142    let mut offset = Vector::zero();
1143    let mut scale_delta = 0.fct();
1144    let mut scale_position = DipPoint::zero();
1145
1146    match_node(child, move |child, op| match op {
1147        UiNodeOp::Init => {
1148            WIDGET.sub_event(&MOUSE_WHEEL_EVENT);
1149        }
1150        UiNodeOp::Update { updates } => {
1151            child.update(updates);
1152
1153            MOUSE_WHEEL_EVENT.each_update(false, |args| {
1154                args.propagation.stop();
1155                if let Some(delta) = args.scroll_delta(ALT_FACTOR_VAR.get()) {
1156                    match delta {
1157                        MouseScrollDelta::LineDelta(x, y) => {
1158                            let scroll_x = if x > 0.0 {
1159                                SCROLL.can_scroll_left().get()
1160                            } else if x < 0.0 {
1161                                SCROLL.can_scroll_right().get()
1162                            } else {
1163                                false
1164                            };
1165                            let scroll_y = if y > 0.0 {
1166                                SCROLL.can_scroll_up().get()
1167                            } else if y < 0.0 {
1168                                SCROLL.can_scroll_down().get()
1169                            } else {
1170                                false
1171                            };
1172
1173                            if scroll_x || scroll_y {
1174                                args.propagation.stop();
1175
1176                                if scroll_x {
1177                                    offset.x -= HORIZONTAL_WHEEL_UNIT_VAR.get() * x.fct();
1178                                }
1179                                if scroll_y {
1180                                    offset.y -= VERTICAL_WHEEL_UNIT_VAR.get() * y.fct();
1181                                }
1182                            }
1183                        }
1184                        MouseScrollDelta::PixelDelta(x, y) => {
1185                            let scroll_x = if x > 0.0 {
1186                                SCROLL.can_scroll_left().get()
1187                            } else if x < 0.0 {
1188                                SCROLL.can_scroll_right().get()
1189                            } else {
1190                                false
1191                            };
1192                            let scroll_y = if y > 0.0 {
1193                                SCROLL.can_scroll_up().get()
1194                            } else if y < 0.0 {
1195                                SCROLL.can_scroll_down().get()
1196                            } else {
1197                                false
1198                            };
1199
1200                            if scroll_x || scroll_y {
1201                                args.propagation.stop();
1202
1203                                if scroll_x {
1204                                    offset.x -= x.px();
1205                                }
1206                                if scroll_y {
1207                                    offset.y -= y.px();
1208                                }
1209                            }
1210                        }
1211                        _ => {}
1212                    }
1213
1214                    WIDGET.layout();
1215                } else if let Some(delta) = args.zoom_delta() {
1216                    if !SCROLL_MODE_VAR.get().contains(ScrollMode::ZOOM) {
1217                        return;
1218                    }
1219
1220                    let delta = match delta {
1221                        MouseScrollDelta::LineDelta(x, y) => {
1222                            if y.abs() > x.abs() {
1223                                ZOOM_WHEEL_UNIT_VAR.get() * y.fct()
1224                            } else {
1225                                ZOOM_WHEEL_UNIT_VAR.get() * x.fct()
1226                            }
1227                        }
1228                        MouseScrollDelta::PixelDelta(x, y) => {
1229                            if y.abs() > x.abs() {
1230                                // 1% per "pixel".
1231                                0.001.fct() * y.fct()
1232                            } else {
1233                                0.001.fct() * x.fct()
1234                            }
1235                        }
1236                        _ => Factor(0.0),
1237                    };
1238
1239                    let apply = if delta > 0.fct() {
1240                        SCROLL.can_zoom_in()
1241                    } else if delta < 0.fct() {
1242                        SCROLL.can_zoom_out()
1243                    } else {
1244                        false
1245                    };
1246
1247                    if apply {
1248                        scale_delta += delta;
1249                        scale_position = args.position;
1250                        WIDGET.layout();
1251                    }
1252                }
1253            });
1254        }
1255        UiNodeOp::Layout { wl, final_size } => {
1256            *final_size = child.layout(wl);
1257
1258            if offset != Vector::zero() {
1259                let viewport = SCROLL_VIEWPORT_SIZE_VAR.get();
1260
1261                LAYOUT.with_constraints(PxConstraints2d::new_fill_size(viewport), || {
1262                    let o = offset.layout_dft(viewport.to_vector());
1263                    offset = Vector::zero();
1264
1265                    if o.y != Px(0) {
1266                        SCROLL.scroll_vertical(ScrollFrom::VarTarget(o.y));
1267                    }
1268                    if o.x != Px(0) {
1269                        SCROLL.scroll_horizontal(ScrollFrom::VarTarget(o.x));
1270                    }
1271                });
1272            }
1273
1274            if scale_delta != 0.fct() {
1275                let scroll_info = WIDGET.info().scroll_info().unwrap();
1276                let default = scale_position.to_px(LAYOUT.scale_factor());
1277                let default = scroll_info
1278                    .viewport_transform()
1279                    .inverse()
1280                    .and_then(|t| t.transform_point(default))
1281                    .unwrap_or(default);
1282
1283                let viewport_size = scroll_info.viewport_size();
1284                let center_in_viewport = LAYOUT.with_constraints(PxConstraints2d::new_fill_size(viewport_size), || {
1285                    ZOOM_WHEEL_ORIGIN_VAR.layout_dft(default)
1286                });
1287
1288                SCROLL.zoom(|f| f + scale_delta, center_in_viewport);
1289                scale_delta = 0.fct();
1290            }
1291        }
1292        _ => {}
1293    })
1294}
1295
1296/// Overscroll visual indicator.
1297pub fn overscroll_node(child: impl IntoUiNode) -> UiNode {
1298    let mut v_rect = PxRect::zero();
1299    let mut v_center = PxPoint::zero();
1300    let mut v_radius_w = Px(0);
1301
1302    let mut h_rect = PxRect::zero();
1303    let mut h_center = PxPoint::zero();
1304    let mut h_radius_h = Px(0);
1305
1306    match_node(child, move |c, op| match op {
1307        UiNodeOp::Init => {
1308            WIDGET
1309                .sub_var_layout(&OVERSCROLL_VERTICAL_OFFSET_VAR)
1310                .sub_var_layout(&OVERSCROLL_HORIZONTAL_OFFSET_VAR);
1311        }
1312        UiNodeOp::Layout { final_size, wl } => {
1313            *final_size = c.layout(wl);
1314
1315            let mut new_v_rect = PxRect::zero();
1316            let v = OVERSCROLL_VERTICAL_OFFSET_VAR.get();
1317            if v < 0.fct() {
1318                // overscroll top
1319                new_v_rect.size = *final_size;
1320                new_v_rect.size.height *= v.abs() / 10.fct();
1321                v_center.y = Px(0);
1322            } else if v > 0.fct() {
1323                // overscroll bottom
1324                new_v_rect.size = *final_size;
1325                new_v_rect.size.height *= v.abs() / 10.fct();
1326                new_v_rect.origin.y = final_size.height - new_v_rect.size.height;
1327                v_center.y = new_v_rect.size.height;
1328            }
1329
1330            let mut new_h_rect = PxRect::zero();
1331            let h = OVERSCROLL_HORIZONTAL_OFFSET_VAR.get();
1332            if h < 0.fct() {
1333                // overscroll left
1334                new_h_rect.size = *final_size;
1335                new_h_rect.size.width *= h.abs() / 10.fct();
1336                h_center.x = Px(0);
1337            } else if h > 0.fct() {
1338                // overscroll right
1339                new_h_rect.size = *final_size;
1340                new_h_rect.size.width *= h.abs() / 10.fct();
1341                new_h_rect.origin.x = final_size.width - new_h_rect.size.width;
1342                h_center.x = new_h_rect.size.width;
1343            }
1344
1345            if new_v_rect != v_rect {
1346                v_rect = new_v_rect;
1347                // 50%
1348                v_center.x = v_rect.size.width / Px(2);
1349                // 110%
1350                let radius = v_center.x;
1351                v_radius_w = radius + radius * 0.1;
1352
1353                WIDGET.render();
1354            }
1355            if new_h_rect != h_rect {
1356                h_rect = new_h_rect;
1357                h_center.y = h_rect.size.height / Px(2);
1358                let radius = h_center.y;
1359                h_radius_h = radius + radius * 0.1;
1360                WIDGET.render();
1361            }
1362        }
1363        UiNodeOp::Render { frame } => {
1364            c.render(frame);
1365
1366            let stops = |color| {
1367                [
1368                    RenderGradientStop { offset: 0.0, color },
1369                    RenderGradientStop { offset: 0.99, color },
1370                    RenderGradientStop {
1371                        offset: 1.0,
1372                        color: {
1373                            let mut c = color;
1374                            c.alpha = 0.0;
1375                            c
1376                        },
1377                    },
1378                ]
1379            };
1380
1381            frame.with_auto_hit_test(false, |frame| {
1382                if !v_rect.size.is_empty() {
1383                    let mut color: Rgba = OVERSCROLL_COLOR_VAR.get();
1384                    color.alpha *= (OVERSCROLL_VERTICAL_OFFSET_VAR.get().abs().0).min(1.0);
1385                    let stops = stops(color);
1386
1387                    let mut radius = v_rect.size;
1388                    radius.width = v_radius_w;
1389                    frame.push_radial_gradient(
1390                        v_rect,
1391                        v_center,
1392                        radius,
1393                        &stops,
1394                        ExtendMode::Clamp.into(),
1395                        PxPoint::zero(),
1396                        v_rect.size,
1397                        PxSize::zero(),
1398                    );
1399                }
1400                if !h_rect.size.is_empty() {
1401                    let mut color: Rgba = OVERSCROLL_COLOR_VAR.get();
1402                    color.alpha *= (OVERSCROLL_HORIZONTAL_OFFSET_VAR.get().abs().0).min(1.0);
1403                    let stops = stops(color);
1404
1405                    let mut radius = h_rect.size;
1406                    radius.height = h_radius_h;
1407                    frame.push_radial_gradient(
1408                        h_rect,
1409                        h_center,
1410                        radius,
1411                        &stops,
1412                        ExtendMode::Clamp.into(),
1413                        PxPoint::zero(),
1414                        h_rect.size,
1415                        PxSize::zero(),
1416                    );
1417                }
1418            });
1419        }
1420        _ => {}
1421    })
1422}
1423
1424/// Create a node that converts [`ACCESS_SCROLL_EVENT`] to command requests.
1425///
1426/// [`ACCESS_SCROLL_EVENT`]: zng_app::access::ACCESS_SCROLL_EVENT
1427pub fn access_scroll_node(child: impl IntoUiNode) -> UiNode {
1428    match_node(child, move |c, op| match op {
1429        UiNodeOp::Init => {
1430            WIDGET.sub_event(&ACCESS_SCROLL_EVENT);
1431        }
1432        UiNodeOp::Update { updates } => {
1433            c.update(updates);
1434
1435            ACCESS_SCROLL_EVENT.each_update(false, |args| {
1436                use zng_app::access::ScrollCmd::*;
1437
1438                let id = WIDGET.id();
1439                if args.target.widget_id() == id {
1440                    match args.command {
1441                        PageUp => PAGE_UP_CMD.scoped(id).notify(),
1442                        PageDown => PAGE_DOWN_CMD.scoped(id).notify(),
1443                        PageLeft => PAGE_LEFT_CMD.scoped(id).notify(),
1444                        PageRight => PAGE_RIGHT_CMD.scoped(id).notify(),
1445                        ScrollToRect(rect) => SCROLL_TO_CMD.scoped(id).notify_param(Rect::from(rect)),
1446
1447                        ScrollTo => {
1448                            // parent scroll handles this
1449                            return;
1450                        }
1451                        _ => return,
1452                    }
1453                    args.propagation.stop();
1454                } else {
1455                    match args.command {
1456                        ScrollTo => super::cmd::scroll_to(args.target.widget_id(), ScrollToMode::minimal(10)),
1457                        ScrollToRect(rect) => super::cmd::scroll_to(args.target.widget_id(), ScrollToMode::minimal_rect(rect)),
1458                        _ => return,
1459                    }
1460                    args.propagation.stop();
1461                }
1462            });
1463        }
1464        _ => {}
1465    })
1466}
1467
1468/// Create a note that spawns the auto scroller on middle click and fulfill `AUTO_SCROLL_CMD` requests.
1469pub fn auto_scroll_node(child: impl IntoUiNode) -> UiNode {
1470    let mut middle_handle = VarHandle::dummy();
1471    let mut cmd_handle = CommandHandle::dummy();
1472    let mut auto_scrolling = None::<(WidgetId, Arc<Mutex<DInstant>>)>;
1473    match_node(child, move |c, op| {
1474        enum Task {
1475            CheckEnable,
1476            Disable,
1477        }
1478        let mut task = None;
1479        match op {
1480            UiNodeOp::Init => {
1481                cmd_handle = AUTO_SCROLL_CMD
1482                    .scoped(WIDGET.id())
1483                    .subscribe(SCROLL.can_scroll_horizontal().get() || SCROLL.can_scroll_vertical().get());
1484                WIDGET.sub_var(&AUTO_SCROLL_VAR);
1485                task = Some(Task::CheckEnable);
1486            }
1487            UiNodeOp::Deinit => {
1488                task = Some(Task::Disable);
1489            }
1490            UiNodeOp::Update { updates } => {
1491                if AUTO_SCROLL_VAR.is_new() {
1492                    task = Some(Task::CheckEnable);
1493                }
1494
1495                c.update(updates);
1496
1497                MOUSE_INPUT_EVENT.each_update(false, |args| {
1498                    if args.is_mouse_down() && matches!(args.button, MouseButton::Middle) && AUTO_SCROLL_VAR.get() {
1499                        args.propagation.stop();
1500
1501                        let mut open = true;
1502                        if let Some((id, closed)) = auto_scrolling.take() {
1503                            let closed = *closed.lock();
1504                            if closed == DInstant::MAX {
1505                                LAYERS.remove(id);
1506                                open = false;
1507                            } else {
1508                                open = closed.elapsed() > 50.ms();
1509                            }
1510                        }
1511                        if open {
1512                            let (wgt, wgt_id, closed) = auto_scroller_wgt();
1513
1514                            let anchor = AnchorMode {
1515                                transform: zng_wgt_layer::AnchorTransform::CursorOnce {
1516                                    offset: zng_wgt_layer::AnchorOffset {
1517                                        place: Point::top_left(),
1518                                        origin: Point::center(),
1519                                    },
1520                                    include_touch: true,
1521                                    bounds: None,
1522                                },
1523                                min_size: zng_wgt_layer::AnchorSize::Unbounded,
1524                                max_size: zng_wgt_layer::AnchorSize::Window,
1525                                viewport_bound: true,
1526                                corner_radius: false,
1527                                visibility: true,
1528                                interactivity: false,
1529                            };
1530                            LAYERS.insert_anchored(LayerIndex::ADORNER, WIDGET.id(), anchor, wgt);
1531                            auto_scrolling = Some((wgt_id, closed));
1532                        }
1533                    }
1534                });
1535
1536                if cmd_handle.enabled().get() {
1537                    AUTO_SCROLL_CMD.scoped(WIDGET.id()).each_update(true, false, |args| {
1538                        args.propagation.stop();
1539
1540                        let acc = args.param::<DipVector>().copied().unwrap_or_else(DipVector::zero);
1541                        SCROLL.auto_scroll(acc)
1542                    });
1543                }
1544            }
1545            UiNodeOp::Layout { wl, final_size } => {
1546                *final_size = c.layout(wl);
1547                cmd_handle
1548                    .enabled()
1549                    .set(SCROLL.can_scroll_horizontal().get() || SCROLL.can_scroll_vertical().get());
1550            }
1551            _ => {}
1552        }
1553
1554        while let Some(t) = task.take() {
1555            match t {
1556                Task::CheckEnable => {
1557                    if AUTO_SCROLL_VAR.get() {
1558                        if middle_handle.is_dummy() {
1559                            middle_handle = MOUSE_INPUT_EVENT.subscribe_when(UpdateOp::Update, WIDGET.id(), |args| {
1560                                args.is_mouse_down() && matches!(args.button, MouseButton::Middle)
1561                            });
1562                        }
1563                    } else {
1564                        task = Some(Task::Disable);
1565                    }
1566                }
1567                Task::Disable => {
1568                    middle_handle = VarHandle::dummy();
1569                    if let Some((wgt_id, closed)) = auto_scrolling.take()
1570                        && *closed.lock() == DInstant::MAX
1571                    {
1572                        LAYERS.remove(wgt_id);
1573                    }
1574                }
1575            }
1576        }
1577    })
1578}
1579
1580fn auto_scroller_wgt() -> (UiNode, WidgetId, Arc<Mutex<DInstant>>) {
1581    let id = WidgetId::new_unique();
1582    let mut wgt = Container::widget_new();
1583    let closed = Arc::new(Mutex::new(DInstant::MAX));
1584    widget_set! {
1585        wgt;
1586        id;
1587        zng_wgt_input::focus::focusable = true;
1588        zng_wgt_input::focus::focus_on_init = true;
1589        zng_wgt_container::child = AUTO_SCROLL_INDICATOR_VAR.present_data(AutoScrollArgs {});
1590    }
1591    wgt.widget_builder().push_build_action(clmv!(closed, |w| {
1592        w.push_intrinsic(
1593            NestGroup::EVENT,
1594            "auto_scroller_node",
1595            clmv!(closed, |c| auto_scroller_node(c, closed)),
1596        );
1597
1598        let mut ctx = LocalContext::capture_filtered(CaptureFilter::context_vars());
1599        let mut set = ContextValueSet::new();
1600        SCROLL.context_values_set(&mut set);
1601        ctx.extend(LocalContext::capture_filtered(CaptureFilter::Include(set)));
1602
1603        w.push_intrinsic(NestGroup::CONTEXT, "scroll-ctx", |c| with_context_blend(ctx, true, c));
1604    }));
1605
1606    (wgt.widget_build(), id, closed)
1607}
1608fn auto_scroller_node(child: impl IntoUiNode, closed: Arc<Mutex<DInstant>>) -> UiNode {
1609    let mut requested_vel = DipVector::zero();
1610    match_node(child, move |_, op| match op {
1611        UiNodeOp::Init => {
1612            // widget is focusable and focus_on_init.
1613
1614            // RAW events to receive move outside widget without capturing pointer.
1615            let win_id = WINDOW.id();
1616            WIDGET
1617                .sub_event_when(&RAW_MOUSE_MOVED_EVENT, move |args| args.window_id == win_id)
1618                .sub_event_when(&RAW_MOUSE_INPUT_EVENT, move |args| {
1619                    args.window_id == win_id && args.state == ButtonState::Pressed && args.button == MouseButton::Middle
1620                });
1621
1622            let id = WIDGET.id();
1623            WIDGET
1624                .sub_event_when(&FOCUS_CHANGED_EVENT, move |args| args.is_blur(id))
1625                .sub_event_when(&KEY_INPUT_EVENT, move |args| {
1626                    args.state == KeyState::Pressed && args.key == Key::Escape
1627                });
1628
1629            requested_vel = DipVector::zero();
1630        }
1631        UiNodeOp::Deinit => {
1632            SCROLL.auto_scroll(DipVector::zero());
1633            *closed.lock() = INSTANT.now();
1634        }
1635        UiNodeOp::Update { .. } => {
1636            RAW_MOUSE_MOVED_EVENT.each_update(true, |args| {
1637                if args.window_id != WINDOW.id() {
1638                    return;
1639                }
1640
1641                let info = WIDGET.info();
1642                let pos = args.position;
1643                let bounds = info.inner_bounds().to_box2d().to_dip(info.tree().scale_factor());
1644                let mut vel = DipVector::zero();
1645
1646                let limit = Dip::new(400);
1647                if pos.x < bounds.min.x {
1648                    if SCROLL.can_scroll_left().get() {
1649                        vel.x = (pos.x - bounds.min.x).max(-limit);
1650                    }
1651                } else if pos.x > bounds.max.x && SCROLL.can_scroll_right().get() {
1652                    vel.x = (pos.x - bounds.max.x).min(limit);
1653                }
1654                if pos.y < bounds.min.y {
1655                    if SCROLL.can_scroll_up().get() {
1656                        vel.y = (pos.y - bounds.min.y).max(-limit);
1657                    }
1658                } else if pos.y > bounds.max.y && SCROLL.can_scroll_down().get() {
1659                    vel.y = (pos.y - bounds.max.y).min(limit);
1660                }
1661                vel *= 6.fct();
1662
1663                if vel != requested_vel {
1664                    SCROLL.auto_scroll(vel);
1665                    requested_vel = vel;
1666                }
1667            });
1668            RAW_MOUSE_INPUT_EVENT.each_update(true, |args| {
1669                if args.window_id == WINDOW.id() && args.state == ButtonState::Pressed && args.button == MouseButton::Middle {
1670                    args.propagation.stop();
1671                    LAYERS.remove(WIDGET.id());
1672                    SCROLL.auto_scroll(DipVector::zero());
1673                }
1674            });
1675
1676            KEY_INPUT_EVENT.each_update(true, |args| {
1677                if matches!((args.state, &args.key), (KeyState::Pressed, Key::Escape)) {
1678                    args.propagation.stop();
1679                    LAYERS.remove(WIDGET.id());
1680                    SCROLL.auto_scroll(DipVector::zero());
1681                }
1682            });
1683
1684            FOCUS_CHANGED_EVENT.each_update(true, |args| {
1685                let id = WIDGET.id();
1686                if args.is_blur(id) {
1687                    LAYERS.remove(id);
1688                    SCROLL.auto_scroll(DipVector::zero());
1689                }
1690            });
1691        }
1692        _ => {}
1693    })
1694}
1695
1696/// Renders a white circle with arrows that indicate what directions can be scrolled.
1697///
1698/// This is the default [`auto_scroll_indicator`].
1699///
1700/// [`auto_scroll_indicator`]: fn@crate::auto_scroll_indicator
1701pub fn default_auto_scroll_indicator() -> UiNode {
1702    match_node_leaf(|op| {
1703        match op {
1704            UiNodeOp::Init => {
1705                // vars used by SCROLL.can_scroll_*.
1706                WIDGET
1707                    .sub_var_render(&SCROLL_VIEWPORT_SIZE_VAR)
1708                    .sub_var_render(&SCROLL_CONTENT_ORIGINAL_SIZE_VAR)
1709                    .sub_var_render(&SCROLL_SCALE_VAR)
1710                    .sub_var_render(&SCROLL_VERTICAL_OFFSET_VAR)
1711                    .sub_var_render(&SCROLL_HORIZONTAL_OFFSET_VAR);
1712            }
1713            UiNodeOp::Measure { desired_size, .. } => {
1714                *desired_size = PxSize::splat(Dip::new(40).to_px(LAYOUT.scale_factor()));
1715            }
1716            UiNodeOp::Layout { final_size, .. } => {
1717                *final_size = PxSize::splat(Dip::new(40).to_px(LAYOUT.scale_factor()));
1718            }
1719            UiNodeOp::Render { frame } => {
1720                let size = PxSize::splat(Dip::new(40).to_px(frame.scale_factor()));
1721                let corners = PxCornerRadius::new_all(size);
1722                // white circle
1723                frame.push_clip_rounded_rect(PxRect::from_size(size), corners, false, false, |frame| {
1724                    frame.push_color(PxRect::from_size(size), colors::WHITE.with_alpha(90.pct()).into());
1725                });
1726                // black border
1727                let widths = Dip::new(1).to_px(frame.scale_factor());
1728                frame.push_border(
1729                    PxRect::from_size(size),
1730                    PxSideOffsets::new_all_same(widths),
1731                    colors::BLACK.with_alpha(80.pct()).into(),
1732                    corners,
1733                );
1734                // black point middle
1735                let pt_size = PxSize::splat(Dip::new(4).to_px(frame.scale_factor()));
1736                frame.push_clip_rounded_rect(
1737                    PxRect::new((size / Px(2) - pt_size / Px(2)).to_vector().to_point(), pt_size),
1738                    PxCornerRadius::new_all(pt_size),
1739                    false,
1740                    false,
1741                    |frame| {
1742                        frame.push_color(PxRect::from_size(size), colors::BLACK.into());
1743                    },
1744                );
1745
1746                // arrow
1747                let ar_size = PxSize::splat(Dip::new(20).to_px(frame.scale_factor()));
1748                let ar_center = ar_size / Px(2);
1749
1750                // center circle
1751                let offset = (size / Px(2) - ar_center).to_vector();
1752
1753                // 45ยบ with origin center
1754                let transform = Transform::new_translate(-ar_center.width, -ar_center.height)
1755                    .rotate(45.deg())
1756                    .translate(ar_center.width + offset.x, ar_center.height + offset.y)
1757                    .layout()
1758                    .into();
1759
1760                let widths = Dip::new(2).to_px(frame.scale_factor());
1761                let arrow_length = Dip::new(7).to_px(frame.scale_factor());
1762                let arrow_size = PxSize::splat(arrow_length);
1763
1764                let mut arrow = |clip| {
1765                    frame.push_reference_frame(SpatialFrameId::new_unique().into(), transform, false, false, |frame| {
1766                        frame.push_clip_rect(clip, false, false, |frame| {
1767                            frame.push_border(
1768                                PxRect::from_size(ar_size),
1769                                PxSideOffsets::new_all_same(widths),
1770                                colors::BLACK.with_alpha(80.pct()).into(),
1771                                PxCornerRadius::zero(),
1772                            );
1773                        });
1774                    });
1775                };
1776                if SCROLL.can_scroll_up().get() {
1777                    arrow(PxRect::from_size(arrow_size));
1778                }
1779                if SCROLL.can_scroll_right().get() {
1780                    arrow(PxRect::new(PxPoint::new(ar_size.width - arrow_length, Px(0)), arrow_size));
1781                }
1782                if SCROLL.can_scroll_down().get() {
1783                    arrow(PxRect::new(
1784                        PxPoint::new(ar_size.width - arrow_length, ar_size.height - arrow_length),
1785                        arrow_size,
1786                    ));
1787                }
1788                if SCROLL.can_scroll_left().get() {
1789                    arrow(PxRect::new(PxPoint::new(Px(0), ar_size.height - arrow_length), arrow_size));
1790                }
1791            }
1792            _ => (),
1793        }
1794    })
1795}