A Selector with an empty callback. More...

#include <Selectors/Selector.hpp>

Inheritance diagram for Selector< N >:

Collaboration diagram for Selector< N >:

Public Types
using	Mutex = typename std::conditional< ThreadSafe, DefaultMutEx, EmptyMutex >::type

using	LockGuard = typename std::conditional< ThreadSafe, DefaultLockGuard< Mutex >, EmptyLockGuard< Mutex > >::type

Public Member Functions
	Selector (Selectable< N > &selectable)
	Constructor. More...

void	begin () override
	Initialize this updatable. More...

void	update () override
	Update this updatable. More...

void	reset ()
	Reset the selection to the initial selection. More...

void	set (setting_t newSetting)
	Select the given selection. More...

void	increment (Wrap wrap)
	Add one to the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range. More...

void	decrement (Wrap wrap)
	Subtract one from the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range. More...

setting_t	get () const
	Get the current selection/setting. More...

Static Public Member Functions
static Mutex &	getMutex ()

Public Attributes
EmptySelectorCallback	callback

Protected Attributes
setting_t	setting = 0
	The selection of the selector. More...

Updatable< NormalUpdatable, false > *	next

Updatable< NormalUpdatable, false > *	previous

Static Protected Attributes
static DoublyLinkedList< Updatable< NormalUpdatable, false > >	updatables

static Mutex	mutex

Private Attributes
Selectable< N > &	selectable

Main initialization and updating methods
static void	applyToAll (const LockGuard &, void(Derived::*method)(Args &&...), Args &&... args)

static void	applyToAll (void(Derived::*method)(Args &&...), Args &&... args)

Enabling and disabling updatables
void	enable (const LockGuard &lock)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

void	disable (const LockGuard &lock)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

void	disable ()
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

bool	isEnabled (const LockGuard &) const
	Check if this updatable is enabled. More...

bool	isEnabled ()
	Check if this updatable is enabled. More...

void	moveDown (const LockGuard &)
	Move down this element in the list. More...

void	moveDown ()
	Move down this element in the list. More...

static void	enable (UpdatableCRTP *element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

static void	enable (UpdatableCRTP &element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

static void	enable (U(&array)[N])
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

static void	disable (UpdatableCRTP *element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

static void	disable (UpdatableCRTP &element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

static void	disable (U(&array)[N])
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

Main initialization and updating methods
static void	beginAll ()
	Begin all enabled instances of this class. More...

static void	updateAll ()
	Update all enabled instances of this class. More...

Detailed Description

template<setting_t N>
class Selector< N >

A Selector with an empty callback.

Template Parameters

N	The number of possible settings.

Definition at line 155 of file Selector.hpp.

Member Typedef Documentation

◆ Mutex

using Mutex = typename std::conditional<ThreadSafe, DefaultMutEx, EmptyMutex>::type

inherited

Definition at line 36 of file Updatable.hpp.

◆ LockGuard

using LockGuard = typename std::conditional<ThreadSafe, DefaultLockGuard<Mutex>, EmptyLockGuard<Mutex> >::type

inherited

Definition at line 38 of file Updatable.hpp.

Constructor & Destructor Documentation

◆ Selector()

Selector ( Selectable< N > & selectable )

inline

Constructor.

Definition at line 158 of file Selector.hpp.

Member Function Documentation

◆ begin()

void begin

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable<>.

Definition at line 73 of file Selector.hpp.

◆ update()

void update

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable<>.

Definition at line 78 of file Selector.hpp.

◆ reset()

void reset

inlineinherited

Reset the selection to the initial selection.

Definition at line 81 of file Selector.hpp.

◆ set()

void set ( setting_t newSetting )

inlineinherited

Select the given selection.

Parameters

newSetting The new setting to select [0, N-1].

Definition at line 94 of file Selector.hpp.

◆ increment()

void increment ( Wrap wrap )

inlineinherited

Add one to the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range.

Parameters

wrap	Wrap or clamp if the new setting would be out of range.

Definition at line 110 of file Selector.hpp.

◆ decrement()

void decrement ( Wrap wrap )

inlineinherited

Subtract one from the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range.

Parameters

wrap	Wrap or clamp if the new setting would be out of range.

Definition at line 129 of file Selector.hpp.

◆ get()

setting_t get ( ) const

inlineinherited

Get the current selection/setting.

Definition at line 47 of file Selector.hpp.

◆ beginAll()

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 208 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 212 of file Updatable.hpp.

◆ getMutex()

static Mutex& getMutex ( )

inlinestaticinherited

Definition at line 79 of file Updatable.hpp.

◆ applyToAll() [1/2]

static void applyToAll	(	const LockGuard &	,
		void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ applyToAll() [2/2]

static void applyToAll	(	void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 93 of file Updatable.hpp.