A layout container that arranges Positionable objects in a grid. More...

#include <Grid.h>

Inheritance diagram for ml::Grid:

Public Types
using	State
	The enum type this manager stores flags for.

Public Member Functions
	Grid ()
	Construct a single-row grid with default spacing.
	Grid (sf::Vector2u size)
	Construct a grid with a specified column and row count.
void	addComponent (Core &component)
	Add a `Core` object to the grid and reposition all items.
template<class T>
void	center (T &obj)
	Center this object within `obj` (both axes).
template<class T>
void	centerHorizonally (T &obj)
	Center this object horizontally within `obj`.
void	centerText (sf::Text &obj)
	Center an `sf::Text` object within this object's bounds.
template<class T>
void	centerVertically (T &obj)
	Center this object vertically within `obj`.
bool	checkFlag (State state) const
	Return the current value of a flag.
void	disableFlag (State state)
	Set a flag to `false`.
void	enableFlag (State state)
	Set a flag to `true`.
sf::FloatRect	getGlobalBounds () const
	Return the axis-aligned bounding box of the entire grid.
sf::Vector2f	getPosition () const
	Return the current world-space origin of the grid.
virtual sf::RenderStates	getRenderStates () const
	Returns the SFML render states to use when drawing this object.
int	getRow () const
	Return the current number of columns.
float	getSpacing () const
	Return the current spacing between cells in pixels.
bool	isScrolling ()
	Return `true` while a `moveTo` or `moveDistance` animation is in progress.
void	moveDistance (sf::Vector2f distance, float seconds=1.f)
	Animate by a relative offset from the current position.
void	moveTo (sf::FloatRect position, float seconds=1.f)
	Animate to a position defined by a `FloatRect` origin.
void	moveTo (sf::Vector2f position, float seconds=1.f)
	Animate to an absolute world-space position.
void	onBlur (std::function< void()> callback)
	Register a no-argument callback invoked when this component loses keyboard focus.
void	onBlur (std::function< void(const std::optional< sf::Event > &)> callback)
	Register a callback invoked when this component loses keyboard focus, receiving the raw SFML event.
void	onClick (std::function< void()> callback)
	Register a no-argument callback invoked when this component is clicked.
void	onClick (std::function< void(const std::optional< sf::Event > &event)> callback)
	Register a callback invoked when this component is clicked, receiving the raw SFML event.
void	onFocus (std::function< void()> callback)
	Register a no-argument callback invoked when this component gains keyboard focus.
void	onFocus (std::function< void(const std::optional< sf::Event > &)> callback)
	Register a callback invoked when this component gains keyboard focus, receiving the raw SFML event.
void	onHover (std::function< void()> callback)
	Register a no-argument callback invoked when the mouse enters this component's bounds.
void	onHover (std::function< void(const std::optional< sf::Event > &event)> callback)
	Register a callback invoked when the mouse enters this component's bounds, receiving the raw SFML event.
void	onKeypress (std::function< void()> callback)
	Register a no-argument callback invoked when a key is pressed while this component has focus.
void	onKeypress (std::function< void(const std::optional< sf::Event > &)> callback)
	Register a callback invoked when a key is pressed while this component has focus, receiving the raw SFML event.
void	onKeyRelease (std::function< void()> callback)
	Register a no-argument callback invoked when a key is released while this component has focus.
void	onKeyRelease (std::function< void(const std::optional< sf::Event > &)> callback)
	Register a callback invoked when a key is released while this component has focus, receiving the raw SFML event.
void	onMouseMoved (std::function< void()> callback)
	Register a no-argument callback invoked whenever the mouse moves anywhere in the window.
void	onMouseMoved (std::function< void(const std::optional< sf::Event > &)> callback)
	Register a callback invoked whenever the mouse moves anywhere in the window, receiving the raw SFML event.
void	onMousePressed (std::function< void()> callback)
	Register a no-argument callback invoked when a mouse button is pressed anywhere in the window.
void	onMousePressed (std::function< void(const std::optional< sf::Event > &)> callback)
	Register a callback invoked when a mouse button is pressed, receiving the raw SFML event.
void	onMouseReleased (std::function< void()> callback)
	Register a no-argument callback invoked when a mouse button is released anywhere in the window.
void	onMouseReleased (std::function< void(const std::optional< sf::Event > &)> callback)
	Register a callback invoked when a mouse button is released, receiving the raw SFML event.
void	onScroll (std::function< void()> callback)
	Register a no-argument callback invoked when the mouse wheel is scrolled while the cursor is over this component.
void	onScroll (std::function< void(const std::optional< sf::Event > &)> callback)
	Register a callback invoked when the mouse wheel is scrolled while the cursor is over this component, receiving the SFML event.
void	onTextEntered (std::function< void()> callback)
	Register a no-argument callback invoked when a unicode character is entered while this component has focus.
void	onTextEntered (std::function< void(const std::optional< sf::Event > &)> callback)
	Register a callback invoked when a unicode character is entered while this component has focus, receiving the raw SFML event.
void	onUnhover (std::function< void()> callback)
	Register a no-argument callback invoked when the mouse leaves this component's bounds.
void	onUnhover (std::function< void(const std::optional< sf::Event > &event)> callback)
	Register a callback invoked when the mouse leaves this component's bounds, receiving the raw SFML event.
void	onUpdate (std::function< void()> callback)
	Register a no-argument callback invoked every frame.
void	onUpdate (std::function< void(const std::optional< sf::Event > &)> callback)
	Register a callback invoked every frame, receiving the SFML event.
void	onWindowFocusGained (std::function< void()> callback)
	Register a no-argument callback invoked when the application window gains OS focus.
void	onWindowFocusGained (std::function< void(const std::optional< sf::Event > &)> callback)
	Register a callback invoked when the application window gains OS focus, receiving the raw SFML event.
void	onWindowFocusLost (std::function< void()> callback)
	Register a no-argument callback invoked when the application window loses OS focus.
void	onWindowFocusLost (std::function< void(const std::optional< sf::Event > &)> callback)
	Register a callback invoked when the application window loses OS focus, receiving the raw SFML event.
void	onWindowResized (std::function< void()> callback)
	Register a no-argument callback invoked when the application window is resized.
void	onWindowResized (std::function< void(const std::optional< sf::Event > &)> callback)
	Register a callback invoked when the application window is resized, receiving the raw SFML event.
virtual void	process (const std::string &key, const std::optional< sf::Event > &event)
	Invoke all callbacks registered for `key`.
template<typename ENUM_TYPE>
void	process (ENUM_TYPE eventName, const std::optional< sf::Event > &event)
	Invoke all callbacks registered for `eventName`.
template<typename ENUM_TYPE>
void	publish (ENUM_TYPE event, FilterCallback filter=[](EventReceiver &){ return true;}, SystemCallback resolve=nullptr, SystemCallback reject=nullptr)
	Fire an enum-keyed event to all matching subscribers.
template<class T>
void	setAbove (T &obj, float spacing=0)
	Position this object immediately above `obj`.
template<class T>
void	setBelow (T &obj, float spacing=0)
	Position this object immediately below `obj`.
void	setFlag (State state, bool status)
	Set a flag to an explicit value.
void	setFramerate (float framerate)
	Set the assumed framerate for movement interpolation.
template<class T>
void	setLeftOf (T &obj, float spacing=0)
	Position this object immediately to the left of `obj`.
void	setPosition (const sf::Vector2f &position)
	Set the world-space origin of the grid.
template<class T>
void	setRightOf (T &obj, float spacing=0)
	Position this object immediately to the right of `obj`.
void	setRow (int row)
	Set the number of columns per row.
void	setSpacing (float spacing)
	Set the spacing between cells.
template<typename ENUM_TYPE>
void	subscribe (ENUM_TYPE event, Callback callback)
	Subscribe to an enum-keyed event with a no-argument callback.
template<typename ENUM_TYPE>
void	subscribe (ENUM_TYPE event, EventCallback callback)
	Subscribe to an enum-keyed event with a full SFML event callback.
void	toggleFlag (State state)
	Flip a flag between `true` and `false`.
template<typename EnumType>
void	unsubscribe (EnumType event)
	Unsubscribe from a single event by enum value.
void	unsubscribeAll ()
	Remove all event subscriptions for this component.

Static Public Member Functions
static void	addComponent (Positionable &component)
	Register a `T` object with this manager.
static void	clear ()
	Remove all registered objects.
static void	clearPending ()
	Discard all pending operations without executing them.
static const std::vector< Positionable * > &	getComponents ()
	Return a read-only view of all currently registered objects.
static bool	isBusy ()
	Return `true` if the manager is currently iterating.
static void	processPending ()
	Flush all pending operations immediately.
static bool	removeComponent (Positionable &component)
	Unregister a `T` object by reference.

Static Protected Member Functions
static void	beginBusy ()
	Signal that iteration has begun.
static void	deferOrExecute (std::function< void()> operation)
	Execute `operation` now if safe, otherwise queue it.
static void	endBusy ()
	Signal that iteration has ended; flush pending operations.

Static Protected Attributes
static int	busyDepth
	Iteration nesting depth. Operations are deferred while this is > 0.
static std::vector< std::function< void()> >	pendingOperations
	Queue of operations pending until the current iteration completes.

Detailed Description

A layout container that arranges Positionable objects in a grid.

Grid acts as both a CoreManager<Positionable> (it owns and manages a collection of positioned objects) and a Core (it has its own position and bounds, so it can be placed in the scene like any other framework object).

When components are added via addComponent, or when the grid's position, row count, or spacing changes, reposition() recalculates each component's world-space position so items flow left-to-right, top-to-bottom in equal-sized cells.

Grid is declared final — it is not intended to be subclassed.

Usage

ml::Grid grid({4, 3}); // 4 columns, 3 rows
grid.setPosition({50.f, 100.f});
grid.setSpacing(8.f);
 
for (auto& tile : tiles)
    grid.addComponent(tile);
 
// Grid itself does not need to be added to the app —
// its managed components are positioned directly.

Layout model

Items are placed in row-major order. The cell size is determined by the largest item dimensions seen so far (tracked via max_width and max_height). spacing is added between every cell.

See also: CoreManager, Core, Positionable

Definition at line 48 of file Grid.h.

Member Typedef Documentation

◆ State

using ml::FlagManager< Flag >::State

inherited

The enum type this manager stores flags for.

Definition at line 62 of file FlagManager.h.

Constructor & Destructor Documentation

◆ Grid() [1/2]

ml::Grid::Grid ( )

Construct a single-row grid with default spacing.

◆ Grid() [2/2]

ml::Grid::Grid ( sf::Vector2u size )

Construct a grid with a specified column and row count.

Parameters

size	`x` is the number of columns, `y` is the number of rows.

Member Function Documentation

◆ addComponent() [1/2]

void ml::CoreManager< Positionable >::addComponent ( Positionable & component )

staticinherited

Register a T object with this manager.

After registration, the object will receive update() and draw() calls each frame (for managers that drive those methods).

Parameters

component The object to register. Must outlive its registration.

◆ addComponent() [2/2]

void ml::Grid::addComponent ( Core & component )

Add a Core object to the grid and reposition all items.

The item is registered with the underlying CoreManager and its position is set according to the current grid layout.

Note: Do not copy or move a component after it has been added — the grid stores a raw pointer to it.

Parameters

component The component to add.

◆ beginBusy()

void ml::DeferredOperationsManager< CoreManager< Positionable > >::beginBusy ( )

staticprotectedinherited

Signal that iteration has begun.

Increments the busy-depth counter. Multiple nested calls are safe — operations remain deferred until the outermost endBusy() is reached.

◆ center()

template<class T>

void ml::Positionable::center ( T & obj )

inherited

Center this object within obj (both axes).

Template Parameters

T	Any type with `getGlobalBounds()`.

Parameters

obj	Container to center within.

◆ centerHorizonally()

template<class T>

void ml::Positionable::centerHorizonally ( T & obj )

inherited

Center this object horizontally within obj.

Template Parameters

T	Any type with `getGlobalBounds()`.

Parameters

obj	Container to center within.

◆ centerText()

void ml::Positionable::centerText ( sf::Text & obj )

inherited

Center an sf::Text object within this object's bounds.

Convenience overload for the common pattern of centering a text label inside a button or panel.

Parameters

obj	The `sf::Text` to reposition.

◆ centerVertically()

template<class T>

void ml::Positionable::centerVertically ( T & obj )

inherited

Center this object vertically within obj.

Template Parameters

T	Any type with `getGlobalBounds()`.

Parameters

obj	Container to center within.

◆ checkFlag()

bool ml::FlagManager< Flag >::checkFlag ( State state ) const

inherited

Return the current value of a flag.

Returns false for any flag that has never been explicitly set.

Parameters

state The flag to query.

Returns: true if the flag is enabled; false otherwise.

◆ clear()

void ml::CoreManager< Positionable >::clear ( )

staticinherited

Remove all registered objects.

If the collection is currently being iterated, the clear is deferred. After this call (or after the deferred clear executes), getComponents() returns an empty vector.

◆ clearPending()

void ml::DeferredOperationsManager< CoreManager< Positionable > >::clearPending ( )

staticinherited

Discard all pending operations without executing them.

Use during application shutdown or full reset when executing the queued operations would be unsafe (e.g., the objects they reference have already been destroyed).

◆ deferOrExecute()

void ml::DeferredOperationsManager< CoreManager< Positionable > >::deferOrExecute ( std::function< void()> operation )

staticprotectedinherited

Execute operation now if safe, otherwise queue it.

If busyDepth > 0 the operation is appended to pendingOperations and will run when the current iteration completes. If the manager is idle the operation executes immediately.

Parameters

operation The callable to execute or defer.

◆ disableFlag()

void ml::FlagManager< Flag >::disableFlag ( State state )

inherited

Set a flag to false.

Parameters

state The flag to disable.

◆ enableFlag()

void ml::FlagManager< Flag >::enableFlag ( State state )

inherited

Set a flag to true.

Parameters

state The flag to enable.

◆ endBusy()

void ml::DeferredOperationsManager< CoreManager< Positionable > >::endBusy ( )

staticprotectedinherited

Signal that iteration has ended; flush pending operations.

Decrements the busy-depth counter. When the counter reaches zero, all operations in pendingOperations are executed in FIFO order and the queue is cleared.

◆ getComponents()

const std::vector< Positionable * > & ml::CoreManager< Positionable >::getComponents ( )

staticnodiscardinherited

Return a read-only view of all currently registered objects.

The returned reference is valid until the next structural modification (add or remove). Do not store the reference across frames.

Returns: Const reference to the internal component pointer vector.

◆ getGlobalBounds()

sf::FloatRect ml::Grid::getGlobalBounds ( ) const

nodiscardvirtual

Return the axis-aligned bounding box of the entire grid.

Encompasses all managed components from the top-left origin to the bottom-right of the last cell (including spacing).

Returns: Bounding rectangle in world coordinates.

Implements ml::Positionable.

◆ getPosition()

sf::Vector2f ml::Grid::getPosition ( ) const

nodiscardvirtual

Return the current world-space origin of the grid.

Returns: Top-left position in world coordinates.

Implements ml::Positionable.

◆ getRenderStates()

virtual sf::RenderStates ml::Core::getRenderStates ( ) const

inlinevirtualinherited

Returns the SFML render states to use when drawing this object.

The default implementation returns a default-constructed sf::RenderStates (no transform, no texture, no blend mode override). Override to apply a custom shader, blend mode, or transform.

Returns: sf::RenderStates to pass to the SFML draw call.

Definition at line 80 of file Core.h.

◆ getRow()

int ml::Grid::getRow ( ) const

nodiscard

Return the current number of columns.

Returns: Column count.

◆ getSpacing()

float ml::Grid::getSpacing ( ) const

nodiscard

Return the current spacing between cells in pixels.

Returns: Spacing in pixels.

◆ isBusy()

bool ml::DeferredOperationsManager< CoreManager< Positionable > >::isBusy ( )

staticinherited

Return true if the manager is currently iterating.

Can be used by external code that needs to know whether a destructive operation will be deferred.

Returns: true when busyDepth > 0.

◆ isScrolling()

bool ml::Positionable::isScrolling ( )

inherited

Return true while a moveTo or moveDistance animation is in progress.

Returns: true if the waypoint queue is non-empty.

◆ moveDistance()

void ml::Positionable::moveDistance	(	sf::Vector2f	distance,
		float	seconds = 1.f )

inherited

Animate by a relative offset from the current position.

Equivalent to moveTo(getPosition() + distance, seconds).

Parameters

distance	Offset in world coordinates to move by.
seconds	Duration of the animation. Defaults to 1.0 s.

◆ moveTo() [1/2]

void ml::Positionable::moveTo	(	sf::FloatRect	position,
		float	seconds = 1.f )

inherited

Animate to a position defined by a FloatRect origin.

Convenience overload that uses the top-left of position as the target. Useful when positioning relative to layout rects.

Parameters

position	Rect whose origin is the animation target.
seconds	Duration of the animation. Defaults to 1.0 s.

◆ moveTo() [2/2]

void ml::Positionable::moveTo	(	sf::Vector2f	position,
		float	seconds = 1.f )

inherited

Animate to an absolute world-space position.

Populates an internal waypoint queue and advances through it on successive onUpdate ticks. The object's position at the start of the call is the implicit start point.

Parameters

position	Target position in world coordinates.
seconds	Duration of the animation. Defaults to 1.0 s.

◆ onBlur() [1/2]

void ml::Focusable::onBlur ( std::function< void()> callback )

inherited

Register a no-argument callback invoked when this component loses keyboard focus.

Parameters

callback Function invoked with no arguments when focus is lost.

◆ onBlur() [2/2]

void ml::Focusable::onBlur ( std::function< void(const std::optional< sf::Event > &)> callback )

inherited

Register a callback invoked when this component loses keyboard focus, receiving the raw SFML event.

Parameters

callback Function invoked with the SFML event when focus is lost.

◆ onClick() [1/2]

void ml::Clickable::onClick ( std::function< void()> callback )

inherited

Register a no-argument callback invoked when this component is clicked.

Replaces any previously registered onClick callback. The callback fires after the mouse button is released over this component.

Parameters

callback Function invoked with no arguments on click.

◆ onClick() [2/2]

void ml::Clickable::onClick ( std::function< void(const std::optional< sf::Event > &event)> callback )

inherited

Register a callback invoked when this component is clicked, receiving the raw SFML event.

Replaces any previously registered onClick callback.

Parameters

callback Function invoked with the SFML event on click.

◆ onFocus() [1/2]

void ml::Focusable::onFocus ( std::function< void()> callback )

inherited

Register a no-argument callback invoked when this component gains keyboard focus.

Parameters

callback Function invoked with no arguments when focus is gained.

◆ onFocus() [2/2]

void ml::Focusable::onFocus ( std::function< void(const std::optional< sf::Event > &)> callback )

inherited

Register a callback invoked when this component gains keyboard focus, receiving the raw SFML event.

Parameters

callback Function invoked with the SFML event when focus is gained.

◆ onHover() [1/2]

void ml::Hoverable::onHover ( std::function< void()> callback )

inherited

Register a no-argument callback invoked when the mouse enters this component's bounds.

Parameters

callback Function invoked with no arguments on hover enter.

◆ onHover() [2/2]

void ml::Hoverable::onHover ( std::function< void(const std::optional< sf::Event > &event)> callback )

inherited

Register a callback invoked when the mouse enters this component's bounds, receiving the raw SFML event.

Parameters

callback Function invoked with the SFML event on hover enter.

◆ onKeypress() [1/2]

void ml::Keyable::onKeypress ( std::function< void()> callback )

inherited

Register a no-argument callback invoked when a key is pressed while this component has focus.

Parameters

callback Function invoked with no arguments on key press.

◆ onKeypress() [2/2]

void ml::Keyable::onKeypress ( std::function< void(const std::optional< sf::Event > &)> callback )

inherited

Register a callback invoked when a key is pressed while this component has focus, receiving the raw SFML event.

Parameters

callback Function invoked with the SFML event on key press.

◆ onKeyRelease() [1/2]

void ml::Keyable::onKeyRelease ( std::function< void()> callback )

inherited

Register a no-argument callback invoked when a key is released while this component has focus.

Parameters

callback Function invoked with no arguments on key release.

◆ onKeyRelease() [2/2]

void ml::Keyable::onKeyRelease ( std::function< void(const std::optional< sf::Event > &)> callback )

inherited

Register a callback invoked when a key is released while this component has focus, receiving the raw SFML event.

Parameters

callback Function invoked with the SFML event on key release.

◆ onMouseMoved() [1/2]

void ml::Scrollable::onMouseMoved ( std::function< void()> callback )

inherited

Register a no-argument callback invoked whenever the mouse moves anywhere in the window.

Unlike onHover, this fires for every component regardless of whether the cursor is over it.

Parameters

callback Function invoked with no arguments on mouse move.

◆ onMouseMoved() [2/2]

void ml::Scrollable::onMouseMoved ( std::function< void(const std::optional< sf::Event > &)> callback )

inherited

Register a callback invoked whenever the mouse moves anywhere in the window, receiving the raw SFML event.

Parameters

callback Function invoked with the SFML event on mouse move.

◆ onMousePressed() [1/2]

void ml::Scrollable::onMousePressed ( std::function< void()> callback )

inherited

Register a no-argument callback invoked when a mouse button is pressed anywhere in the window.

This fires before click logic is evaluated. Prefer onClick for standard click handling.

Parameters

callback Function invoked with no arguments on mouse press.

◆ onMousePressed() [2/2]

void ml::Scrollable::onMousePressed ( std::function< void(const std::optional< sf::Event > &)> callback )

inherited

Register a callback invoked when a mouse button is pressed, receiving the raw SFML event.

Parameters

callback Function invoked with the SFML event on mouse press.

◆ onMouseReleased() [1/2]

void ml::Scrollable::onMouseReleased ( std::function< void()> callback )

inherited

Register a no-argument callback invoked when a mouse button is released anywhere in the window.

This fires before click logic is evaluated. Prefer onClick for standard click handling.

Parameters

callback Function invoked with no arguments on mouse release.

◆ onMouseReleased() [2/2]

void ml::Scrollable::onMouseReleased ( std::function< void(const std::optional< sf::Event > &)> callback )

inherited

Register a callback invoked when a mouse button is released, receiving the raw SFML event.

Parameters

callback Function invoked with the SFML event on mouse release.

◆ onScroll() [1/2]

void ml::Scrollable::onScroll ( std::function< void()> callback )

inherited

Register a no-argument callback invoked when the mouse wheel is scrolled while the cursor is over this component.

Parameters

callback Function invoked with no arguments on scroll.

◆ onScroll() [2/2]

void ml::Scrollable::onScroll ( std::function< void(const std::optional< sf::Event > &)> callback )

inherited

Register a callback invoked when the mouse wheel is scrolled while the cursor is over this component, receiving the SFML event.

Parameters

callback Function invoked with the SFML event on scroll.

◆ onTextEntered() [1/2]

void ml::Keyable::onTextEntered ( std::function< void()> callback )

inherited

Register a no-argument callback invoked when a unicode character is entered while this component has focus.

Prefer onTextEntered over onKeypress for text input — it handles modifier keys, input method editors (IME), and non-ASCII characters correctly.

Parameters

callback Function invoked with no arguments when text is entered.

◆ onTextEntered() [2/2]

void ml::Keyable::onTextEntered ( std::function< void(const std::optional< sf::Event > &)> callback )

inherited

Register a callback invoked when a unicode character is entered while this component has focus, receiving the raw SFML event.

Parameters

callback Function invoked with the SFML event when text is entered.

◆ onUnhover() [1/2]

void ml::Hoverable::onUnhover ( std::function< void()> callback )

inherited

Register a no-argument callback invoked when the mouse leaves this component's bounds.

Parameters

callback Function invoked with no arguments on hover leave.

◆ onUnhover() [2/2]

void ml::Hoverable::onUnhover ( std::function< void(const std::optional< sf::Event > &event)> callback )

inherited

Register a callback invoked when the mouse leaves this component's bounds, receiving the raw SFML event.

Parameters

callback Function invoked with the SFML event on hover leave.

◆ onUpdate() [1/2]

void ml::Updatable::onUpdate ( std::function< void()> callback )

inherited

Register a no-argument callback invoked every frame.

The callback fires once per frame before the draw pass. All active components receive this regardless of hover or focus state.

Parameters

callback Function invoked with no arguments each frame.

◆ onUpdate() [2/2]

void ml::Updatable::onUpdate ( std::function< void(const std::optional< sf::Event > &)> callback )

inherited

Register a callback invoked every frame, receiving the SFML event.

For frame events the std::optional<sf::Event> is always std::nullopt — use the no-argument overload unless you specifically need the optional parameter in your callback signature.

Parameters

callback Function invoked with the SFML event (always nullopt) each frame.

◆ onWindowFocusGained() [1/2]

void ml::Updatable::onWindowFocusGained ( std::function< void()> callback )

inherited

Register a no-argument callback invoked when the application window gains OS focus.

Parameters

callback Function invoked with no arguments when focus is gained.

◆ onWindowFocusGained() [2/2]

void ml::Updatable::onWindowFocusGained ( std::function< void(const std::optional< sf::Event > &)> callback )

inherited

Register a callback invoked when the application window gains OS focus, receiving the raw SFML event.

Parameters

callback Function invoked with the SFML event when focus is gained.

◆ onWindowFocusLost() [1/2]

void ml::Updatable::onWindowFocusLost ( std::function< void()> callback )

inherited

Register a no-argument callback invoked when the application window loses OS focus.

Parameters

callback Function invoked with no arguments when focus is lost.

◆ onWindowFocusLost() [2/2]

void ml::Updatable::onWindowFocusLost ( std::function< void(const std::optional< sf::Event > &)> callback )

inherited

Register a callback invoked when the application window loses OS focus, receiving the raw SFML event.

Parameters

callback Function invoked with the SFML event when focus is lost.

◆ onWindowResized() [1/2]

void ml::Updatable::onWindowResized ( std::function< void()> callback )

inherited

Register a no-argument callback invoked when the application window is resized.

Parameters

callback Function invoked with no arguments on window resize.

◆ onWindowResized() [2/2]

void ml::Updatable::onWindowResized ( std::function< void(const std::optional< sf::Event > &)> callback )

inherited

Register a callback invoked when the application window is resized, receiving the raw SFML event.

Parameters

callback Function invoked with the SFML event on window resize.

◆ process() [1/2]

virtual void ml::EventReceiver::process	(	const std::string &	key,
		const std::optional< sf::Event > &	event )

virtualinherited

Invoke all callbacks registered for key.

Called by framework dispatchers. key is the string produced by EnumKey::get(eventEnum).

Parameters

key	String key identifying the event.
event	SFML event forwarded to each callback.

◆ process() [2/2]

template<typename ENUM_TYPE>

void ml::EventReceiver::process	(	ENUM_TYPE	eventName,
		const std::optional< sf::Event > &	event )

inherited

Invoke all callbacks registered for eventName.

Template overload that accepts any enum value directly, converting to a string key via EnumKey::get() internally.

Template Parameters

ENUM_TYPE Any enum type.

Parameters

eventName	The enum value identifying the event.
event	SFML event forwarded to each callback.

◆ processPending()

void ml::DeferredOperationsManager< CoreManager< Positionable > >::processPending ( )

staticinherited

Flush all pending operations immediately.

Normally called automatically by endBusy(). Provided as a public escape hatch for unusual teardown sequences.

Warning: Calling this while isBusy() is true can cause iterator invalidation in the currently running loop. Only call manually when you are certain it is safe.

◆ publish()

template<typename ENUM_TYPE>

void ml::Subscribable::publish	(	ENUM_TYPE	event,
		FilterCallback	filter = [](EventReceiver &){ return true;},
		SystemCallback	resolve = nullptr,
		SystemCallback	reject = nullptr )

inherited

Fire an enum-keyed event to all matching subscribers.

Iterates all subscribers registered for event and invokes their callbacks for each subscriber that passes the optional filter. Optional resolve and reject system callbacks are called after each component passes or fails the filter respectively.

Template Parameters

ENUM_TYPE Any enum type.

Parameters

event	The enum value identifying the event to fire.
filter	Optional predicate; only subscribers for which this returns `true` receive the event. Defaults to accepting all subscribers.
resolve	Optional callback invoked for each subscriber that passes the filter.
reject	Optional callback invoked for each subscriber that fails the filter.

◆ removeComponent()

bool ml::CoreManager< Positionable >::removeComponent ( Positionable & component )

staticinherited

Unregister a T object by reference.

Safe to call from inside an event or update callback. If the collection is currently being iterated, the removal is deferred until iteration completes.

Parameters

component The object to remove.

Returns: true if the object was found and removed (or queued for removal); false if it was not registered.

◆ setAbove()

template<class T>

void ml::Positionable::setAbove	(	T &	obj,
		float	spacing = 0 )

inherited

Position this object immediately above obj.

Template Parameters

T	Any type with `getGlobalBounds()`.

Parameters

obj	Reference object.
spacing	Gap in pixels between the two objects. Defaults to 0.

◆ setBelow()

template<class T>

void ml::Positionable::setBelow	(	T &	obj,
		float	spacing = 0 )

inherited

Position this object immediately below obj.

Template Parameters

T	Any type with `getGlobalBounds()`.

Parameters

obj	Reference object.
spacing	Gap in pixels between the two objects. Defaults to 0.

◆ setFlag()

void ml::FlagManager< Flag >::setFlag	(	State	state,
		bool	status )

inherited

Set a flag to an explicit value.

Parameters

state	The flag to modify.
status	`true` to enable, `false` to disable.

◆ setFramerate()

void ml::Positionable::setFramerate ( float framerate )

inherited

Set the assumed framerate for movement interpolation.

moveTo generates a queue of intermediate positions based on this value. Defaults to 60 fps. Call this if your application runs at a different target rate to keep animation timing accurate.

Parameters

framerate Target framerate in frames per second.

◆ setLeftOf()

template<class T>

void ml::Positionable::setLeftOf	(	T &	obj,
		float	spacing = 0 )

inherited

Position this object immediately to the left of obj.

Template Parameters

T	Any type with `getGlobalBounds()`.

Parameters

obj	Reference object.
spacing	Gap in pixels between the two objects. Defaults to 0.

◆ setPosition()

void ml::Grid::setPosition ( const sf::Vector2f & position )

virtual

Set the world-space origin of the grid.

Triggers reposition() so all managed components shift relative to the new origin.

Parameters

position New top-left position in world coordinates.

Implements ml::Positionable.

◆ setRightOf()

template<class T>

void ml::Positionable::setRightOf	(	T &	obj,
		float	spacing = 0 )

inherited

Position this object immediately to the right of obj.

Template Parameters

T	Any type with `getGlobalBounds()`.

Parameters

obj	Reference object.
spacing	Gap in pixels between the two objects. Defaults to 0.

◆ setRow()

void ml::Grid::setRow ( int row )

Set the number of columns per row.

Triggers reposition() to reflow all managed components.

Parameters

row	Number of columns. Items beyond this count wrap to the next row.

◆ setSpacing()

void ml::Grid::setSpacing ( float spacing )

Set the spacing between cells.

Triggers reposition() to update all component positions.

Parameters

spacing Gap in pixels between adjacent cells.

◆ subscribe() [1/2]

template<typename ENUM_TYPE>

void ml::Subscribable::subscribe	(	ENUM_TYPE	event,
		Callback	callback )

inherited

Subscribe to an enum-keyed event with a no-argument callback.

Convenience overload for callbacks that do not need access to the raw SFML event.

Template Parameters

ENUM_TYPE Any enum type.

Parameters

event	The enum value identifying the event to subscribe to.
callback	Function invoked with no arguments when the event fires.

◆ subscribe() [2/2]

template<typename ENUM_TYPE>

void ml::Subscribable::subscribe	(	ENUM_TYPE	event,
		EventCallback	callback )

inherited

Subscribe to an enum-keyed event with a full SFML event callback.

The callback is invoked each time the event fires and the framework's filter (defined by the associated EventDispatcher) passes this component. The std::optional<sf::Event> parameter carries the raw SFML event when one is available, or std::nullopt for frame events.

Template Parameters

ENUM_TYPE Any enum type — ml::Event for built-in events, or a manifest event enum for custom events.

Parameters

event	The enum value identifying the event to subscribe to.
callback	Function invoked with the SFML event when the event fires.

◆ toggleFlag()

void ml::FlagManager< Flag >::toggleFlag ( State state )

inherited

Flip a flag between true and false.

Parameters

state The flag to toggle.

◆ unsubscribe()

template<typename EnumType>

void ml::Unsubscribable::unsubscribe ( EnumType event )

inlineinherited

Unsubscribe from a single event by enum value.

Works with any enum type — ml::Event for built-in events, or a manifest Event enum for custom events.

If called during a _EventsManager::fire() iteration the removal is deferred until the iteration completes.

Template Parameters

EnumType Any enum type. Enforced at compile time.

Parameters

event The enum value identifying the event to remove.

Definition at line 61 of file Unsubscribable.h.

◆ unsubscribeAll()

void ml::Unsubscribable::unsubscribeAll ( )

inherited

Remove all event subscriptions for this component.

Removes every subscription registered across all event names. Called automatically by Core's destructor.

If called during a _EventsManager::fire() iteration the removal is deferred until the iteration completes.

Member Data Documentation

◆ busyDepth

int ml::DeferredOperationsManager< CoreManager< Positionable > >::busyDepth

inlinestaticprotectedinherited

Iteration nesting depth. Operations are deferred while this is > 0.

Definition at line 69 of file DeferredOperationsManager.h.

◆ pendingOperations

std::vector<std::function<void()> > ml::DeferredOperationsManager< CoreManager< Positionable > >::pendingOperations

inlinestaticprotectedinherited

Queue of operations pending until the current iteration completes.

Definition at line 72 of file DeferredOperationsManager.h.

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

Graphics/Layouts/Grid.h

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Static Protected Attributes

Detailed Description

Usage

Layout model

Member Typedef Documentation

◆ State

Constructor & Destructor Documentation

◆ Grid() [1/2]

◆ Grid() [2/2]

Member Function Documentation

◆ addComponent() [1/2]

◆ addComponent() [2/2]

◆ beginBusy()

◆ center()

◆ centerHorizonally()

◆ centerText()

◆ centerVertically()

◆ checkFlag()

◆ clear()

◆ clearPending()

◆ deferOrExecute()

◆ disableFlag()

◆ enableFlag()

◆ endBusy()

◆ getComponents()

◆ getGlobalBounds()

◆ getPosition()

◆ getRenderStates()

◆ getRow()

◆ getSpacing()

◆ isBusy()

◆ isScrolling()

◆ moveDistance()

◆ moveTo() [1/2]

◆ moveTo() [2/2]

◆ onBlur() [1/2]

◆ onBlur() [2/2]

◆ onClick() [1/2]

◆ onClick() [2/2]

◆ onFocus() [1/2]

◆ onFocus() [2/2]

◆ onHover() [1/2]

◆ onHover() [2/2]

◆ onKeypress() [1/2]

◆ onKeypress() [2/2]

◆ onKeyRelease() [1/2]

◆ onKeyRelease() [2/2]

◆ onMouseMoved() [1/2]

◆ onMouseMoved() [2/2]

◆ onMousePressed() [1/2]

◆ onMousePressed() [2/2]

◆ onMouseReleased() [1/2]

◆ onMouseReleased() [2/2]

◆ onScroll() [1/2]

◆ onScroll() [2/2]

◆ onTextEntered() [1/2]

◆ onTextEntered() [2/2]

◆ onUnhover() [1/2]

◆ onUnhover() [2/2]

◆ onUpdate() [1/2]

◆ onUpdate() [2/2]

◆ onWindowFocusGained() [1/2]

◆ onWindowFocusGained() [2/2]

◆ onWindowFocusLost() [1/2]

◆ onWindowFocusLost() [2/2]

◆ onWindowResized() [1/2]

◆ onWindowResized() [2/2]

◆ process() [1/2]

◆ process() [2/2]

◆ processPending()

◆ publish()

◆ removeComponent()

◆ setAbove()

◆ setBelow()

◆ setFlag()

◆ setFramerate()