guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
button_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 <array>
26#include <functional>
27#include <map>
28
29#include <utility/event/event.hpp>
30
31#include "guillaume/ecs/component.hpp"
32
34{
35
43 template<typename T>
44 concept IsEnum = std::is_enum_v<T>;
45
81 template<utility::event::InheritFromEvent EventType, IsEnum ButtonEnum,
82 std::size_t N, const std::array<ButtonEnum, N> &ButtonsArray>
84 {
85 public:
89 using ButtonPressHandler = std::function<void(void)>;
94 using ButtonReleaseHandler = std::function<void(void)>;
95
96 private:
97 std::map<ButtonEnum, ButtonPressHandler>
98 _onButtonPressHandlers {};
99 std::map<ButtonEnum, ButtonReleaseHandler>
100 _onButtonReleaseHandlers {};
101 std::map<ButtonEnum, bool>
102 _isButtonPressed {};
104
105 public:
111
115 ~ButtonInteraction(void) = default;
116
128 setOnButtonPressHandler(const ButtonEnum &button,
129 const ButtonPressHandler &handler);
130
138 const ButtonPressHandler &
139 getOnButtonPressHandler(const ButtonEnum &button) const;
140
152 setOnButtonReleaseHandler(const ButtonEnum &button,
153 const ButtonReleaseHandler &handler);
154
164 getOnButtonReleaseHandler(const ButtonEnum &button) const;
165
172 bool isButtonPressed(const ButtonEnum &button) const;
173
184 ButtonInteraction &setButtonPressed(const ButtonEnum &button,
185 bool pressed);
186 };
187
188} // namespace guillaume::components
189
190// Include the implementation of the ButtonInteraction template class
191#include "guillaume/components/button_interaction.tpp"
std::function< void(void)> ButtonReleaseHandler
Callback run when a button pressed on the entity is released on it.
ButtonInteraction & setButtonPressed(const ButtonEnum &button, bool pressed)
Record whether a button is held on the entity.
~ButtonInteraction(void)=default
Default destructor.
ButtonInteraction(void)
Construct the component with every button of ButtonsArray released and without handler.
std::function< void(void)> ButtonPressHandler
Callback run when a button is pressed on the entity.
ButtonInteraction & setOnButtonPressHandler(const ButtonEnum &button, const ButtonPressHandler &handler)
Store the callback run when a button is pressed on the entity.
const ButtonReleaseHandler & getOnButtonReleaseHandler(const ButtonEnum &button) const
Get the callback run when a button pressed on the entity is released on it.
bool isButtonPressed(const ButtonEnum &button) const
Check whether a button is held on the entity.
const ButtonPressHandler & getOnButtonPressHandler(const ButtonEnum &button) const
Get the callback run when a button is pressed on the entity.
ButtonInteraction & setOnButtonReleaseHandler(const ButtonEnum &button, const ButtonReleaseHandler &handler)
Store the callback run when a button pressed on the entity is released on it.
Base class of every component: a piece of state attached to an entity, plus a "changed" flag.
Definition component.hpp:72
True when a type is an enumeration.
State. Every class here is plain data attached to an entity.