vizia_core 0.4.0

Core components of vizia
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
use std::sync::Arc;

use crate::prelude::*;

pub(crate) const SCROLL_SENSITIVITY: f32 = 20.0;

/// Events for setting the properties of a scroll view.
pub enum ScrollEvent {
    /// Sets the progress of scroll position between 0 and 1 for the x axis
    SetX(f32),
    /// Sets the progress of scroll position between 0 and 1 for the y axis
    SetY(f32),
    /// Adds given progress to scroll position for the x axis and clamps between 0 and 1
    ScrollX(f32),
    /// Adds given progress to scroll position for the y axis and clamps between 0 and 1
    ScrollY(f32),
    /// Sets the size for the inner scroll-content view which holds the content
    ChildGeo(f32, f32),

    ScrollToView(Entity),
}

/// A container a view which allows the user to scroll any overflowed content.
pub struct ScrollView {
    /// Progress of scroll position between 0 and 1 for the x axis
    pub scroll_x: Signal<f32>,
    /// Progress of scroll position between 0 and 1 for the y axis
    pub scroll_y: Signal<f32>,
    /// Callback called when the scrollview is scrolled.
    pub on_scroll: Option<Arc<dyn Fn(&mut EventContext, f32, f32) + Send + Sync>>,
    /// Width of the inner VStack which holds the content (typically bigger than container_width)
    pub inner_width: Signal<f32>,
    /// Height of the inner VStack which holds the content (typically bigger than container_height)
    pub inner_height: Signal<f32>,
    /// Width of the outer `ScrollView` which wraps the inner (typically smaller than inner_width)
    pub container_width: Signal<f32>,
    /// Height of the outer `ScrollView` which wraps the inner (typically smaller than inner_height)
    pub container_height: Signal<f32>,
    /// Whether the scrollbar should move to the cursor when pressed.
    pub scroll_to_cursor: Signal<bool>,
    /// Whether the horizontal scrollbar should be visible.
    pub show_horizontal_scrollbar: Signal<bool>,
    /// Whether the vertical scrollbar should be visible.
    pub show_vertical_scrollbar: Signal<bool>,
}

impl ScrollView {
    fn map_scroll_x_to_physical(scroll_x: f32, direction: Direction) -> f32 {
        if direction == Direction::RightToLeft { 1.0 - scroll_x } else { scroll_x }
    }

    fn map_scroll_x_from_physical(scroll_x: f32, direction: Direction) -> f32 {
        if direction == Direction::RightToLeft { 1.0 - scroll_x } else { scroll_x }
    }

    /// Creates a new [ScrollView].
    pub fn new<F>(cx: &mut Context, content: F) -> Handle<Self>
    where
        F: 'static + FnOnce(&mut Context),
    {
        let scroll_to_cursor = Signal::new(false);
        let scroll_x = Signal::new(0.0_f32);
        let scroll_y = Signal::new(0.0_f32);
        let inner_width = Signal::new(0.0_f32);
        let inner_height = Signal::new(0.0_f32);
        let container_width = Signal::new(0.0_f32);
        let container_height = Signal::new(0.0_f32);
        let show_horizontal_scrollbar = Signal::new(true);
        let show_vertical_scrollbar = Signal::new(true);
        let direction = cx.environment().direction;

        let vertical_ratio: Memo<f32> = Memo::new(move |_| {
            let inner = inner_height.get();
            if inner == 0.0_f32 {
                0.0_f32
            } else {
                (container_height.get() / inner).clamp(0.0_f32, 1.0_f32)
            }
        });

        let horizontal_ratio: Memo<f32> = Memo::new(move |_| {
            let inner = inner_width.get();
            if inner == 0.0_f32 {
                0.0_f32
            } else {
                (container_width.get() / inner).clamp(0.0_f32, 1.0_f32)
            }
        });

        let has_h_scroll = Memo::new(move |_| container_width.get() < inner_width.get());
        let has_v_scroll = Memo::new(move |_| container_height.get() < inner_height.get());

        let horizontal_scrollbar_value: Memo<f32> = Memo::new(move |_| {
            ScrollView::map_scroll_x_to_physical(scroll_x.get(), direction.get())
        });

        let scroll_state = Memo::new(move |_| {
            (
                scroll_x.get(),
                scroll_y.get(),
                inner_width.get(),
                inner_height.get(),
                container_width.get(),
                container_height.get(),
                direction.get(),
            )
        });
        let scroll_state_signal = scroll_state;

        Self {
            scroll_to_cursor,
            scroll_x,
            scroll_y,
            on_scroll: None,
            inner_width,
            inner_height,
            container_width,
            container_height,
            show_horizontal_scrollbar,
            show_vertical_scrollbar,
        }
        .build(cx, move |cx| {
            ScrollContent::new(cx, content);

            Binding::new(cx, show_vertical_scrollbar, move |cx| {
                if show_vertical_scrollbar.get() {
                    Scrollbar::new(
                        cx,
                        scroll_y,
                        vertical_ratio,
                        Orientation::Vertical,
                        |cx, value| {
                            cx.emit(ScrollEvent::SetY(value));
                        },
                    )
                    .position_type(PositionType::Absolute)
                    .scroll_to_cursor(scroll_to_cursor);
                }
            });

            Binding::new(cx, show_horizontal_scrollbar, move |cx| {
                if show_horizontal_scrollbar.get() {
                    Scrollbar::new(
                        cx,
                        horizontal_scrollbar_value,
                        horizontal_ratio,
                        Orientation::Horizontal,
                        |cx, value| {
                            cx.emit(ScrollEvent::SetX(value));
                        },
                    )
                    .position_type(PositionType::Absolute)
                    .scroll_to_cursor(scroll_to_cursor);
                }
            });
        })
        .bind(scroll_state, move |mut handle| {
            let (
                scroll_x,
                scroll_y,
                inner_width,
                inner_height,
                container_width,
                container_height,
                direction,
            ) = scroll_state_signal.get();
            let scale_factor = handle.context().scale_factor();
            let top = ((inner_height - container_height) * scroll_y).round() / scale_factor;
            let physical_scroll_x = ScrollView::map_scroll_x_to_physical(scroll_x, direction);
            let left = ((inner_width - container_width) * physical_scroll_x).round() / scale_factor;
            handle.horizontal_scroll(-left.abs()).vertical_scroll(-top.abs());
        })
        .toggle_class("h-scroll", has_h_scroll)
        .toggle_class("v-scroll", has_v_scroll)
    }

    fn reset(&mut self) {
        if self.inner_width.get() == self.container_width.get() {
            self.scroll_x.set(0.0);
        }

        if self.inner_height.get() == self.container_height.get() {
            self.scroll_y.set(0.0);
        }
    }
}

impl View for ScrollView {
    fn element(&self) -> Option<&'static str> {
        Some("scrollview")
    }

    fn event(&mut self, cx: &mut EventContext, event: &mut Event) {
        event.map(|scroll_update, meta| {
            match scroll_update {
                ScrollEvent::ScrollX(f) => {
                    let delta = if cx.environment().direction.get() == Direction::RightToLeft {
                        -*f
                    } else {
                        *f
                    };
                    self.scroll_x.set((self.scroll_x.get() + delta).clamp(0.0, 1.0));

                    if let Some(callback) = &self.on_scroll {
                        (callback)(cx, self.scroll_x.get(), self.scroll_y.get());
                    }
                }

                ScrollEvent::ScrollY(f) => {
                    self.scroll_y.set((self.scroll_y.get() + *f).clamp(0.0, 1.0));
                    if let Some(callback) = &self.on_scroll {
                        (callback)(cx, self.scroll_x.get(), self.scroll_y.get());
                    }
                }

                ScrollEvent::SetX(f) => {
                    let mapped = ScrollView::map_scroll_x_from_physical(
                        *f,
                        cx.environment().direction.get(),
                    );
                    self.scroll_x.set(mapped);
                    if let Some(callback) = &self.on_scroll {
                        (callback)(cx, self.scroll_x.get(), self.scroll_y.get());
                    }
                }

                ScrollEvent::SetY(f) => {
                    self.scroll_y.set(*f);
                    if let Some(callback) = &self.on_scroll {
                        (callback)(cx, self.scroll_x.get(), self.scroll_y.get());
                    }
                }

                ScrollEvent::ChildGeo(w, h) => {
                    let bounds = cx.bounds();
                    let scale_factor = cx.scale_factor();

                    let mut scroll_x = self.scroll_x.get();
                    let mut scroll_y = self.scroll_y.get();
                    let mut inner_width = self.inner_width.get();
                    let mut inner_height = self.inner_height.get();
                    let mut container_width = self.container_width.get();
                    let mut container_height = self.container_height.get();

                    if inner_width != 0.0 && inner_height != 0.0 {
                        let top =
                            ((inner_height - container_height) * scroll_y).round() / scale_factor;
                        let physical_scroll_x = ScrollView::map_scroll_x_to_physical(
                            scroll_x,
                            cx.environment().direction.get(),
                        );
                        let left = ((inner_width - container_width) * physical_scroll_x).round()
                            / scale_factor;

                        container_width = bounds.width();
                        container_height = bounds.height();
                        inner_width = *w;
                        inner_height = *h;

                        if inner_width != container_width {
                            let physical_scroll_x = ((left * scale_factor)
                                / (inner_width - container_width))
                                .clamp(0.0, 1.0);
                            scroll_x = ScrollView::map_scroll_x_from_physical(
                                physical_scroll_x,
                                cx.environment().direction.get(),
                            );
                        } else {
                            scroll_x = 0.0;
                        }

                        if inner_height != container_height {
                            scroll_y = ((top * scale_factor) / (inner_height - container_height))
                                .clamp(0.0, 1.0);
                        } else {
                            scroll_y = 0.0;
                        }

                        self.scroll_x.set(scroll_x);
                        self.scroll_y.set(scroll_y);
                        self.inner_width.set(inner_width);
                        self.inner_height.set(inner_height);
                        self.container_width.set(container_width);
                        self.container_height.set(container_height);

                        if let Some(callback) = &self.on_scroll {
                            (callback)(cx, self.scroll_x.get(), self.scroll_y.get());
                        }

                        self.reset();
                    }

                    self.inner_width.set(*w);
                    self.inner_height.set(*h);
                    self.reset();
                }

                ScrollEvent::ScrollToView(entity) => {
                    let view_bounds = cx.cache.get_bounds(*entity);

                    let content_bounds = cx.bounds();

                    let direction = cx.environment().direction.get();
                    let mut physical_scroll_x =
                        ScrollView::map_scroll_x_to_physical(self.scroll_x.get(), direction);

                    let dx = content_bounds.right() - view_bounds.right();
                    let dy = content_bounds.bottom() - view_bounds.bottom();

                    // Calculate the scroll position to bring the child into view.
                    if dx < 0.0 {
                        let sx = (-dx / (self.inner_width.get() - self.container_width.get()))
                            .clamp(0.0, 1.0);
                        physical_scroll_x = (physical_scroll_x + sx).clamp(0.0, 1.0);
                    }

                    if dy < 0.0 {
                        let sy = (-dy / (self.inner_height.get() - self.container_height.get()))
                            .clamp(0.0, 1.0);
                        self.scroll_y.set((self.scroll_y.get() + sy).clamp(0.0, 1.0));
                    }

                    let dx = view_bounds.left() - content_bounds.left();
                    let dy = view_bounds.top() - content_bounds.top();

                    if dx < 0.0 {
                        let sx = (-dx / (self.inner_width.get() - self.container_width.get()))
                            .clamp(0.0, 1.0);
                        physical_scroll_x = (physical_scroll_x - sx).clamp(0.0, 1.0);
                    }

                    self.scroll_x
                        .set(ScrollView::map_scroll_x_from_physical(physical_scroll_x, direction));

                    if dy < 0.0 {
                        let sy = (-dy / (self.inner_height.get() - self.container_height.get()))
                            .clamp(0.0, 1.0);
                        self.scroll_y.set((self.scroll_y.get() - sy).clamp(0.0, 1.0));
                    }

                    if let Some(callback) = &self.on_scroll {
                        (callback)(cx, self.scroll_x.get(), self.scroll_y.get());
                    }
                }
            }

            // Prevent scroll events propagating to any parent scrollviews.
            // TODO: This might be desired behavior when the scrollview is scrolled all the way.
            meta.consume();
        });

        event.map(|window_event, meta| match window_event {
            WindowEvent::GeometryChanged(geo) => {
                if geo.contains(GeoChanged::WIDTH_CHANGED)
                    || geo.contains(GeoChanged::HEIGHT_CHANGED)
                {
                    let bounds = cx.bounds();
                    let scale_factor = cx.scale_factor();

                    let mut scroll_x = self.scroll_x.get();
                    let mut scroll_y = self.scroll_y.get();
                    let inner_width = self.inner_width.get();
                    let inner_height = self.inner_height.get();
                    let mut container_width = self.container_width.get();
                    let mut container_height = self.container_height.get();

                    if inner_width != 0.0 && inner_height != 0.0 {
                        let top =
                            ((inner_height - container_height) * scroll_y).round() / scale_factor;
                        let physical_scroll_x = ScrollView::map_scroll_x_to_physical(
                            scroll_x,
                            cx.environment().direction.get(),
                        );
                        let left = ((inner_width - container_width) * physical_scroll_x).round()
                            / scale_factor;

                        container_width = bounds.width();
                        container_height = bounds.height();

                        if inner_width != container_width {
                            let physical_scroll_x = ((left * scale_factor)
                                / (inner_width - container_width))
                                .clamp(0.0, 1.0);
                            scroll_x = ScrollView::map_scroll_x_from_physical(
                                physical_scroll_x,
                                cx.environment().direction.get(),
                            );
                        } else {
                            scroll_x = 0.0;
                        }

                        if inner_height != container_height {
                            scroll_y = ((top * scale_factor) / (inner_height - container_height))
                                .clamp(0.0, 1.0);
                        } else {
                            scroll_y = 0.0;
                        }

                        self.scroll_x.set(scroll_x);
                        self.scroll_y.set(scroll_y);
                        self.container_width.set(container_width);
                        self.container_height.set(container_height);

                        if let Some(callback) = &self.on_scroll {
                            (callback)(cx, self.scroll_x.get(), self.scroll_y.get());
                        }

                        self.reset();
                    }

                    self.container_width.set(bounds.width());
                    self.container_height.set(bounds.height());
                }
            }

            WindowEvent::MouseScroll(x, y) => {
                cx.set_active(true);
                let (x, y) = if cx.modifiers.shift() { (-*y, -*x) } else { (-*x, -*y) };

                // What percentage of the negative space does this cross?
                if x != 0.0 && self.inner_width.get() > self.container_width.get() {
                    let negative_space = self.inner_width.get() - self.container_width.get();
                    if negative_space != 0.0 {
                        let logical_delta = x * SCROLL_SENSITIVITY / negative_space;
                        cx.emit(ScrollEvent::ScrollX(logical_delta));
                    }
                    // Prevent event propagating to ancestor scrollviews.
                    meta.consume();
                }
                if y != 0.0 && self.inner_height.get() > self.container_height.get() {
                    let negative_space = self.inner_height.get() - self.container_height.get();
                    if negative_space != 0.0 {
                        let logical_delta = y * SCROLL_SENSITIVITY / negative_space;
                        cx.emit(ScrollEvent::ScrollY(logical_delta));
                    }
                    // Prevent event propagating to ancestor scrollviews.
                    meta.consume();
                }
            }

            WindowEvent::MouseOut => {
                cx.set_active(false);
            }

            _ => {}
        });
    }
}

impl Handle<'_, ScrollView> {
    /// Sets a callback which will be called when a scrollview is scrolled, either with the mouse wheel, touchpad, or using the scroll bars.
    pub fn on_scroll(
        self,
        callback: impl Fn(&mut EventContext, f32, f32) + 'static + Send + Sync,
    ) -> Self {
        self.modify(|scrollview| scrollview.on_scroll = Some(Arc::new(callback)))
    }

    /// Sets whether the scrollbar should move to the cursor when pressed.
    pub fn scroll_to_cursor(self, scroll_to_cursor: impl Res<bool> + 'static) -> Self {
        let scroll_to_cursor = scroll_to_cursor.to_signal(self.cx);
        self.bind(scroll_to_cursor, move |handle| {
            handle.modify(|scrollview| scrollview.scroll_to_cursor.set(scroll_to_cursor.get()));
        })
    }

    /// Set the horizontal scroll position of the [ScrollView]. Accepts a value or signal of type `f32` between 0 and 1.
    pub fn scroll_x(self, scrollx: impl Res<f32> + 'static) -> Self {
        let scrollx = scrollx.to_signal(self.cx);
        self.bind(scrollx, move |handle| {
            handle.modify(|scrollview| scrollview.scroll_x.set(scrollx.get()));
        })
    }

    /// Set the vertical scroll position of the [ScrollView]. Accepts a value or signal of type `f32` between 0 and 1.
    pub fn scroll_y(self, scrolly: impl Res<f32> + 'static) -> Self {
        let scrolly = scrolly.to_signal(self.cx);
        self.bind(scrolly, move |handle| {
            handle.modify(|scrollview| scrollview.scroll_y.set(scrolly.get()));
        })
    }

    /// Sets whether the horizontal scrollbar should be visible.
    pub fn show_horizontal_scrollbar(self, flag: impl Res<bool> + 'static) -> Self {
        let flag = flag.to_signal(self.cx);
        self.bind(flag, move |handle| {
            handle.modify(|scrollview| scrollview.show_horizontal_scrollbar.set(flag.get()));
        })
    }

    /// Sets whether the vertical scrollbar should be visible.
    pub fn show_vertical_scrollbar(self, flag: impl Res<bool> + 'static) -> Self {
        let flag = flag.to_signal(self.cx);
        self.bind(flag, move |handle| {
            handle.modify(|scrollview| scrollview.show_vertical_scrollbar.set(flag.get()));
        })
    }
}

struct ScrollContent {}

impl ScrollContent {
    pub fn new(cx: &mut Context, content: impl FnOnce(&mut Context)) -> Handle<Self> {
        Self {}.build(cx, content)
    }
}

impl View for ScrollContent {
    fn element(&self) -> Option<&'static str> {
        Some("scroll-content")
    }

    fn event(&mut self, cx: &mut EventContext, event: &mut Event) {
        event.map(|window_event, _| match window_event {
            WindowEvent::GeometryChanged(geo) => {
                if geo.contains(GeoChanged::WIDTH_CHANGED)
                    || geo.contains(GeoChanged::HEIGHT_CHANGED)
                {
                    let bounds = cx.bounds();
                    // If the width or height have changed then send this back up to the ScrollData.
                    cx.emit(ScrollEvent::ChildGeo(bounds.w, bounds.h));
                }
            }

            _ => {}
        });
    }
}