guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
tooltip.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 "guillaume/ecs/system_filler.hpp"
26
27#include "guillaume/components/tooltip.hpp"
28
29namespace guillaume::systems
30{
73 class Tooltip: public ecs::SystemFiller<components::Tooltip>
74 {
75 public:
79 Tooltip(void);
80
84 ~Tooltip(void) override = default;
85
105 static void install(ecs::ComponentRegistry &componentRegistry,
106 const ecs::Entity::Identifier &entityIdentifier);
107
125 static void apply(ecs::ComponentRegistry &componentRegistry,
126 const ecs::Entity::Identifier &entityIdentifier);
127
142 static void setAnchor(ecs::ComponentRegistry &componentRegistry,
143 const ecs::Entity::Identifier &entityIdentifier,
144 ecs::Entity::Identifier anchorIdentifier);
145
157 static void setViewport(ecs::ComponentRegistry &componentRegistry,
158 const ecs::Entity::Identifier &entityIdentifier,
159 float width, float height);
160
170 static void show(ecs::ComponentRegistry &componentRegistry,
171 const ecs::Entity::Identifier &entityIdentifier);
172
181 static void hide(ecs::ComponentRegistry &componentRegistry,
182 const ecs::Entity::Identifier &entityIdentifier);
183
197 static void advance(ecs::ComponentRegistry &componentRegistry,
198 const ecs::Entity::Identifier &entityIdentifier,
199 float deltaTime);
200
213 static void place(ecs::ComponentRegistry &componentRegistry,
214 const ecs::Entity::Identifier &entityIdentifier);
215
225 static bool hasAnchor(const ecs::ComponentRegistry &componentRegistry,
226 const ecs::Entity::Identifier &entityIdentifier);
227
235 void update(const ecs::Entity::Identifier &entityIdentifier) override;
236 };
237
238} // namespace guillaume::systems
Stores every component of a scene, per component type and per entity identifier, and knows which ones...
std::size_t Identifier
The key under which an entity's components are stored. Systems and components refer to entities by th...
Definition entity.hpp:86
The base class to derive a system from: a System whose signature is the list of component types given...
void update(const ecs::Entity::Identifier &entityIdentifier) override
Run apply() on one tooltip; called by the frame loop.
Definition tooltip.cpp:341
static void install(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Give a tooltip its accessibility semantics, its ticker and its dismissal.
Definition tooltip.cpp:94
static void apply(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Style one tooltip and arrange its children.
Definition tooltip.cpp:272
static void show(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Show the tooltip next to its anchor at once, without waiting for the enter delay.
Definition tooltip.cpp:171
~Tooltip(void) override=default
Default destructor.
static void advance(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier, float deltaTime)
Advance the hover timers by some elapsed time.
Definition tooltip.cpp:188
static void setViewport(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier, float width, float height)
Set the area the tooltip must stay inside.
Definition tooltip.cpp:158
Tooltip(void)
Create the system in the Layout phase.
Definition tooltip.cpp:89
static void place(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Move the tooltip next to its anchor.
Definition tooltip.cpp:219
static void setAnchor(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier, ecs::Entity::Identifier anchorIdentifier)
Attach the tooltip to the entity whose hover triggers it.
Definition tooltip.cpp:139
static void hide(ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Hide the tooltip at once, without waiting for the leave delay.
Definition tooltip.cpp:180
static bool hasAnchor(const ecs::ComponentRegistry &componentRegistry, const ecs::Entity::Identifier &entityIdentifier)
Whether the tooltip is attached to an entity that still exists.
Definition tooltip.cpp:127
Rules. Every class here runs each frame on the entities that have the components it declares.