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

Computes the size of every 3D model and writes it into its Bound, so the layout knows how much room the model takes. More...

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

Inheritance diagram for guillaume::systems::MeasureMesh:
Collaboration diagram for guillaume::systems::MeasureMesh:

Public Member Functions

 MeasureMesh (std::shared_ptr< utility::RessourceProvider > ressourceProvider, utility::Engine &engine)
 Create the system in the Measure phase, with an empty cache.
 ~MeasureMesh (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 model into its components::Bound, loading and measuring the file when it is not in the cache yet.
Public Member Functions inherited from guillaume::ecs::SystemFiller< components::Mesh, components::Bound, components::Transform >
 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 3D model and writes it into its Bound, so the layout knows how much room the model takes.

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

  • Reads: the model path of components::Mesh.
  • Writes: the width and height of components::Bound, taken from the bounding size of the model (utility::graphic::Model::computeBoundingSize).

A model file is loaded and measured once per distinct path and the size is kept for the life of the system; later frames only copy the cached size.

Things to know:

  • The Bound of a model entity is overwritten every frame.
  • The model must exist: the result of the load is used without a check, unlike in systems::MeshRender.
See also
components::Mesh, systems::MeshRender
MeasureMeshCacheKey

Definition at line 115 of file measure_mesh.hpp.

Constructor & Destructor Documentation

◆ MeasureMesh()

guillaume::systems::MeasureMesh::MeasureMesh ( 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 models. Must not be null.
engineThe engine handle. It must outlive the system.

Definition at line 30 of file measure_mesh.cpp.

Here is the call graph for this function:

◆ ~MeasureMesh()

guillaume::systems::MeasureMesh::~MeasureMesh ( void )

Destroy the system and its cache.

Definition at line 40 of file measure_mesh.cpp.

Member Function Documentation

◆ cleanup()

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

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

Reimplemented from guillaume::ecs::System.

Definition at line 48 of file measure_mesh.cpp.

◆ prepare()

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

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

Reimplemented from guillaume::ecs::System.

Definition at line 44 of file measure_mesh.cpp.

◆ update()

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

Write the size of one model into its components::Bound, loading and measuring the file when it is not in the cache yet.

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

Implements guillaume::ecs::System.

Definition at line 52 of file measure_mesh.cpp.

Here is the call graph for this function:

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