guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
Loading...
Searching...
No Matches
guillaume::systems::MeasureText Class Reference

Computes the size of every text and writes it into its Bound, so the layout knows how much room a label takes. More...

#include <headers/guillaume/systems/measure_text.hpp>

Inheritance diagram for guillaume::systems::MeasureText:
Collaboration diagram for guillaume::systems::MeasureText:

Public Member Functions

 MeasureText (std::shared_ptr< utility::RessourceProvider > ressourceProvider, utility::Engine &engine)
 Create the system in the Measure phase, with an empty cache.
 ~MeasureText (void)
 Destroy the system and its cache.
void prepare (void) override
 Does nothing: the system needs no per-frame setup.
void cleanup (void) override
 Does nothing: the cache is kept from one frame to the next.
virtual void update (const ecs::Entity::Identifier &entityIdentifier) override
 Write the size of one text into its components::Bound, measuring it with the engine when it is not in the cache yet.
Public Member Functions inherited from guillaume::ecs::SystemFiller< components::Text, components::Bound, components::Transform, components::Color >
 SystemFiller (Phase phase)
 Create the system and set its signature from ComponentTypes.
virtual ~SystemFiller (void)=default
 Virtual destructor.
Public Member Functions inherited from guillaume::ecs::System
 System (Phase phase)
 Create a system that runs in a given phase, with an empty signature.
virtual ~System (void)=default
 Virtual destructor.
Phase getPhase (void) const noexcept
 Get the phase of the frame in which the system runs.
Entity::Signature getSignature (void) const noexcept
 Get the component types an entity must declare to be visited by this system.
void routine (ecs::ComponentRegistry &componentRegistry, ecs::EntityRegistry &entityRegistry, const ecs::EntityTreeTraveler &traveler)
 Run the system once over a scene: prepare(), update() on each matching entity, cleanup().
void bindComponentRegistry (ecs::ComponentRegistry &componentRegistry)
 Bind a component registry so update() can be called directly, without routine().
void unbindComponentRegistry (void)
 Drop the binding made by bindComponentRegistry().

Additional Inherited Members

Protected Member Functions inherited from guillaume::ecs::System
template<InheritFromComponent... ComponentTypes>
void setSignature (void)
 Replace the signature by the one made of the given component types.
ecs::EntityRegistry & getEntityRegistry (void)
 Get the entity registry of the scene being processed.
const ecs::EntityRegistry & getEntityRegistry (void) const
 Get the entity registry of the scene being processed, read-only.
ecs::ComponentRegistry & getComponentRegistry (void)
 Get the component registry of the scene being processed.
const ecs::ComponentRegistry & getComponentRegistry (void) const
 Get the component registry of the scene being processed, read-only.
template<InheritFromComponent ComponentType>
bool hasComponent (const ecs::Entity::Identifier &entityIdentifier) const
 Tell whether an entity has a component, in the bound registry.
template<InheritFromComponent ComponentType>
ComponentType & getComponent (const ecs::Entity::Identifier &entityIdentifier)
 Get a component of an entity from the bound registry, to read or modify it.
template<InheritFromComponent ComponentType>
const ComponentType & getComponent (const ecs::Entity::Identifier &entityIdentifier) const
 Get a component of an entity from the bound registry, read-only.
template<InheritFromComponent ComponentType>
bool requireComponent (const ecs::Entity::Identifier &entityIdentifier)
 Tell whether an entity has a component, and log a warning naming the entity and the component when it does not.

Detailed Description

Computes the size of every text and writes it into its Bound, so the layout knows how much room a label takes.

Runs in the Measure phase on entities with Text, Bound, Transform and Color.

  • Reads: the string, font size, font weight and line height of components::Text.
  • Writes: components::Bound. The width is the measured width; the height is the measured height or the line height of the Text, whichever is larger.

The measurement is asked to the engine (utility::Engine::measureText) once per distinct MeasureTextCacheKey and kept for the life of the system; later frames only copy the cached size.

Things to know:

  • The Bound of a text entity is overwritten every frame: a size set by hand does not survive.
  • systems::Typography is registered before this system, in the same phase, so a text styled by a type-scale role is measured with the font size and weight of that role.
  • The cache is never emptied. A text whose content changes every frame (a counter, a clock) adds one entry per distinct string.
See also
components::Text, systems::Typography, systems::TextRender
MeasureTextCacheKey

Definition at line 143 of file measure_text.hpp.

Constructor & Destructor Documentation

◆ MeasureText()

guillaume::systems::MeasureText::MeasureText ( std::shared_ptr< utility::RessourceProvider > ressourceProvider,
utility::Engine & engine )

Create the system in the Measure phase, with an empty cache.

Parameters
ressourceProviderProvider used to load the fonts.
engineThe engine asked to measure the texts. It must outlive the system.

Definition at line 32 of file measure_text.cpp.

Here is the call graph for this function:

◆ ~MeasureText()

guillaume::systems::MeasureText::~MeasureText ( void )

Destroy the system and its cache.

Definition at line 44 of file measure_text.cpp.

Member Function Documentation

◆ cleanup()

void guillaume::systems::MeasureText::cleanup ( void )
overridevirtual

Does nothing: the cache is kept from one frame to the next.

Reimplemented from guillaume::ecs::System.

Definition at line 52 of file measure_text.cpp.

◆ prepare()

void guillaume::systems::MeasureText::prepare ( void )
overridevirtual

Does nothing: the system needs no per-frame setup.

Reimplemented from guillaume::ecs::System.

Definition at line 48 of file measure_text.cpp.

◆ update()

void guillaume::systems::MeasureText::update ( const ecs::Entity::Identifier & entityIdentifier)
overridevirtual

Write the size of one text into its components::Bound, measuring it with the engine when it is not in the cache yet.

Parameters
entityIdentifierThe text entity. It is skipped, with a log message, when one of the four components is missing.

Implements guillaume::ecs::System.

Definition at line 56 of file measure_text.cpp.

Here is the call graph for this function:

The documentation for this class was generated from the following files: