guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
mouse_hover_interaction.hpp
1/*
2 Copyright (c) 2026 ETIB Corporation
3
4 Permission is hereby granted, free of charge, to any person obtaining a copy of
5 this software and associated documentation files (the "Software"), to deal in
6 the Software without restriction, including without limitation the rights to
7 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
8 of the Software, and to permit persons to whom the Software is furnished to do
9 so, subject to the following conditions:
10
11 The above copyright notice and this permission notice shall be included in all
12 copies or substantial portions of the Software.
13
14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 SOFTWARE.
21 */
22
23#pragma once
24
25#include <functional>
26
27#include <utility/graphic/size.hpp>
28
29#include "guillaume/ecs/component.hpp"
30
32{
33
60 {
61 public:
63 std::function<void(void)>;
65 std::function<void(void)>;
66
67 private:
68 HoverHandler _onHover;
69 UnhoverHandler _onUnhover;
70 bool _isHovered { false };
71
72 utility::graphic::SizeUI _accessibilityMargin {
73 0, 0
74 };
76
77 public:
83
87 ~MouseHoverInteraction(void) = default;
88
107 setOnUnhoverHandler(const UnhoverHandler &handler);
108
114
120
126 bool isHovered(void) const;
127
138
144 utility::graphic::SizeUI getAccessibilityMargin(void) const;
145
159 setAccessibilityMargin(const utility::graphic::SizeUI &margin);
160 };
161
162} // namespace guillaume::components
HoverHandler getOnHoverHandler(void) const
Get the callback run when the pointer enters the entity.
MouseHoverInteraction & setHovered(bool isHovered)
Record whether the pointer is over the entity.
UnhoverHandler getOnUnhoverHandler(void) const
Get the callback run when the pointer leaves the entity.
MouseHoverInteraction & setOnUnhoverHandler(const UnhoverHandler &handler)
Store the callback run when the pointer leaves the entity.
std::function< void(void)> UnhoverHandler
Called on hover end.
MouseHoverInteraction(void)
Construct a component that is not hovered, has no handler and no margin.
utility::graphic::SizeUI getAccessibilityMargin(void) const
Get the hit area added around the bound.
bool isHovered(void) const
Check whether the pointer is over the entity.
MouseHoverInteraction & setAccessibilityMargin(const utility::graphic::SizeUI &margin)
Grow the hit area past the bound without growing the entity on screen.
std::function< void(void)> HoverHandler
Called on hover start.
~MouseHoverInteraction(void)=default
Default destructor.
MouseHoverInteraction & setOnHoverHandler(const HoverHandler &handler)
Store the callback run when the pointer enters the entity.
Base class of every component: a piece of state attached to an entity, plus a "changed" flag.
Definition component.hpp:72
State. Every class here is plain data attached to an entity.