|
guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
|
Turns the bound of an entity into the rectangle the engine clips drawing to. More...
#include <headers/guillaume/systems/clip.hpp>


Public Member Functions | |
| Clip (utility::Engine &engine) | |
| Create the system in the Layout phase. | |
| ~Clip (void) override=default | |
| Destroy the system. The engine scissor is left as it is. | |
| void | prepare (void) override |
| Clear the engine scissor. Called once per frame before the entities are visited, so a frame without any enabled clip draws unclipped. | |
| void | update (const ecs::Entity::Identifier &entityIdentifier) override |
| Resolve the clip rectangle of one entity, store it in its components::Clip and make it the engine scissor. | |
| Public Member Functions inherited from guillaume::ecs::SystemFiller< components::Transform, components::Bound, components::Clip > | |
| 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(). | |
| virtual void | cleanup (void) |
| Called once per pass, after the last update(). | |
Static Public Member Functions | |
| static components::Clip::Rect | computeRect (const utility::graphic::PoseF &pose, float width, float height, float margin) |
| Compute a clip rectangle from the pose and size of a bound. | |
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. | |
Turns the bound of an entity into the rectangle the engine clips drawing to.
Runs in the Layout phase on entities with Transform, Bound and Clip.
The scissor is cleared once per frame in prepare(), then set by each enabled clip entity. The render systems that run later in the frame draw with whatever scissor is left.
Things to know:
| guillaume::systems::Clip::Clip | ( | utility::Engine & | engine | ) |
|
static |
Compute a clip rectangle from the pose and size of a bound.
The rectangle starts at the X and Y of the pose and is shrunk by margin on its four sides. The orientation is ignored.
| pose | Pose of the top-left corner of the bound. |
| width | Width of the bound, in dp. |
| height | Height of the bound, in dp. |
| margin | Inset applied to each side, in dp. A negative value grows the rectangle. |
Definition at line 40 of file clip.cpp.

|
overridevirtual |
Clear the engine scissor. Called once per frame before the entities are visited, so a frame without any enabled clip draws unclipped.
Reimplemented from guillaume::ecs::System.
|
overridevirtual |
Resolve the clip rectangle of one entity, store it in its components::Clip and make it the engine scissor.
| entityIdentifier | The entity to resolve. It is skipped when its clip is disabled, and skipped with a log message when one of the three components is missing. |
Implements guillaume::ecs::System.
Definition at line 53 of file clip.cpp.
