|
guillaume 2026.6.1
A C++ UI framework designed for modern desktop and extended reality (XR) applications.
|
Configures a ProgressIndicator, then builds it and registers it in the entity registry given at construction. More...
#include <headers/guillaume/entities/progress_indicator.hpp>


Public Member Functions | |
| Builder (ecs::ComponentRegistry &componentRegistry, ecs::EntityRegistry &entityRegistry) | |
| Create a builder set to the defaults of reset(). | |
| std::shared_ptr< ProgressIndicator > | buildEntity (void) override |
| Build a progress indicator and its track and fill children from the current configuration, without registering it or setting its parent. | |
| void | reset (void) override |
| Restore the defaults: LinearDeterminate variant, value 0, a 200 dp long bar, a 48 dp wide ring and a default pose. | |
| Builder & | withPose (const utility::graphic::PoseF &pose) |
| Set the pose the indicator is created with. | |
| Builder & | withVariant (Variant variant) |
| Set the indicator variant. | |
| Builder & | withValue (float value) |
| Set the progress the indicator starts with. | |
| Builder & | withWidth (float width) |
| Set the length of the bar of the linear variants. | |
| Builder & | withSize (float size) |
| Set the diameter of the ring of the circular variants. | |
| std::shared_ptr< ProgressIndicator > | makeProgressIndicator (std::shared_ptr< ecs::Entity > parent, Variant variant, float value) |
Build a progress indicator, register it under parent and reset the builder. | |
| Public Member Functions inherited from guillaume::entities::EntityBuilderBase< ProgressIndicator > | |
| EntityBuilderBase (ecs::ComponentRegistry &componentRegistry, ecs::EntityRegistry &entityRegistry) | |
| Construct a builder bound to two registries. | |
| ~EntityBuilderBase (void) override=default | |
| Default destructor. | |
| std::shared_ptr< ProgressIndicator > | registerEntity (std::shared_ptr< ecs::Entity > parent) |
| Build the widget, attach it to its parent, hand it to the entity registry, then reset the builder to its defaults. | |
| Public Member Functions inherited from guillaume::ecs::EntityBuilder | |
| EntityBuilder (ecs::ComponentRegistry &componentRegistry, ecs::EntityRegistry &entityRegistry) | |
| Create a builder working on a pair of registries, normally those of one scene. | |
| virtual | ~EntityBuilder (void)=default |
| Virtual destructor. | |
Additional Inherited Members | |
| Protected Member Functions inherited from guillaume::ecs::EntityBuilder | |
| ComponentRegistry & | getComponentRegistry (void) |
| Get the registry in which the builder creates components. | |
| EntityRegistry & | getEntityRegistry (void) |
| Get the registry in which the builder registers the entities it creates. | |
Configures a ProgressIndicator, then builds it and registers it in the entity registry given at construction.
Definition at line 118 of file progress_indicator.hpp.
| guillaume::entities::ProgressIndicator::Builder::Builder | ( | ecs::ComponentRegistry & | componentRegistry, |
| ecs::EntityRegistry & | entityRegistry ) |
Create a builder set to the defaults of reset().
| componentRegistry | The registry the indicator's components are created in. |
| entityRegistry | The registry the built indicators are added to. |
Definition at line 161 of file progress_indicator.cpp.

|
overridevirtual |
Build a progress indicator and its track and fill children from the current configuration, without registering it or setting its parent.
Implements guillaume::entities::EntityBuilderBase< ProgressIndicator >.
Definition at line 171 of file progress_indicator.cpp.

| std::shared_ptr< ProgressIndicator > guillaume::entities::ProgressIndicator::Builder::makeProgressIndicator | ( | std::shared_ptr< ecs::Entity > | parent, |
| Variant | variant, | ||
| float | value ) |
Build a progress indicator, register it under parent and reset the builder.
The arguments replace the variant and value set before; the pose, length and diameter are kept.
| parent | The entity the indicator is attached to. |
| variant | The indicator variant. |
| value | The progress it starts with, 0 to 1; a value outside is clamped. Not drawn by the indeterminate variants. |
Definition at line 242 of file progress_indicator.cpp.

|
overridevirtual |
Restore the defaults: LinearDeterminate variant, value 0, a 200 dp long bar, a 48 dp wide ring and a default pose.
Implements guillaume::ecs::EntityBuilder.
Definition at line 187 of file progress_indicator.cpp.

| ProgressIndicator::Builder & guillaume::entities::ProgressIndicator::Builder::withPose | ( | const utility::graphic::PoseF & | pose | ) |
Set the pose the indicator is created with.
| pose | The position and orientation of the widget. Default: a default-constructed pose. |
Definition at line 207 of file progress_indicator.cpp.
| ProgressIndicator::Builder & guillaume::entities::ProgressIndicator::Builder::withSize | ( | float | size | ) |
Set the diameter of the ring of the circular variants.
| size | The diameter, in dp. Default: 48. The linear variants ignore it. |
Definition at line 235 of file progress_indicator.cpp.
| ProgressIndicator::Builder & guillaume::entities::ProgressIndicator::Builder::withValue | ( | float | value | ) |
Set the progress the indicator starts with.
| value | The progress, 0 to 1; a value outside is clamped. Default: 0. |
Definition at line 222 of file progress_indicator.cpp.
| ProgressIndicator::Builder & guillaume::entities::ProgressIndicator::Builder::withVariant | ( | Variant | variant | ) |
Set the indicator variant.
| variant | The variant. Default: Variant::LinearDeterminate. |
Definition at line 215 of file progress_indicator.cpp.

| ProgressIndicator::Builder & guillaume::entities::ProgressIndicator::Builder::withWidth | ( | float | width | ) |
Set the length of the bar of the linear variants.
| width | The length, in dp. Default: 200. The circular variants ignore it. |
Definition at line 229 of file progress_indicator.cpp.