A circular button with a centered text label. More...

#include <CircleButton.h>

Inheritance diagram for ml::CircleButton:

Public Types
using	Flag = DraggableManifest::Flag
using	manifest_type
	The manifest type, used by `GatherFlags` and `GatherStates` to locate this class's flag and state declarations.
using	State = DraggableManifest::State
using	State
	The enum type this manager stores flags for.

Public Member Functions
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	clearDragBounds ()
	Remove any previously set drag bounds.
void	disableFlag (State state)
	Set a flag to `false`.
void	draw (sf::RenderTarget &target, sf::RenderStates states) const override
	Draw the button shape and its label to a render target.
void	enableFlag (State state)
	Set a flag to `true`.
sf::Vector2f	findCharacterPos (std::size_t index) const
	Return the world-space position of a character in the label.
unsigned int	getCharacterSize () const
	Return the current label character size.
Color	getFillColor () const
const sf::Font &	getFont () const
	Return the current label font.
Vector2f	getGeometricCenter () const override
sf::FloatRect	getGlobalBounds () const override
	Return the axis-aligned bounding box in world space.
const Transform &	getInverseTransform () const
float	getLetterSpacing () const
	Return the current label letter spacing factor.
float	getLineSpacing () const
	Return the current label line spacing factor.
FloatRect	getLocalBounds () const
float	getMiterLimit () const
Vector2f	getOrigin () const
Color	getOutlineColor () const
float	getOutlineThickness () const
Vector2f	getPoint (std::size_t index) const override
std::size_t	getPointCount () const override
sf::Vector2f	getPosition () const override
	Return the current world-space position.
float	getRadius () const
virtual sf::RenderStates	getRenderStates () const
	Returns the SFML render states to use when drawing this object.
Angle	getRotation () const
Vector2f	getScale () const
std::enable_if_t<!std::is_void_v< T >, T >	getState () const
	Return the current state value.
const sf::String &	getString () const
	Return the current label string.
std::uint32_t	getStyle () const
	Return the current label text style bitmask.
sf::Color	getTextColor () const
	Return the current label fill color.
sf::Color	getTextOutlineColor () const
	Return the current label outline color.
float	getTextOutlineThickness () const
	Return the current label outline thickness.
const Texture *	getTexture () const
const IntRect &	getTextureRect () const
const Transform &	getTransform () const
	Graphic ()
template<typename U>
	Graphic (const U &obj)
	Construct from an existing SFML object of type `U`.
bool	isScrolling ()
	Return `true` while a `moveTo` or `moveDistance` animation is in progress.
std::enable_if_t<!std::is_void_v< T >, bool >	isState (T state) const
	Return `true` if currently in `state`.
void	move (sf::Vector2f offset)
	Translate both shape and label by `offset`.
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.
std::enable_if_t<!std::is_void_v< T > >	onStateEnter (std::function< void(T)> callback)
	Register a callback invoked after each state transition.
std::enable_if_t<!std::is_void_v< T > >	onStateExit (std::function< void(T)> callback)
	Register a callback invoked before each state transition.
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.
	operator const sf::Drawable & () const
	Implicit conversion to a const `sf::Drawable` reference.
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.
void	rotate (sf::Angle angle)
	Rotate both shape and label by `angle`.
void	scale (sf::Vector2f scale)
	Apply a multiplicative scale to both shape and label.
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	setCharacterSize (unsigned int size)
	Set the label character size.
void	setDragBounds (const sf::FloatRect &bounds)
	Constrain drag movement to an axis-aligned bounding rectangle.
void	setFillColor (Color color)
void	setFlag (State state, bool status)
	Set a flag to an explicit value.
void	setFont (const sf::Font &font)
	Set the label font.
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	setLetterSpacing (float spacingFactor)
	Set the label letter spacing factor.
void	setLineSpacing (float spacingFactor)
	Set the label line spacing factor.
void	setMiterLimit (float miterLimit)
void	setOrigin (Vector2f origin)
void	setOutlineColor (Color color)
void	setOutlineThickness (float thickness)
void	setPointCount (std::size_t count)
void	setPosition (const sf::Vector2f &position) override
	Set the world-space position of both the shape and the label.
void	setPosition (Vector2f position)
void	setRadius (float radius)
template<class T>
void	setRightOf (T &obj, float spacing=0)
	Position this object immediately to the right of `obj`.
void	setRotation (sf::Angle angle)
	Set the absolute rotation of both shape and label.
void	setScale (sf::Vector2f scale)
	Scale both shape and label.
std::enable_if_t<!std::is_void_v< T > >	setState (T newState)
	Transition to a new state.
void	setString (const sf::String &text)
	Set the label string.
void	setStyle (std::uint32_t style)
	Set the label text style (bold, italic, underline, etc.).
void	setTextColor (const sf::Color &color)
	Set the label fill color.
void	setTextOutlineColor (const sf::Color &color)
	Set the label outline color.
void	setTextOutlineThickness (float thickness)
	Set the label outline thickness in pixels.
void	setTexture (const Texture *texture, bool resetRect=false)
void	setTextureRect (const IntRect &rect)
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.

Protected Member Functions
void	update ()

Detailed Description

A circular button with a centered text label.

CircleButton is Button<Circle, float> — a Circle background shape with an sf::Text label rendered on top. The size parameter is a float radius.

Usage

ml::CircleButton btn(ml::FontManager<>::getDefault(), 40.f, "OK");
btn.setPosition({200.f, 200.f});
btn.setFillColor(sf::Color(200, 80, 80));
btn.setTextColor(sf::Color::White);
btn.onClick([]{ confirm(); });
addComponent(btn);

With a manifest

class IconButton : public ml::CircleButtonWith<MyManifest> {};

ml::CircleButtonWith

CircleButton with an attached manifest.

Definition CircleButton.h:49

See also: Button, Circle, RectangleButton, ConvexButton

Definition at line 36 of file CircleButton.h.

Member Typedef Documentation

◆ Flag

using ml::Draggable::Flag = DraggableManifest::Flag

inherited

Definition at line 69 of file Draggable.h.

◆ manifest_type

using ml::Customizable< DraggableManifest >::manifest_type

inherited

The manifest type, used by GatherFlags and GatherStates to locate this class's flag and state declarations.

Definition at line 64 of file Customizable.h.

◆ State [1/2]

using ml::Draggable::State = DraggableManifest::State

inherited

Definition at line 70 of file Draggable.h.

◆ State [2/2]

using ml::FlagManager< Flag >::State

inherited

The enum type this manager stores flags for.

Definition at line 62 of file FlagManager.h.

Member Function Documentation

◆ 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.

◆ clearDragBounds()

void ml::Draggable::clearDragBounds ( )

inherited

Remove any previously set drag bounds.

After this call the component can be dragged freely across the window with no position clamping. Has no effect if no bounds were set.

◆ disableFlag()

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

inherited

Set a flag to false.

Parameters

state The flag to disable.

◆ draw()

void ml::Button< Circle, float >::draw	(	sf::RenderTarget &	target,
		sf::RenderStates	states ) const

overridevirtualinherited

Draw the button shape and its label to a render target.

Draws T first, then the centered sf::Text label on top.

Parameters

target	SFML render target.
states	Current render states.

Implements sf::Drawable.

◆ enableFlag()

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

inherited

Set a flag to true.

Parameters

state The flag to enable.

◆ findCharacterPos()

sf::Vector2f ml::Button< Circle, float >::findCharacterPos ( std::size_t index ) const

nodiscardinherited

Return the world-space position of a character in the label.

Parameters

index Zero-based character index.

Returns: World-space position of the character's origin.

◆ getCharacterSize()

unsigned int ml::Button< Circle, float >::getCharacterSize ( ) const

nodiscardinherited

Return the current label character size.

Returns: Character size in points.

◆ getFont()

const sf::Font & ml::Button< Circle, float >::getFont ( ) const

nodiscardinherited

Return the current label font.

Returns: Const reference to the active sf::Font.

◆ getGlobalBounds()

sf::FloatRect ml::Graphic< sf::CircleShape >::getGlobalBounds ( ) const

overridevirtualinherited

Return the axis-aligned bounding box in world space.

Delegates to T::getGlobalBounds(). Used by UIManager for hit-testing (click, hover) and by layout helpers.

Returns: Bounding rectangle in world coordinates.

Implements ml::Positionable.

◆ getLetterSpacing()

float ml::Button< Circle, float >::getLetterSpacing ( ) const

nodiscardinherited

Return the current label letter spacing factor.

Returns: Letter spacing multiplier.

◆ getLineSpacing()

float ml::Button< Circle, float >::getLineSpacing ( ) const

nodiscardinherited

Return the current label line spacing factor.

Returns: Line spacing multiplier.

◆ getPosition()

sf::Vector2f ml::Graphic< sf::CircleShape >::getPosition ( ) const

overridevirtualinherited

Return the current world-space position.

Delegates to T::getPosition.

Returns: Current 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.

◆ getState()

std::enable_if_t<!std::is_void_v< T >, T > ml::StateManager< extract_State< DraggableManifest >::type >::getState ( ) const

inherited

Return the current state value.

Returns: The active StateEnum value.

◆ getString()

const sf::String & ml::Button< Circle, float >::getString ( ) const

nodiscardinherited

Return the current label string.

Returns: Const reference to the current sf::String.

◆ getStyle()

std::uint32_t ml::Button< Circle, float >::getStyle ( ) const

nodiscardinherited

Return the current label text style bitmask.

Returns: sf::Text::Style bitmask.

◆ getTextColor()

sf::Color ml::Button< Circle, float >::getTextColor ( ) const

nodiscardinherited

Return the current label fill color.

Returns: Current text sf::Color.

◆ getTextOutlineColor()

sf::Color ml::Button< Circle, float >::getTextOutlineColor ( ) const

nodiscardinherited

Return the current label outline color.

Returns: Current text outline sf::Color.

◆ getTextOutlineThickness()

float ml::Button< Circle, float >::getTextOutlineThickness ( ) const

nodiscardinherited

Return the current label outline thickness.

Returns: Outline thickness in pixels.

◆ Graphic() [1/2]

ml::Graphic< T >::Graphic ( )

inherited

◆ Graphic() [2/2]

template<typename U>

ml::Graphic< T >::Graphic ( const U & obj )

explicitinherited

Construct from an existing SFML object of type U.

Template Parameters

U	Source type, must be compatible with `T's` copy/move constructor.

Parameters

obj	The source object to copy-construct from.

◆ 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.

◆ isState()

std::enable_if_t<!std::is_void_v< T >, bool > ml::StateManager< extract_State< DraggableManifest >::type >::isState ( T state ) const

inherited

Return true if currently in state.

Parameters

state The state value to compare against.

Returns: true if the current state equals state.

◆ move()

void ml::Button< Circle, float >::move ( sf::Vector2f offset )

inherited

Translate both shape and label by offset.

◆ 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.

◆ onStateEnter()

std::enable_if_t<!std::is_void_v< T > > ml::StateManager< extract_State< DraggableManifest >::type >::onStateEnter ( std::function< void(T)> callback )

inherited

Register a callback invoked after each state transition.

The callback receives the newly entered state. Only one enter callback is active at a time; calling this again replaces it.

Parameters

callback Function called with the new state after each transition.

◆ onStateExit()

std::enable_if_t<!std::is_void_v< T > > ml::StateManager< extract_State< DraggableManifest >::type >::onStateExit ( std::function< void(T)> callback )

inherited

Register a callback invoked before each state transition.

The callback receives the state being left. Only one exit callback is active at a time; calling this again replaces it.

Parameters

callback Function called with the old state before each transition.

◆ 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.

◆ operator const sf::Drawable &()

ml::Graphic< sf::CircleShape >::operator const sf::Drawable & ( ) const

inherited

Implicit conversion to a const sf::Drawable reference.

Allows a Graphic to be passed wherever a raw sf::Drawable& is expected (e.g., window.draw()).

Returns: Const reference to this object as sf::Drawable.

◆ 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.

◆ 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.

◆ rotate()

void ml::Button< Circle, float >::rotate ( sf::Angle angle )

inherited

Rotate both shape and label by angle.

◆ scale()

void ml::Button< Circle, float >::scale ( sf::Vector2f scale )

inherited

Apply a multiplicative scale to both shape and label.

◆ 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.

◆ setCharacterSize()

void ml::Button< Circle, float >::setCharacterSize ( unsigned int size )

inherited

Set the label character size.

Parameters

size	Character size in points.

◆ setDragBounds()

void ml::Draggable::setDragBounds ( const sf::FloatRect & bounds )

inherited

Constrain drag movement to an axis-aligned bounding rectangle.

While bounds are set, the component's position is clamped so that its top-left corner never moves outside bounds during a drag gesture. Bounds are applied in world coordinates.

Call clearDragBounds() to remove the constraint and allow free movement again.

Parameters

bounds The world-space rectangle within which the component may be dragged.

◆ 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.

◆ setFont()

void ml::Button< Circle, float >::setFont ( const sf::Font & font )

inherited

Set the label font.

Parameters

font	Const reference to the font to use.

◆ 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.

◆ setLetterSpacing()

void ml::Button< Circle, float >::setLetterSpacing ( float spacingFactor )

inherited

Set the label letter spacing factor.

Parameters

spacingFactor Multiplier applied to the default letter spacing.

◆ setLineSpacing()

void ml::Button< Circle, float >::setLineSpacing ( float spacingFactor )

inherited

Set the label line spacing factor.

Parameters

spacingFactor Multiplier applied to the default line height.

◆ setPosition()

void ml::Button< Circle, float >::setPosition ( const sf::Vector2f & position )

overridevirtualinherited

Set the world-space position of both the shape and the label.

Repositions the background shape and re-centers the text label.

Parameters

position New 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.

◆ setRotation()

void ml::Button< Circle, float >::setRotation ( sf::Angle angle )

inherited

Set the absolute rotation of both shape and label.

◆ setScale()

void ml::Button< Circle, float >::setScale ( sf::Vector2f scale )

inherited

Scale both shape and label.

◆ setState()

std::enable_if_t<!std::is_void_v< T > > ml::StateManager< extract_State< DraggableManifest >::type >::setState ( T newState )

inherited

Transition to a new state.

Fires the exit callback with the current state, updates the stored state to newState, then fires the enter callback with the new state. Either callback may be unset (nullptr), in which case it is skipped.

Parameters

newState The state to transition into.

◆ setString()

void ml::Button< Circle, float >::setString ( const sf::String & text )

inherited

Set the label string.

Parameters

text	New label text.

◆ setStyle()

void ml::Button< Circle, float >::setStyle ( std::uint32_t style )

inherited

Set the label text style (bold, italic, underline, etc.).

Parameters

style Bitmask of sf::Text::Style flags.

◆ setTextColor()

void ml::Button< Circle, float >::setTextColor ( const sf::Color & color )

inherited

Set the label fill color.

Parameters

color New text fill color.

◆ setTextOutlineColor()

void ml::Button< Circle, float >::setTextOutlineColor ( const sf::Color & color )

inherited

Set the label outline color.

Parameters

color New text outline color.

◆ setTextOutlineThickness()

void ml::Button< Circle, float >::setTextOutlineThickness ( float thickness )

inherited

Set the label outline thickness in pixels.

Parameters

thickness Outline thickness. Pass 0 to remove the outline.

◆ 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.

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

Graphics/Controls/CircleButton.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Usage

With a manifest

Member Typedef Documentation

◆ Flag

◆ manifest_type

◆ State [1/2]

◆ State [2/2]

Member Function Documentation

◆ center()

◆ centerHorizonally()

◆ centerText()

◆ centerVertically()

◆ checkFlag()

◆ clearDragBounds()

◆ disableFlag()

◆ draw()

◆ enableFlag()

◆ findCharacterPos()

◆ getCharacterSize()

◆ getFont()

◆ getGlobalBounds()

◆ getLetterSpacing()

◆ getLineSpacing()

◆ getPosition()

◆ getRenderStates()

◆ getState()

◆ getString()

◆ getStyle()

◆ getTextColor()

◆ getTextOutlineColor()

◆ getTextOutlineThickness()

◆ Graphic() [1/2]

◆ Graphic() [2/2]

◆ isScrolling()

◆ isState()

◆ move()

◆ 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]

◆ onStateEnter()

◆ onStateExit()

◆ 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]

◆ operator const sf::Drawable &()

◆ process() [1/2]

◆ process() [2/2]