ml::CarouselManifest Class Reference

Manifest for the Carousel component. More...

#include <Carousel.h>

Inheritance diagram for ml::CarouselManifest:

Public Types
enum class	ArrowPlacement { SIDES , TOP , OVERLAY }
	Controls where navigation arrows are placed relative to the content. More...
enum class	ArrowSide { LEFT , RIGHT }
	Identifies which navigation arrow to target in setter calls. More...
enum class	Flag { SCROLLING , SHOW_ARROWS }
	Runtime boolean flags for the carousel. More...
enum class	State { SCROLL_IDLE , SCROLL_LEFT , SCROLL_RIGHT }
	Scroll animation states. More...
using	Style = ShaderLibrary::Style
	Shader visual style — aliases ShaderLibrary::Style.

Static Public Member Functions
template<typename ConfigType, typename ValueType>
static const ValueType &	getConfig (ConfigType config)
	Retrieve a typed configuration value by enum key.
template<typename Asset>
static const std::string &	getFilepath (const Asset &asset)
	Retrieve the file path registered for an asset enum value.

Static Protected Member Functions
template<typename E, typename V, typename... Args>
static void	set (E key, V &&value, Args &&... args)
	Register multiple key-value pairs in one call.
template<typename EnumType>
static void	set (EnumType key, const char *filepath)
	Register an asset file path.
template<typename EnumType>
static void	set (EnumType key, std::string value)
	Register a string configuration value.
template<typename EnumType, typename ValueType>
static std::enable_if_t< !std::is_same_v< std::decay_t< ValueType >, const char * > &&!std::is_same_v< std::decay_t< ValueType >, std::string > >	set (EnumType key, ValueType &&value)
	Register a typed configuration value (int, float, bool, etc.).

Detailed Description

Manifest for the Carousel component.

Declares the flags, states, and supporting enums that drive carousel behavior. These are gathered automatically into the Carousel component's flag and state stores.

Definition at line 28 of file Carousel.h.

Member Typedef Documentation

Style

using ml::CarouselManifest::Style = ShaderLibrary::Style

Shader visual style — aliases ShaderLibrary::Style.

Definition at line 67 of file Carousel.h.

Member Enumeration Documentation

ArrowPlacement

enum class ml::CarouselManifest::ArrowPlacement

strong

Controls where navigation arrows are placed relative to the content.

Value	Placement
SIDES	Arrows flank the content on the left and right (default)
TOP	Both arrows sit above the carousel
OVERLAY	Arrows float on top of the content near the edges

Enumerator
SIDES
TOP
OVERLAY

Definition at line 61 of file Carousel.h.

ArrowSide

enum class ml::CarouselManifest::ArrowSide

strong

Identifies which navigation arrow to target in setter calls.

Enumerator
LEFT
RIGHT

Definition at line 64 of file Carousel.h.

Flag

enum class ml::CarouselManifest::Flag

strong

Runtime boolean flags for the carousel.

Flag	Effect
SCROLLING	Set while a scroll animation is in progress
SHOW_ARROWS	Controls whether navigation arrows are visible

Enumerator
SCROLLING
SHOW_ARROWS

Definition at line 39 of file Carousel.h.

State

enum class ml::CarouselManifest::State

strong

Scroll animation states.

State	Meaning
SCROLL_IDLE	No scroll in progress
SCROLL_LEFT	Scrolling toward previous items
SCROLL_RIGHT	Scrolling toward next items

Enumerator
SCROLL_IDLE
SCROLL_LEFT
SCROLL_RIGHT

Definition at line 50 of file Carousel.h.

Member Function Documentation

getConfig()

template<typename ConfigType, typename ValueType>

const ValueType & ml::Manifest::getConfig ( ConfigType config )

staticinherited

Retrieve a typed configuration value by enum key.

Looks up the value previously registered via set(key, value) where value was not a file path. Throws if the key has not been registered.

Template Parameters

ConfigType	An enum type declared inside a Manifest subclass.
ValueType	The type of the stored value (e.g., int, float, std::string).

Parameters

config

The specific enum value to look up.

Returns

Const reference to the registered configuration value.

getFilepath()

template<typename Asset>

const std::string & ml::Manifest::getFilepath ( const Asset & asset )

staticinherited

Retrieve the file path registered for an asset enum value.

Looks up the path previously registered via set(key, filepath). Throws std::out_of_range if the key has not been registered.

Template Parameters

Asset

An enum type declared inside a Manifest subclass.

Parameters

asset

The specific enum value to look up.

Returns

Const reference to the registered file path string.

set() [1/4]

template<typename E, typename V, typename... Args>

void ml::Manifest::set ( E key, V && value, Args &&... args )

staticprotectedinherited

Register multiple key-value pairs in one call.

Variadic overload that expands to successive set() calls. Useful for batch registration in the inline static initializer:

set(Images::Background, "assets/bg.png",
    Images::Button,     "assets/btn.png",
    Fonts::Main,        "assets/main.ttf");

Template Parameters

E	First key type.
V	First value type.
Args	Remaining key-value pairs.

set() [2/4]

template<typename EnumType>

void ml::Manifest::set ( EnumType key, const char * filepath )

staticprotectedinherited

Register an asset file path.

Associates key with a file path. The path is later retrieved by ResourceManager when loading the asset.

Template Parameters

EnumType

Enum type of the key (inferred).

Parameters

key	The enum value to register.
filepath	Null-terminated path to the asset file.

set() [3/4]

template<typename EnumType>

void ml::Manifest::set ( EnumType key, std::string value )

staticprotectedinherited

Register a string configuration value.

Associates key with a std::string config value. Distinct from the file-path overload — an explicit std::string signals that this is configuration data, not a resource path.

Template Parameters

EnumType

Enum type of the key (inferred).

Parameters

key	The enum value to register.
value	The string configuration value.

set() [4/4]

template<typename EnumType, typename ValueType>

std::enable_if_t< !std::is_same_v< std::decay_t< ValueType >, const char * > &&!std::is_same_v< std::decay_t< ValueType >, std::string > > ml::Manifest::set ( EnumType key, ValueType && value )

staticprotectedinherited

Register a typed configuration value (int, float, bool, etc.).

Enabled for any ValueType that is not const char* or std::string, routing numeric and boolean config values into their own type-indexed storage.

Template Parameters

EnumType	Enum type of the key (inferred).
ValueType	Type of the configuration value (inferred).

Parameters

key	The enum value to register.
value	The configuration value.

---

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

• Graphics/Controls/Carousel.h