ml::ApplicationBase Class Reference

Internal base class for all Malena applications. More...

#include <Malena/Engine/App/Application.h>

Inheritance diagram for ml::ApplicationBase:

Public Member Functions
	ApplicationBase (const sf::VideoMode &videoMode, const std::string &title, sf::RenderWindow &window=WindowManager::getWindow())
	Construct with an explicit video mode and window title.
	ApplicationBase (unsigned int screenWidth, unsigned int screenHeight, unsigned int bitDepth, const std::string &title)
	Construct from pixel dimensions and bit depth.
	~ApplicationBase ()
void	addComponent (Core &component)
	Register a Core object with the application's component manager.
void	clear ()
	Remove all registered objects.
const std::vector< Core * > &	getComponents () const
	Return a read-only view of all currently registered objects.
virtual void	onInit ()
	Called once after construction, before the first frame.
virtual void	onReady ()
	Called once after onInit(), when all components are registered.
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.
bool	removeComponent (Core &component)
	Unregister a T object by reference.
void	reset ()
	Full application reset — clears events, messages, and components.
void	run ()
	Enter the main loop and run until the window is closed.

Static Public Member Functions
static void	clearEvents ()
	Clear all event subscriptions across the entire application.
static void	clearPending ()
	Discard all pending operations without executing them.
static bool	isBusy ()
	Return true if the manager is currently iterating.
static void	processPending ()
	Flush all pending operations immediately.

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

Internal base class for all Malena applications.

Do not inherit directly. Use ml::Application or ml::ApplicationWith.

See also

Application, ApplicationWith

Definition at line 34 of file Application.h.

Constructor & Destructor Documentation

ApplicationBase() [1/2]

ml::ApplicationBase::ApplicationBase	(	const sf::VideoMode &	videoMode,
		const std::string &	title,
		sf::RenderWindow &	window = WindowManager::getWindow() )

Construct with an explicit video mode and window title.

ApplicationBase() [2/2]

ml::ApplicationBase::ApplicationBase	(	unsigned int	screenWidth,
		unsigned int	screenHeight,
		unsigned int	bitDepth,
		const std::string &	title )

Construct from pixel dimensions and bit depth.

~ApplicationBase()

ml::ApplicationBase::~ApplicationBase

(

)

Member Function Documentation

addComponent()

void ml::ApplicationBase::addComponent

(

Core &

component

)

Register a Core object with the application's component manager.

beginBusy()

void ml::DeferredOperationsManager< CoreManager< Core > >::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.

clear()

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

inherited

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.

clearEvents()

void ml::ApplicationBase::clearEvents ( )

static

Clear all event subscriptions across the entire application.

clearPending()

void ml::DeferredOperationsManager< CoreManager< Core > >::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< Core > >::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.

endBusy()

void ml::DeferredOperationsManager< CoreManager< Core > >::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< Core * > & ml::CoreManager< Core >::getComponents ( ) const

nodiscardinherited

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.

isBusy()

bool ml::DeferredOperationsManager< CoreManager< Core > >::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.

onInit()

virtual void ml::Lifecycle::onInit ( )

inlinevirtualinherited

Called once after construction, before the first frame.

Override to perform initial setup — configure component properties, load resources, and register objects with the framework. At this point no other sibling components are guaranteed to be fully registered.

Definition at line 82 of file Lifecycle.h.

onReady()

virtual void ml::Lifecycle::onReady ( )

inlinevirtualinherited

Called once after onInit(), when all components are registered.

Override to wire logic that depends on other components already existing — event callbacks, cross-component bindings, or derived initial state.

Definition at line 90 of file Lifecycle.h.

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< Core > >::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.

removeComponent()

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

inherited

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.

reset()

void ml::ApplicationBase::reset

(

)

Full application reset — clears events, messages, and components.

Tears down all framework state in the correct order:

1. All event subscriptions
2. All message subscriptions
3. All registered components

After reset(), call onInit() and onReady() to rebuild the scene.

Note

Does NOT close the window or restart the main loop.

run()

void ml::AppManager::run ( )

inherited

Enter the main loop and run until the window is closed.

Each iteration of the loop:

1. Polls all pending SFML events and passes each to fireInputEvents().
2. Calls fireUpdateEvents() for the per-frame update tick.
3. Clears the window, calls draw() on all registered components, and displays the frame.

Returns when the SFML window is closed or window.close() is called.

Member Data Documentation

busyDepth

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

inlinestaticprotectedinherited

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

Definition at line 70 of file DeferredOperationsManager.h.

pendingOperations

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

inlinestaticprotectedinherited

Queue of operations pending until the current iteration completes.

Definition at line 73 of file DeferredOperationsManager.h.

---

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

• Engine/App/Application.h