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

An ecs::ComponentRegistry whose storages for the general-purpose components (geometry, appearance, interaction) exist from construction. More...

#include <headers/guillaume/component_registry.hpp>

Inheritance diagram for guillaume::ComponentRegistry:
Collaboration diagram for guillaume::ComponentRegistry:

Public Member Functions

 ComponentRegistry (void)
 Create the registry with one empty storage per listed component type.
virtual ~ComponentRegistry (void)=default
 Destroy the registry and every component it stores.
Public Member Functions inherited from guillaume::ecs::ComponentRegistryFiller< components::Bound, components::Focus, components::MouseHoverInteraction, components::MouseButtonInteraction, components::HandHoverInteraction, components::HandButtonInteraction, components::HandPinchInteraction, components::HandPokeInteraction, components::HandSqueezeInteraction, components::HandThumbRestInteraction, components::HandThumbStickInteraction, components::HandTriggerInteraction, components::Text, components::Transform, components::Color, components::Borders, components::Image, components::Mesh, components::Layout, components::Value, components::Range, components::Scrollable, components::DragInteraction, components::Selectable, components::SelectionGroup, components::Animation, components::Overlay, components::TextField, components::Ellipse, components::Ring, components::Arc, components::Line, components::Elevation, components::Scrim, components::Clip, components::StyleState, components::Accessibility >
 ComponentRegistryFiller (void)
 Create the registry with one empty storage per listed component type.
virtual ~ComponentRegistryFiller (void)=default
 Destroy the registry and every component it stores.
Public Member Functions inherited from guillaume::ecs::ComponentRegistry
 ComponentRegistry (void)=default
 Create a registry that holds no component.
 ~ComponentRegistry (void)=default
 Destroy the registry and every component it stores.
template<InheritFromComponent... NeededComponentTypes>
void registerComponentsForEntity (const Entity::Identifier &entityIdentifier)
 Give an entity one default-constructed component of each listed type.
template<InheritFromComponent ComponentType, typename... Args>
ComponentType & addComponent (const Entity::Identifier &entityIdentifier, Args &&...args)
 Construct a component for an entity, replacing the one it already has, if any.
template<InheritFromComponent ComponentType>
bool hasComponent (const Entity::Identifier &entityIdentifier) const
 Tell whether an entity has a component of a given type.
template<InheritFromComponent ComponentType>
void removeComponent (const Entity::Identifier &entityIdentifier)
 Delete one component of an entity. Does nothing when the entity does not have it.
void removeEntity (const Entity::Identifier &entityIdentifier)
 Delete every component of an entity, of every type.
bool hasChanged (const Entity::Identifier &entityIdentifier) const
 Tell whether at least one component of an entity was modified since the flags were last reset.
void resetChangedFlags (void)
 Mark every component of every entity as unchanged.
template<InheritFromComponent ComponentType>
ComponentType & getComponent (const Entity::Identifier &entityIdentifier)
 Get a component of an entity, to read or modify it.
template<InheritFromComponent ComponentType>
const ComponentType & getComponent (const Entity::Identifier &entityIdentifier) const
 Get a component of an entity, read-only.

Additional Inherited Members

Protected Member Functions inherited from guillaume::ecs::ComponentRegistry
template<InheritFromComponent ComponentType>
void registerNewComponentType (void)
 Create the (empty) storage of a component type ahead of its first use.

Detailed Description

An ecs::ComponentRegistry whose storages for the general-purpose components (geometry, appearance, interaction) exist from construction.

It adds no function to ecs::ComponentRegistry, which is the type used everywhere in the library (Scene::getComponentRegistry returns an ecs::ComponentRegistry). Since a registry creates the storage of a component type on its first use, listing a type here is never required: the widget configuration components, for instance, are not listed.

See also
ecs::ComponentRegistry
ecs::ComponentRegistryFiller

Definition at line 82 of file component_registry.hpp.


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