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

Draws a horizontal stroke, solid or dashed, for every entity that has a components::Line. More...

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

Inheritance diagram for guillaume::systems::LineRender:
Collaboration diagram for guillaume::systems::LineRender:

Public Member Functions

 LineRender (utility::Engine &engine)
 Create the system in the Render phase.
 ~LineRender (void) override=default
 Destroy the system. The engine objects it created are left in 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.
void update (const ecs::Entity::Identifier &entityIdentifier) override
 Rebuild the mesh of one stroke and upload it, 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::Line >
 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 a stroke placed on the top or bottom edge is moved towards the viewer, along the forward axis of the entity, so it draws over the fill of the entity carrying it. 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 a horizontal stroke, solid or dashed, for every entity that has a components::Line.

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

  • components::Transform gives the top-left corner of the bound and the orientation.
  • components::Bound gives the length of the stroke (its width) and the height the stroke is placed in.
  • components::Line gives the thickness, the dash pattern, the placement (centered, along the top edge or along the bottom edge) and an optional color.
  • components::Color gives the color when the Line has none of its own.

A Line can live on an entity that also has a background (the underline of a text field, the dash of an indeterminate checkbox). A stroke placed on the top or bottom edge is then moved by StrokeLift towards the viewer so the background does not hide it. A centered stroke is not moved.

See also
RenderHandleMap, shape::buildLineMesh
components::Line, systems::Divider

Definition at line 65 of file line_render.hpp.

Constructor & Destructor Documentation

◆ LineRender()

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

Create the system in the Render phase.

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

Definition at line 33 of file line_render.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ cleanup()

void guillaume::systems::LineRender::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 46 of file line_render.cpp.

Here is the call graph for this function:

◆ prepare()

void guillaume::systems::LineRender::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 41 of file line_render.cpp.

Here is the call graph for this function:

◆ update()

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

Rebuild the mesh of one stroke and upload it, 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 51 of file line_render.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ StrokeLift

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

Distance a stroke placed on the top or bottom edge is moved towards the viewer, along the forward axis of the entity, so it draws over the fill of the entity carrying it. Half the depth of one layer.

Definition at line 80 of file line_render.hpp.


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