HikoGUI
A low latency retained GUI
Loading...
Searching...
No Matches
toggle_widget.hpp
Go to the documentation of this file.
1// Copyright Take Vos 2021-2022.
2// Distributed under the Boost Software License, Version 1.0.
3// (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)
4
9#pragma once
10
11#include "widget.hpp"
12#include "with_label_widget.hpp"
13#include "toggle_delegate.hpp"
14#include "../telemetry/telemetry.hpp"
15#include "../macros.hpp"
16
17hi_export_module(hikogui.widgets.toggle_widget);
18
19hi_export namespace hi {
20inline namespace v1 {
21
22template<typename Context>
24
62class toggle_widget : public widget {
63public:
64 using super = widget;
65 using delegate_type = toggle_delegate;
66
68 observer<alignment> alignment = alignment::top_left();
69 keyboard_focus_group focus_group = keyboard_focus_group::normal;
70
71 attributes_type(attributes_type const&) noexcept = default;
72 attributes_type(attributes_type&&) noexcept = default;
73 attributes_type& operator=(attributes_type const&) noexcept = default;
74 attributes_type& operator=(attributes_type&&) noexcept = default;
75
76 template<toggle_widget_attribute... Attributes>
77 explicit attributes_type(Attributes&&...attributes) noexcept
78 {
79 set_attributes(std::forward<Attributes>(attributes)...);
80 }
81
82 void set_attributes() noexcept {}
83
85 void set_attributes(First&& first, Rest&&...rest) noexcept
86 {
88 alignment = std::forward<First>(first);
89
90 } else if constexpr (forward_of<First, keyboard_focus_group>) {
91 focus_group = std::forward<First>(first);
92
93 } else {
94 hi_static_no_default();
95 }
96
97 set_attributes(std::forward<Rest>(rest)...);
98 }
99 };
100
101 attributes_type attributes;
102
106
107 hi_num_valid_arguments(consteval static, num_default_delegate_arguments, default_toggle_delegate);
108 hi_call_left_arguments(static, make_default_delegate, make_shared_ctad<default_toggle_delegate>);
109 hi_call_right_arguments(static, make_attributes, attributes_type);
110
112 {
113 this->delegate->deinit(*this);
114 }
115
122 widget_intf const* parent,
123 attributes_type attributes,
125 super(parent), attributes(std::move(attributes)), delegate(std::move(delegate))
126 {
127 hi_axiom_not_null(this->delegate);
128 this->delegate->init(*this);
129 _delegate_cbt = this->delegate->subscribe([&] {
130 set_value(this->delegate->state(*this));
131 });
132 _delegate_cbt();
133 }
134
141 template<typename... Args>
142 toggle_widget(widget_intf const* parent, Args&&...args)
143 requires(num_default_delegate_arguments<Args...>() != 0)
144 :
146 parent,
147 make_attributes<num_default_delegate_arguments<Args...>()>(std::forward<Args>(args)...),
148 make_default_delegate<num_default_delegate_arguments<Args...>()>(std::forward<Args>(args)...))
149 {
150 }
151
153 [[nodiscard]] box_constraints update_constraints() noexcept override
154 {
155 _button_size = {theme().size() * 2.0f, theme().size()};
156 return box_constraints{_button_size, _button_size, _button_size, *attributes.alignment, theme().margin()};
157 }
158
159 void set_layout(widget_layout const& context) noexcept override
160 {
161 if (compare_store(_layout, context)) {
162 _button_rectangle = align(context.rectangle(), _button_size, os_settings::alignment(*attributes.alignment));
163
164 auto const button_square =
165 aarectangle{get<0>(_button_rectangle), extent2{_button_rectangle.height(), _button_rectangle.height()}};
166
167 _pip_circle = align(button_square, circle{theme().size() * 0.5f - 3.0f}, alignment::middle_center());
168
169 auto const pip_to_button_margin_x2 = _button_rectangle.height() - _pip_circle.diameter();
170 _pip_move_range = _button_rectangle.width() - _pip_circle.diameter() - pip_to_button_margin_x2;
171 }
172 super::set_layout(context);
173 }
174
175 void draw(draw_context const& context) noexcept override
176 {
177 if (mode() > widget_mode::invisible and overlaps(context, layout())) {
178 context.draw_box(
179 layout(),
180 _button_rectangle,
181 background_color(),
182 focus_color(),
183 theme().border_width(),
185 corner_radii{_button_rectangle.height() * 0.5f});
186
187 switch (_animated_value.update(value() == widget_value::on ? 1.0f : 0.0f, context.display_time_point)) {
188 case animator_state::idle:
189 break;
190 case animator_state::running:
192 break;
193 case animator_state::end:
194 notifier();
195 break;
196 default:
197 hi_no_default();
198 }
199
200 auto const positioned_pip_circle = translate3{_pip_move_range * _animated_value.current_value(), 0.0f, 0.1f} * _pip_circle;
201
202 auto const foreground_color_ = value() == widget_value::on ? accent_color() : foreground_color();
203 context.draw_circle(layout(), positioned_pip_circle * 1.02f, foreground_color_);
204 }
205 }
206
207 [[nodiscard]] color background_color() const noexcept override
208 {
209 hi_axiom(loop::main().on_thread());
210 if (phase() == widget_phase::pressed) {
211 return theme().color(semantic_color::fill, _layout.layer + 2);
212 } else {
213 return super::background_color();
214 }
215 }
216
217 [[nodiscard]] hitbox hitbox_test(point2 position) const noexcept override
218 {
219 hi_axiom(loop::main().on_thread());
220
221 if (mode() >= widget_mode::partial and layout().contains(position)) {
222 return {id, _layout.elevation, hitbox_type::button};
223 } else {
224 return {};
225 }
226 }
227
228 [[nodiscard]] bool accepts_keyboard_focus(keyboard_focus_group group) const noexcept override
229 {
230 hi_axiom(loop::main().on_thread());
231 return mode() >= widget_mode::partial and to_bool(group & hi::keyboard_focus_group::normal);
232 }
233
234 bool handle_event(gui_event const& event) noexcept override
235 {
236 hi_axiom(loop::main().on_thread());
237
238 switch (event.type()) {
239 case gui_event_type::gui_activate:
240 if (mode() >= widget_mode::partial) {
241 delegate->activate(*this);
242 ++global_counter<"toggle_widget:handle_event:relayout">;
244 return true;
245 }
246 break;
247
248 case gui_event_type::mouse_down:
249 if (mode() >= widget_mode::partial and event.mouse().cause.left_button) {
250 set_pressed(true);
251 return true;
252 }
253 break;
254
255 case gui_event_type::mouse_up:
256 if (mode() >= widget_mode::partial and event.mouse().cause.left_button) {
257 set_pressed(false);
258
259 // with_label_widget or other widgets may have accepted the hitbox
260 // for this widget. Which means the widget_id in the mouse-event
261 // may match up with the toggle.
262 if (event.mouse().hitbox.widget_id == id) {
263 handle_event(gui_event_type::gui_activate);
264 }
266 return true;
267 }
268 break;
269
270 default:;
271 }
272
273 return super::handle_event(event);
274 }
276
277private:
278 constexpr static std::chrono::nanoseconds _animation_duration = std::chrono::milliseconds(150);
279
280 extent2 _button_size;
281 aarectangle _button_rectangle;
282 animator<float> _animated_value = _animation_duration;
283 circle _pip_circle;
284 float _pip_move_range;
285
286 callback<void()> _delegate_cbt;
287
288 template<size_t I>
289 void set_attributes() noexcept
290 {
291 }
292
293 template<size_t I, button_widget_attribute First, button_widget_attribute... Rest>
294 void set_attributes(First&& first, Rest&&...rest) noexcept
295 {
296 if constexpr (forward_of<decltype(first), observer<hi::alignment>>) {
297 alignment = std::forward<First>(first);
298 set_attributes<I>(std::forward<Rest>(rest)...);
299
300 } else {
301 hi_static_no_default();
302 }
303 }
304};
305
306using toggle_with_label_widget = with_label_widget<toggle_widget>;
307
308} // namespace v1
309} // namespace hi::v1
Defines widget.
Defines with_label_widget.
@ window_relayout
Request that widgets get laid out on the next frame.
@ partial
A widget is partially enabled.
@ invisible
The widget is invisible.
The HikoGUI namespace.
Definition array_generic.hpp:20
@ inside
The border is drawn inside the edge of a quad.
bool compare_store(T &lhs, U &&rhs) noexcept
Compare then store if there was a change.
Definition misc.hpp:53
DOXYGEN BUG.
Definition algorithm_misc.hpp:20
Horizontal/Vertical alignment combination.
Definition alignment.hpp:244
Definition widget_intf.hpp:24
notifier< void()> notifier
Notifier which is called after an action is completed by a widget.
Definition widget_intf.hpp:39
widget_id id
The numeric identifier of a widget.
Definition widget_intf.hpp:30
widget_layout const & layout() const noexcept
Get the current layout for this widget.
Definition widget_intf.hpp:206
widget_intf * parent
Pointer to the parent widget.
Definition widget_intf.hpp:35
2D constraints.
Definition box_constraints.hpp:25
A observer pointing to the whole or part of a observed_base.
Definition observer_intf.hpp:32
A button delegate controls the state of a button widget.
Definition toggle_delegate.hpp:18
A default toggle button delegate.
Definition toggle_delegate.hpp:58
A GUI widget that permits the user to make a binary choice.
Definition toggle_widget.hpp:62
std::shared_ptr< delegate_type > delegate
The delegate that controls the button widget.
Definition toggle_widget.hpp:105
toggle_widget(widget_intf const *parent, Args &&...args)
Construct a toggle widget with a default button delegate.
Definition toggle_widget.hpp:142
toggle_widget(widget_intf const *parent, attributes_type attributes, std::shared_ptr< delegate_type > delegate) noexcept
Construct a toggle widget.
Definition toggle_widget.hpp:121
Definition toggle_widget.hpp:67
An interactive graphical object as part of the user-interface.
Definition widget.hpp:37
void set_layout(widget_layout const &context) noexcept override
Update the internal layout of the widget.
Definition widget.hpp:121
void request_redraw() const noexcept override
Request the widget to be redrawn on the next frame.
Definition widget.hpp:141
widget() noexcept
Constructor for creating sub views.
Definition widget.hpp:55
bool process_event(gui_event const &event) const noexcept override
Send a event to the window.
Definition widget.hpp:130
bool handle_event(gui_event const &event) noexcept override
Handle command.
Definition widget.hpp:150
True if T is a forwarded type of Forward.
Definition concepts.hpp:137
Definition toggle_widget.hpp:23
T align(T... args)
T move(T... args)