Rules. Every class here runs each frame on the entities that have the components it declares.
More...
|
| class | Animation |
| | Moves every running animation forward by the time of one frame. More...
|
| class | AppBar |
| | Styles an app bar and lays out its navigation button, title and action buttons in a row. More...
|
| class | ArcRender |
| | Draws a part of a ring (an arc with a thickness and flat ends) for every entity that has a components::Arc. More...
|
| class | Backdrop |
| | Fades the backdrop of a modal widget in and keeps it behind its owner. More...
|
| class | Badge |
| | Sizes and colors a badge (the small dot or counter drawn over another widget) and fades it in and out. More...
|
| class | Button |
| | Input and content rules shared by every button variant: press, release, toggle, click and long press. More...
|
| class | Card |
| | Styles a card, animates its elevation while pressed and arranges its cover, title, content and actions sections. More...
|
| class | Checkbox |
| | The rules of a checkbox: toggling it, coloring its box and placing its label. More...
|
| class | Chip |
| | The rules of a chip: pressing it, selecting it, closing it, coloring it and arranging its icons and label. More...
|
| class | Clip |
| | Turns the bound of an entity into the rectangle the engine clips drawing to. More...
|
| class | CommonButton |
| | Colors, sizes and lays out a common button: the elevated, filled, tonal, outlined and text buttons, and the segments of a segmented button. More...
|
| class | Dialog |
| | Styles a dialog panel, stacks its icon, title, message and action row, and shows or hides the backdrop behind it. More...
|
| class | Divider |
| | Turns the configuration of a divider (a thin horizontal separator line) into the geometry that is drawn. More...
|
| class | Drag |
| | Turns "button held while the pointer moves" into a drag gesture. More...
|
| class | ElevationRender |
| | Draws the soft shadow of every entity that has a components::Elevation. More...
|
| class | EllipseRender |
| | Draws a filled ellipse (a disc when the bound is square) for every entity that has a components::Ellipse. More...
|
| class | ExtendedFloatingActionButton |
| | Colors, sizes and lays out an extended floating action button: a FAB that shows a label beside its icon and can collapse to the icon alone. More...
|
| class | FloatingActionButton |
| | Colors, sizes and lays out a floating action button (FAB): the raised square button carrying the main action of a screen. More...
|
| | Opens and closes a floating action button menu (speed dial): a trigger button that reveals a column of action buttons above it. More...
|
| class | Focus |
| | Decides which single entity has the keyboard focus. More...
|
| class | FocusRingRender |
| | Draws the focus indicator: an outline around the entity that has the keyboard focus. More...
|
| class | GlyphRender |
| | Draws the icon of every entity that has a components::Glyph. More...
|
| class | HandButton |
| | Tracks which XR controller buttons are held on which entities. More...
|
| class | HandEventSystem |
| | Base of the XR hand input systems: the wiring they share. More...
|
| class | HandRaySystem |
| | Base of the hand input systems that point at an entity: a gesture counts for the entity the hand ray hits. More...
|
| class | HandMotion |
| | Tracks which entities an XR hand is pointing at. More...
|
| class | HandPinch |
| | Marks the entities an XR hand pinches (thumb and index brought together while pointing at them). More...
|
| class | HandPoke |
| | Marks the entities an XR hand pokes (a fingertip pushed toward them). More...
|
| class | HandSqueeze |
| | Receives XR hand squeeze events (the grip of a controller). More...
|
| class | HandThumbRest |
| | Receives XR thumb-rest events (the thumb touching the rest pad of a controller). More...
|
| class | HandThumbStick |
| | Receives XR thumb-stick events (the joystick of a controller). More...
|
| class | HandTrigger |
| | Receives XR trigger events (the index trigger of a controller). More...
|
| class | IconButton |
| | Colors, sizes and lays out an icon button: a round button that shows a single icon and no label. More...
|
| class | ImageRender |
| | Draws the picture of every entity that has a components::Image, stretched over its bound. More...
|
| class | KeyboardControl |
| | Applies editing keys (arrows, Home, End, Delete, Backspace) to editable text. More...
|
| class | Layout |
| | Arranges the children of a container in a row or a column and sizes the container around them. More...
|
| class | LineRender |
| | Draws a horizontal stroke, solid or dashed, for every entity that has a components::Line. More...
|
| class | List |
| | Styles a list, stacks its rows and folds its accordions. More...
|
| class | LoadingIndicator |
| | Draws an indeterminate loading indicator: a rotating arc (circular variant) or a bar sliding along a track (linear variant). More...
|
| struct | MeasureGlyphCacheKey |
| | Key of the size cache of MeasureGlyph: everything a measured icon size is looked up by. More...
|
| class | MeasureGlyph |
| | Computes the size of every icon and writes it into its Bound, so the layout knows how much room the icon takes. More...
|
| struct | MeasureMeshCacheKey |
| | Key of the size cache of MeasureMesh: the path of the model file. More...
|
| class | MeasureMesh |
| | Computes the size of every 3D model and writes it into its Bound, so the layout knows how much room the model takes. More...
|
| struct | MeasureTextCacheKey |
| | Key of the size cache of MeasureText: everything a measured size is looked up by. More...
|
| class | MeasureText |
| | Computes the size of every text and writes it into its Bound, so the layout knows how much room a label takes. More...
|
| | Styles a menu, sizes its rows to the widest one and places the menu below or above its anchor. More...
|
| class | MeshRender |
| | Draws the 3D model of every entity that has a components::Mesh. More...
|
| class | MouseButton |
| | Tracks which mouse buttons are held on which entities. More...
|
| class | MouseMotion |
| | Tracks which entities the mouse pointer is over. More...
|
| class | NavigationBar |
| | Styles a navigation bar, shares its width between its destinations and keeps exactly one of them selected. More...
|
| class | NavigationBarDestination |
| | Styles one destination of a navigation bar (an icon in a pill with a label under it and an optional badge) and places those children. More...
|
| class | NavigationDrawer |
| | Styles a navigation drawer, stacks its entries in a column and keeps exactly one of its destinations selected. More...
|
| class | NavigationDrawerDestination |
| | Styles one destination of a navigation drawer and places its icon, label and trailing text. More...
|
| class | Overlay |
| | Keeps the stack of open overlays (dialogs, menus, snackbars) and closes the top one on Escape or when its delay runs out. More...
|
| class | ProgressIndicator |
| | Draws a progress indicator: a track and a fill that shows a value from 0 to 1, as a bar or as a ring. More...
|
| class | RadioButton |
| | The rules of a radio button: selecting it, coloring its ring and placing its dot and label. More...
|
| class | RadioGroup |
| | The rules of a radio group: a list of radio buttons of which at most one is selected. More...
|
| class | RectangleRender |
| | Draws the background of an entity: a filled rectangle with rounded corners and an optional border. More...
|
| struct | RenderHandle |
| | What a render system remembers about the engine object it created for one entity. More...
|
| class | RenderHandleMap |
| | The engine objects one render system owns, keyed by entity identifier. More...
|
| class | RingRender |
| | Draws a full ring (a circle outline with a thickness) for every entity that has a components::Ring. More...
|
| class | ScrimRender |
| | Draws a scrim: a flat, usually translucent rectangle covering the whole bound of an entity. A modal backdrop is drawn this way. More...
|
| class | Scroll |
| | Scrolls content with the mouse wheel. More...
|
| class | Search |
| | Styles a search field and lays out the children that its query, loading state and trailing icon call for. More...
|
| class | SegmentedButton |
| | Arranges a segmented button: a row of joined toggle buttons of which one (Single mode) or several (Multi mode) are selected. More...
|
| class | Selection |
| | Keeps at most one child selected in each selection group. More...
|
| class | Snackbar |
| | Styles a snackbar (a short message with an optional action that disappears on its own) and handles its dismissal. More...
|
| class | StyleState |
| | Summarizes the input state of an entity into its components::StyleState, the one component widget systems read to choose a look. More...
|
| class | SurfaceTone |
| | Gives a surface the color and the shadow that match its elevation level in the active theme. More...
|
| class | Switch |
| | The rules of a switch: turning it on and off, coloring its track and placing its thumb, thumb icon and label. More...
|
| class | TextField |
| | Styles a text field, arranges its label, input, affixes, icons and supporting text, and reports what the user typed. More...
|
| class | TextInput |
| | Adds typed text to editable text. More...
|
| class | TextRender |
| | Draws the string of every entity that has a components::Text. More...
|
| class | Tooltip |
| | Styles a tooltip, shows it after its anchor has been hovered for a while and places it next to that anchor. More...
|
| class | Typography |
| | Turns the type-scale role of a text (Body Large, Label Medium, ...) into the font metrics of the active theme. More...
|
|
| void | registerCoreSystems (ecs::SystemRegistry &systemRegistry, event::EventBus &eventBus, utility::Engine &engine, std::shared_ptr< utility::RessourceProvider > ressourceProvider) |
| | Register every built-in system of the library in a registry.
|
| bool | isInteractive (const ecs::ComponentRegistry ®istry, const ecs::Entity::Identifier &entityIdentifier) |
| | Whether an entity accepts input.
|
| utility::math::Vector2F | hitMargin (const ecs::ComponentRegistry ®istry, const ecs::Entity::Identifier &entityIdentifier) |
| | Extra hit area of an entity around its Bound, in dp.
|
| bool | hitTest (const utility::graphic::RayF &ray, const utility::graphic::PoseF &pose, const components::Bound &bound, const utility::math::Vector2F &margin) |
| | Whether a ray crosses the rectangle of an entity, grown by a margin.
|
| utility::graphic::Color32Bit | schemeColor (SchemeColorRole role) |
| | Look up a color role in the color scheme of the active theme.
|
| utility::graphic::Color32Bit | schemeColor (SchemeColorRole role) |
| | Look up a color role in the color scheme of the active theme.
|
| utility::graphic::Color32Bit | schemeColor (SchemeColorRole role) |
| | Look up a color role in the color scheme of the active theme.
|
| utility::graphic::Color32Bit | transparentColor (void) |
| | The color written to hide a fill or an outline without removing its component.
|
| utility::graphic::Color32Bit | disabledContentColor (void) |
| | Color of the icon, label or outline of a disabled widget.
|
| utility::graphic::Color32Bit | schemeColor (SchemeColorRole role) |
| | Look up a color role in the color scheme of the active theme.
|
| utility::graphic::Color32Bit | transparentColor (void) |
| | The color written to hide a fill or an outline without removing its component.
|
| utility::graphic::Color32Bit | disabledContainerColor (void) |
| | Fill color of the container of a disabled widget.
|
| utility::graphic::Color32Bit | disabledContentColor (void) |
| | Color of the icon, label or outline of a disabled widget.
|
| utility::graphic::Color32Bit | schemeColor (SchemeColorRole role) |
| | Look up a color role in the color scheme of the active theme.
|
| utility::graphic::Color32Bit | transparentColor (void) |
| | The color written to hide a fill or an outline without removing its component.
|
| utility::graphic::Color32Bit | schemeColor (SchemeColorRole role) |
| | Look up a color role in the color scheme of the active theme.
|
| utility::graphic::Color32Bit | disabledContentColor (void) |
| | Color of the icon, label or outline of a disabled widget.
|
| utility::graphic::Color32Bit | schemeColor (SchemeColorRole role) |
| | Look up a color role in the color scheme of the active theme.
|
| utility::graphic::Color32Bit | transparentColor (void) |
| | The color written to hide a fill or an outline without removing its component.
|
| utility::graphic::Color32Bit | disabledContentColor (void) |
| | Color of the icon, label or outline of a disabled widget.
|
| utility::graphic::Color32Bit | schemeColor (SchemeColorRole role) |
| | Look up a color role in the color scheme of the active theme.
|
| utility::graphic::Color32Bit | transparentColor (void) |
| | The color written to hide a fill or an outline without removing its component.
|
| utility::graphic::Color32Bit | schemeColor (SchemeColorRole role) |
| | Look up a color role in the color scheme of the active theme.
|
| utility::graphic::Color32Bit | transparentColor (void) |
| | The color written to hide a fill or an outline without removing its component.
|
| utility::graphic::Color32Bit | schemeColor (SchemeColorRole role) |
| | Look up a color role in the color scheme of the active theme.
|
| utility::graphic::Color32Bit | disabledContentColor (void) |
| | Color of the icon, label or outline of a disabled widget.
|
| utility::graphic::Color32Bit | schemeColor (SchemeColorRole role) |
| | Look up a color role in the color scheme of the active theme.
|
| utility::graphic::Color32Bit | transparentColor (void) |
| | The color written to hide a fill or an outline without removing its component.
|
| utility::graphic::Color32Bit | disabledContentColor (void) |
| | Color of the icon, label or outline of a disabled widget.
|
| utility::graphic::Color32Bit | schemeColor (SchemeColorRole role) |
| | Look up a color role in the color scheme of the active theme.
|
| utility::graphic::Color32Bit | transparentColor (void) |
| | The color written to hide a fill or an outline without removing its component.
|
| utility::graphic::Color32Bit | schemeColor (SchemeColorRole role) |
| | Look up a color role in the color scheme of the active theme.
|
| utility::graphic::Color32Bit | transparentColor (void) |
| | The color written to hide a fill or an outline without removing its component.
|
| utility::graphic::Color32Bit | schemeColor (SchemeColorRole role) |
| | Look up a color role in the color scheme of the active theme.
|
| utility::graphic::Color32Bit | transparentColor (void) |
| | The color written to hide a fill or an outline without removing its component.
|
| utility::graphic::Color32Bit | disabledContainerColor (void) |
| | Fill color of the container of a disabled widget.
|
| utility::graphic::Color32Bit | disabledContentColor (void) |
| | Color of the icon, label or outline of a disabled widget.
|
| utility::graphic::Color32Bit | schemeColor (SchemeColorRole role) |
| | Look up a color role in the color scheme of the active theme.
|
| utility::graphic::Color32Bit | transparentColor (void) |
| | The color written to hide a fill or an outline without removing its component.
|
| utility::graphic::Color32Bit | disabledContainerColor (void) |
| | Fill color of the container of a disabled widget.
|
| utility::graphic::Color32Bit | disabledContentColor (void) |
| | Color of the icon, label or outline of a disabled widget.
|
| utility::graphic::Color32Bit | schemeColor (SchemeColorRole role) |
| | Look up a color role in the color scheme of the active theme.
|
| utility::graphic::Color32Bit | transparentColor (void) |
| | The color written to hide a fill or an outline without removing its component.
|
| utility::graphic::Color32Bit | schemeColor (SchemeColorRole role) |
| | Look up a color role in the color scheme of the active theme.
|
| utility::graphic::Color32Bit | transparentColor (void) |
| | The color written to hide a fill or an outline without removing its component.
|
Rules. Every class here runs each frame on the entities that have the components it declares.
A system reads and writes components by entity identifier and never needs an entity object. Systems are grouped by phase:
Widget systems expose their rules as static functions taking a registry and an identifier (systems::Checkbox::toggle(registry, id)), so they can be called outside the frame loop and tested without entity objects. Shared helpers live in systems::style, systems::interaction and systems::placement.
- See also
- guillaume::systems::registerCoreSystems for the registration order.