Selector that selects one of two settings, based on the state of a toggle or momentary switch. More...
#include <Selectors/SwitchSelector.hpp>
Public Member Functions | |
SwitchSelector (Selectable< 2 > &selectable, const AH::Button &button) | |
void | begin () override |
Initialize this updatable. More... | |
void | update () override |
Update this updatable. More... | |
AH::Button::State | getButtonState () const |
void | invert () |
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... | |
void | enable () |
Enable this updatable: insert it into the linked list of instances, so it 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 () |
Check if this updatable is enabled. More... | |
Static Public Member Functions | |
static void | enable (Updatable *element) |
static void | enable (Updatable &element) |
static void | enable (U(&array)[N]) |
static void | disable (Updatable< NormalUpdatable > *element) |
static void | disable (Updatable< NormalUpdatable > &element) |
static void | disable (U(&array)[N]) |
static void | beginAll () |
Begin all enabled instances of this class. More... | |
static void | updateAll () |
Update all enabled instances of this class. More... | |
Public Attributes | |
EmptySelectorCallback | callback |
Protected Attributes | |
setting_t | setting = 0 |
The selection of the selector. More... | |
Updatable< NormalUpdatable > * | next |
Updatable< NormalUpdatable > * | previous |
Private Types | |
using | Parent = GenericSelector< 2, EmptySelectorCallback > |
Private Attributes | |
AH::Button | button |
Selectable< N > & | selectable |
Static Private Attributes | |
static DoublyLinkedList< Updatable< NormalUpdatable > > | updatables |
Selector that selects one of two settings, based on the state of a toggle or momentary switch.
Definition at line 51 of file SwitchSelector.hpp.
|
privateinherited |
Definition at line 10 of file SwitchSelector.hpp.
|
inline |
Definition at line 53 of file SwitchSelector.hpp.
|
inlineoverridevirtualinherited |
Initialize this updatable.
Reimplemented from GenericSelector< 2, EmptySelectorCallback >.
Definition at line 17 of file SwitchSelector.hpp.
|
inlineoverridevirtualinherited |
Update this updatable.
Reimplemented from GenericSelector< 2, EmptySelectorCallback >.
Definition at line 22 of file SwitchSelector.hpp.
|
inlineinherited |
Definition at line 31 of file SwitchSelector.hpp.
|
inlineinherited |
Definition at line 34 of file SwitchSelector.hpp.
|
inlineinherited |
Reset the selection to the initial selection.
Definition at line 81 of file Selector.hpp.
|
inlineinherited |
Select the given selection.
newSetting | The new setting to select [0, N-1]. |
Definition at line 89 of file Selector.hpp.
|
inlineinherited |
Add one to the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range.
wrap | Wrap or clamp if the new setting would be out of range. |
Definition at line 105 of file Selector.hpp.
|
inlineinherited |
Subtract one from the setting, wrap around or clamp, depending on the parameter, if the new setting would be out of range.
wrap | Wrap or clamp if the new setting would be out of range. |
Definition at line 124 of file Selector.hpp.
|
inlineinherited |
Get the current selection/setting.
Definition at line 47 of file Selector.hpp.
|
inlineinherited |
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 45 of file Updatable.hpp.
|
inlinestaticinherited |
Definition at line 85 of file Updatable.hpp.
|
inlinestaticinherited |
Definition at line 87 of file Updatable.hpp.
|
inlinestaticinherited |
Definition at line 90 of file Updatable.hpp.
|
inlineinherited |
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 55 of file Updatable.hpp.
|
inlinestaticinherited |
Definition at line 95 of file Updatable.hpp.
|
inlinestaticinherited |
Definition at line 97 of file Updatable.hpp.
|
inlinestaticinherited |
Definition at line 100 of file Updatable.hpp.
|
inlineinherited |
Check if this updatable is enabled.
Definition at line 69 of file Updatable.hpp.
|
inlinestaticinherited |
Begin all enabled instances of this class.
Definition at line 73 of file Updatable.hpp.
|
inlinestaticinherited |
Update all enabled instances of this class.
Definition at line 80 of file Updatable.hpp.
|
privateinherited |
Definition at line 38 of file SwitchSelector.hpp.
|
privateinherited |
Definition at line 137 of file Selector.hpp.
|
inherited |
Definition at line 140 of file Selector.hpp.
|
protectedinherited |
The selection of the selector.
It is saved in the selector as well as the selectable, because you need it in order to implement increment/decrement methods.
Definition at line 53 of file Selector.hpp.
|
staticprivateinherited |
Definition at line 106 of file Updatable.hpp.
|
protectedinherited |
Definition at line 305 of file LinkedList.hpp.
|
protectedinherited |
Definition at line 306 of file LinkedList.hpp.