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

Draws the background of an entity: a filled rectangle with rounded corners and an optional border. More...

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

Inheritance diagram for guillaume::systems::RectangleRender:
Collaboration diagram for guillaume::systems::RectangleRender:

Public Member Functions

 RectangleRender (utility::Engine &engine)
 Create the system in the Render phase.
 ~RectangleRender (void)
 Forget the engine objects without removing them from the engine.
void prepare (void) override
 Mark every engine object as not drawn yet. Called once per frame before the entities are visited.
void cleanup (void) override
 Remove the engine objects of the entities that were not drawn this frame. Called once per frame after the entities.
virtual void update (const ecs::Entity::Identifier &entityIdentifier) override
 Rebuild the fill and border meshes of one entity and upload them, creating the engine object on the first frame.
Public Member Functions inherited from guillaume::systems::RenderHandleMap
 RenderHandleMap (void)=default
 Create an empty map.
 ~RenderHandleMap (void)=default
 Destroy the map without removing the engine objects it refers to.
void markAllUnused (void)
 Clear the used flag of every handle. Call it from the system's prepare(), before any entity is drawn.
void removeUnused (utility::Engine &engine)
 Remove from the engine, then from the map, every handle whose used flag is still false. Call it from the system's cleanup().
RenderHandle * find (const ecs::Entity::Identifier &identifier)
 Look up the handle of an entity.
void insert (const ecs::Entity::Identifier &identifier, RenderHandle handle)
 Store the handle of an entity, replacing the one it had.
std::size_t size (void) const
 Count the entities that have an engine object in this map.
void clear (void)
 Forget every handle without calling utility::Engine::removeObject. Use it only when the engine objects are gone already or are destroyed with the engine.
Public Member Functions inherited from guillaume::ecs::SystemFiller< components::Transform, components::Bound, components::Color, components::Borders >
 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().

Static Public Attributes

static constexpr float StrokeLift = 0.5f
 Distance the border is moved towards the viewer, along the forward axis of the entity, so it draws over the fill. Half the depth of one layer.

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

Draws the background of an entity: a filled rectangle with rounded corners and an optional border.

Runs in the Render phase on every entity that has Transform, Bound, Color and Borders. It reads the four and writes no component: its output is one engine object per entity, rebuilt and uploaded every frame.

Things to know:

  • The four corners share one radius, the average of the four radii of components::Borders. The radius is clamped to half the smaller side.
  • The border is a second mesh lifted by StrokeLift towards the viewer so it is not hidden by the fill.
  • An entity is drawn even when its color is fully transparent.
See also
RenderHandleMap, shape::buildRoundedStrokeMesh
components::Borders, systems::ElevationRender

Definition at line 65 of file rectangle_render.hpp.

Constructor & Destructor Documentation

◆ RectangleRender()

guillaume::systems::RectangleRender::RectangleRender ( utility::Engine & engine)

Create the system in the Render phase.

Parameters
engineThe engine the rectangles are uploaded to. It must outlive the system.

Definition at line 130 of file rectangle_render.cpp.

Here is the call graph for this function:

◆ ~RectangleRender()

guillaume::systems::RectangleRender::~RectangleRender ( void )

Forget the engine objects without removing them from the engine.

Definition at line 138 of file rectangle_render.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ cleanup()

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

Remove the engine objects of the entities that were not drawn this frame. Called once per frame after the entities.

Reimplemented from guillaume::ecs::System.

Definition at line 148 of file rectangle_render.cpp.

Here is the call graph for this function:

◆ prepare()

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

Mark every engine object as not drawn yet. Called once per frame before the entities are visited.

Reimplemented from guillaume::ecs::System.

Definition at line 143 of file rectangle_render.cpp.

Here is the call graph for this function:

◆ update()

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

Rebuild the fill and border meshes of one entity and upload them, creating the engine object on the first frame.

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

Implements guillaume::ecs::System.

Definition at line 154 of file rectangle_render.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ StrokeLift

float guillaume::systems::RectangleRender::StrokeLift = 0.5f
staticconstexpr

Distance the border is moved towards the viewer, along the forward axis of the entity, so it draws over the fill. Half the depth of one layer.

Definition at line 158 of file rectangle_render.hpp.


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