scroll_aperture_widget.hpp

Go to the documentation of this file.

// Copyright Take Vos 2022.
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
 
#pragma once
 
#include "widget.hpp"
#include "../macros.hpp"
#include <coroutine>
 
hi_export_module(hikogui.widgets.scroll_aperture_widget);
 
hi_export namespace hi { inline namespace v1 {
 
class scroll_aperture_widget : public widget {
public:
    using super = widget;
 
    observer<float> content_width;
    observer<float> content_height;
    observer<float> aperture_width;
    observer<float> aperture_height;
    observer<float> offset_x;
    observer<float> offset_y;
 
    scroll_aperture_widget(not_null<widget_intf const *> parent) noexcept : super(parent)
    {
        hi_axiom(loop::main().on_thread());
 
        _content_width_cbt = content_width.subscribe([&](auto...) {
            ++global_counter<"scroll_aperture_widget:content_width:relayout">;
            process_event({gui_event_type::window_relayout});
        });
        _content_height_cbt = content_height.subscribe([&](auto...) {
            ++global_counter<"scroll_aperture_widget:content_height:relayout">;
            process_event({gui_event_type::window_relayout});
        });
        _aperture_width_cbt = aperture_width.subscribe([&](auto...) {
            ++global_counter<"scroll_aperture_widget:aperture_width:relayout">;
            process_event({gui_event_type::window_relayout});
        });
        _aperture_height_cbt = aperture_height.subscribe([&](auto...) {
            ++global_counter<"scroll_aperture_widget:aperture_height:relayout">;
            process_event({gui_event_type::window_relayout});
        });
        _offset_x_cbt = offset_x.subscribe([&](auto...) {
            ++global_counter<"scroll_aperture_widget:offset_x:relayout">;
            process_event({gui_event_type::window_relayout});
        });
        _offset_y_cbt = offset_y.subscribe([&](auto...) {
            ++global_counter<"scroll_aperture_widget:offset_y:relayout">;
            process_event({gui_event_type::window_relayout});
        });
        _minimum_cbt = minimum.subscribe([&](auto...) {
            ++global_counter<"scroll_aperture_widget:minimum:reconstrain">;
            process_event({gui_event_type::window_reconstrain});
        });
    }
 
    template<typename Widget, typename... Args>
    Widget& emplace(Args&&...args) noexcept
    {
        hi_axiom(loop::main().on_thread());
        hi_axiom(_content == nullptr);
 
        auto tmp = std::make_unique<Widget>(this, std::forward<Args>(args)...);
        auto& ref = *tmp;
        _content = std::move(tmp);
        return ref;
    }
 
    [[nodiscard]] bool x_axis_scrolls() const noexcept
    {
        return *content_width > *aperture_width;
    }
 
    [[nodiscard]] bool y_axis_scrolls() const noexcept
    {
        return *content_height > *aperture_height;
    }
 
    [[nodiscard]] generator<widget_intf &> children(bool include_invisible) noexcept override
    {
        co_yield *_content;
    }
 
    [[nodiscard]] box_constraints update_constraints() noexcept override
    {
        _layout = {};
        _content_constraints = _content->update_constraints();
 
        // The aperture can scroll so its minimum width and height are zero.
        auto aperture_constraints = _content_constraints;
        aperture_constraints.minimum = extent2{0, 0};
 
        aperture_constraints = aperture_constraints.constrain(*minimum, *maximum);
        aperture_constraints += extent2{
            _content_constraints.margins.left() + _content_constraints.margins.right(),
            _content_constraints.margins.top() + _content_constraints.margins.bottom()};
        aperture_constraints.margins = {};
        return aperture_constraints;
    }
 
    void set_layout(widget_layout const& context) noexcept override
    {
        if (compare_store(_layout, context)) {
            aperture_width = context.width() - _content_constraints.margins.left() - _content_constraints.margins.right();
            aperture_height = context.height() - _content_constraints.margins.bottom() - _content_constraints.margins.top();
 
            // Start scrolling with the preferred size as minimum, so
            // that widgets in the content don't get unnecessarily squeezed.
            content_width = *aperture_width < _content_constraints.preferred.width() ? _content_constraints.preferred.width() :
                                                                                        *aperture_width;
            content_height = *aperture_height < _content_constraints.preferred.height() ?
                _content_constraints.preferred.height() :
                *aperture_height;
        }
 
        // Make sure the offsets are limited to the scrollable area.
        auto const offset_x_max = std::max(*content_width - *aperture_width, 0.0f);
        auto const offset_y_max = std::max(*content_height - *aperture_height, 0.0f);
        offset_x = std::clamp(*offset_x, 0.0f, offset_x_max);
        offset_y = std::clamp(*offset_y, 0.0f, offset_y_max);
 
        // The position of the content rectangle relative to the scroll view.
        // The size is further adjusted if the either the horizontal or vertical scroll bar is invisible.
        _content_shape = box_shape{
            _content_constraints,
            aarectangle{
                -*offset_x + _content_constraints.margins.left(),
                -*offset_y + _content_constraints.margins.bottom(),
                *content_width,
                *content_height},
            theme().baseline_adjustment()};
 
        // The content needs to be at a higher elevation, so that hitbox check
        // will work correctly for handling scrolling with mouse wheel.
        _content->set_layout(context.transform(_content_shape, transform_command::level, context.rectangle()));
    }
 
    void draw(draw_context const& context) noexcept override
    {
        if (mode() > widget_mode::invisible) {
            _content->draw(context);
        }
    }
 
    [[nodiscard]] hitbox hitbox_test(point2 position) const noexcept override
    {
        hi_axiom(loop::main().on_thread());
 
        if (mode() >= widget_mode::partial) {
            auto r = _content->hitbox_test_from_parent(position);
 
            if (layout().contains(position)) {
                r = std::max(r, hitbox{id, _layout.elevation});
            }
            return r;
 
        } else {
            return {};
        }
    }
 
    bool handle_event(gui_event const& event) noexcept override
    {
        hi_axiom(loop::main().on_thread());
 
        if (event == gui_event_type::mouse_wheel) {
            auto const new_offset_x = *offset_x + std::round(event.mouse().wheel_delta.x() * theme().scale);
            auto const new_offset_y = *offset_y + std::round(event.mouse().wheel_delta.y() * theme().scale);
            auto const max_offset_x = std::max(0.0f, *content_width - *aperture_width);
            auto const max_offset_y = std::max(0.0f, *content_height - *aperture_height);
 
            offset_x = std::clamp(new_offset_x, 0.0f, max_offset_x);
            offset_y = std::clamp(new_offset_y, 0.0f, max_offset_y);
            ++global_counter<"scroll_aperture_widget:mouse_wheel:relayout">;
            process_event({gui_event_type::window_relayout});
            return true;
        } else {
            return super::handle_event(event);
        }
    }
 
    void scroll_to_show(hi::aarectangle to_show) noexcept override
    {
        if (_layout) {
            auto safe_rectangle = intersect(_layout.rectangle(), _layout.clipping_rectangle);
            auto delta_x = 0.0f;
            auto delta_y = 0.0f;
 
            if (safe_rectangle.width() > theme().margin<float>() * 2.0f and safe_rectangle.height() > theme().margin<float>() * 2.0f) {
                // This will look visually better, if the selected widget is moved with some margin from
                // the edge of the scroll widget. The margins of the content do not have anything to do
                // with the margins that are needed here.
                safe_rectangle = safe_rectangle - theme().margin<float>();
 
                if (to_show.right() > safe_rectangle.right()) {
                    delta_x = to_show.right() - safe_rectangle.right();
                } else if (to_show.left() < safe_rectangle.left()) {
                    delta_x = to_show.left() - safe_rectangle.left();
                }
 
                if (to_show.top() > safe_rectangle.top()) {
                    delta_y = to_show.top() - safe_rectangle.top();
                } else if (to_show.bottom() < safe_rectangle.bottom()) {
                    delta_y = to_show.bottom() - safe_rectangle.bottom();
                }
 
                // Scroll the widget
                offset_x = std::round(offset_x + delta_x);
                offset_y = std::round(offset_y + delta_y);
            }
 
            // There may be recursive scroll view, and they all need to move until the rectangle is visible.
            if (parent) {
                parent->scroll_to_show(_layout.to_parent * translate2(delta_x, delta_y) * to_show);
            }
 
        } else {
            return super::scroll_to_show(to_show);
        }
    }
private:
    box_constraints _content_constraints;
    box_shape _content_shape;
    std::unique_ptr<widget> _content;
    callback<void(float)> _content_width_cbt;
    callback<void(float)> _content_height_cbt;
    callback<void(float)> _aperture_width_cbt;
    callback<void(float)> _aperture_height_cbt;
    callback<void(float)> _offset_x_cbt;
    callback<void(float)> _offset_y_cbt;
    callback<void(extent2)> _minimum_cbt;
};
 
}} // namespace hi::v1