guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
hand_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
59 {
60 public:
62 std::function<void(void)>;
64 std::function<void(void)>;
65
66 private:
67 HoverHandler _onHover;
68 UnhoverHandler _onUnhover;
69 bool _isHovered { false };
70 utility::graphic::SizeUI _accessibilityMargin {
71 0, 0
72 };
74
75 public:
81
85 ~HandHoverInteraction(void) = default;
86
96
106 setOnUnhoverHandler(const UnhoverHandler &handler);
107
113
119
125 bool isHovered(void) const;
126
137
143 utility::graphic::SizeUI getAccessibilityMargin(void) const;
144
158 setAccessibilityMargin(const utility::graphic::SizeUI &margin);
159 };
160
161} // namespace guillaume::components
HoverHandler getOnHoverHandler(void) const
Get the callback run when the hand ray enters the entity.
HandHoverInteraction & setAccessibilityMargin(const utility::graphic::SizeUI &margin)
Grow the hit area past the entity's bound without growing the entity on screen.
HandHoverInteraction & setOnUnhoverHandler(const UnhoverHandler &handler)
Store the callback run when the hand ray leaves the entity.
HandHoverInteraction & setHovered(bool isHovered)
Record whether a hand aims at the entity.
HandHoverInteraction & setOnHoverHandler(const HoverHandler &handler)
Store the callback run when the hand ray enters the entity.
std::function< void(void)> UnhoverHandler
Called on hover end.
UnhoverHandler getOnUnhoverHandler(void) const
Get the callback run when the hand ray leaves the entity.
~HandHoverInteraction(void)=default
Default destructor.
HandHoverInteraction(void)
Construct a component that is not hovered, has no handler and no margin.
std::function< void(void)> HoverHandler
Called on hover start.
utility::graphic::SizeUI getAccessibilityMargin(void) const
Get the hit area added around the entity's bound.
bool isHovered(void) const
Check whether a hand aims at 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.