Control Surface main
MIDI Control Surface library for Arduino
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | Private Types | Private Attributes | List of all members
IncrementDecrementSelector< N > Class Template Reference

#include <Selectors/IncrementDecrementSelector.hpp>

Detailed Description

template<setting_t N>
class IncrementDecrementSelector< N >

Selector with two buttons (one to increment, one to decrement).

Pressing two buttons simultaneously resets to the default setting.

Template Parameters
NThe number of settings.
Examples
Bank-Button-Matrix.ino, Bank.ino, Bankable-Smart-Control-Change-Potentiometer.ino, MCU-OLED-SSD1306.ino, ManyAddressesPCButton.ino, Note-ManyAddresses-Transposer.ino, One-Pot-Both-PB-and-CC.ino, and Transposer.ino.

Definition at line 69 of file IncrementDecrementSelector.hpp.

+ Inheritance diagram for IncrementDecrementSelector< N >:
+ Collaboration diagram for IncrementDecrementSelector< N >:

Enabling and disabling updatables

void enable ()
 Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
 
void disable ()
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
 
bool isEnabled () const
 Check if this updatable is enabled.
 
void moveDown ()
 Move down this element in the list.
 
static void enable (UpdatableCRTP *element)
 Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
 
static void enable (UpdatableCRTP &element)
 Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
 
template<class U , size_t N>
static void enable (U(&array)[N])
 Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
 
static void disable (UpdatableCRTP *element)
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
 
static void disable (UpdatableCRTP &element)
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
 
template<class U , size_t N>
static void disable (U(&array)[N])
 Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
 

Main initialization and updating methods

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

Public Member Functions

 IncrementDecrementSelector (Selectable< N > &selectable, const AH::IncrementDecrementButtons &buttons, Wrap wrap=Wrap::Wrap)
 
void begin () override
 Initialize this updatable.
 
void update () override
 Update this updatable.
 
void invert ()
 
AH::IncrementDecrementButtons::State getButtonsState () const
 
void reset ()
 Reset the selection to the initial selection.
 
void set (setting_t newSetting)
 Select the given selection.
 
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.
 
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.
 
setting_t get () const
 Get the current selection/setting.
 

Public Attributes

Callback callback
 

Protected Attributes

setting_t setting = 0
 The selection of the selector.
 
Derived * next
 
Derived * previous
 

Static Protected Attributes

static DoublyLinkedList< Derived > updatables
 

Private Types

using Parent = GenericSelector<N, Callback>
 

Private Attributes

AH::IncrementDecrementButtons buttons
 
Wrap wrap
 
Selectable< N > & selectable
 

Member Typedef Documentation

◆ Parent

template<setting_t N, class Callback = EmptySelectorCallback>
using Parent = GenericSelector<N, Callback>
privateinherited

Definition at line 10 of file IncrementDecrementSelector.hpp.

Constructor & Destructor Documentation

◆ IncrementDecrementSelector()

template<setting_t N>
IncrementDecrementSelector ( Selectable< N > & selectable,
const AH::IncrementDecrementButtons & buttons,
Wrap wrap = Wrap::Wrap )
inline

Definition at line 71 of file IncrementDecrementSelector.hpp.

Member Function Documentation

◆ begin()

template<setting_t N, class Callback = EmptySelectorCallback>
void begin ( )
inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

Definition at line 19 of file IncrementDecrementSelector.hpp.

◆ update()

template<setting_t N, class Callback = EmptySelectorCallback>
void update ( )
inlineoverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

Definition at line 24 of file IncrementDecrementSelector.hpp.

◆ invert()

template<setting_t N, class Callback = EmptySelectorCallback>
void invert ( )
inlineinherited
See also
AH::Button::invert()

Definition at line 41 of file IncrementDecrementSelector.hpp.

◆ getButtonsState()

template<setting_t N, class Callback = EmptySelectorCallback>
AH::IncrementDecrementButtons::State getButtonsState ( ) const
inlineinherited

Definition at line 43 of file IncrementDecrementSelector.hpp.

◆ reset()

template<setting_t N, class Callback = EmptySelectorCallback>
void reset ( )
inlineinherited

Reset the selection to the initial selection.

Definition at line 80 of file Selector.hpp.

◆ set()

template<setting_t N, class Callback = EmptySelectorCallback>
void set ( setting_t newSetting)
inlineinherited

Select the given selection.

Parameters
newSettingThe new setting to select [0, N-1].

Definition at line 93 of file Selector.hpp.

◆ increment()

template<setting_t N, class Callback = EmptySelectorCallback>
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
wrapWrap or clamp if the new setting would be out of range.

Definition at line 109 of file Selector.hpp.

◆ decrement()

template<setting_t N, class Callback = EmptySelectorCallback>
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
wrapWrap or clamp if the new setting would be out of range.

Definition at line 128 of file Selector.hpp.

◆ get()

setting_t get ( ) const
inlineinherited

Get the current selection/setting.

Definition at line 46 of file Selector.hpp.

◆ beginAll()

template<class T = NormalUpdatable>
static void beginAll ( )
inlinestaticinherited

Begin all enabled instances of this class.

See also
begin()

Definition at line 182 of file Updatable.hpp.

◆ updateAll()

template<class T = NormalUpdatable>
static void updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

Definition at line 186 of file Updatable.hpp.

◆ enable() [1/4]

template<class Derived >
void enable ( )
inlineinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 96 of file Updatable.hpp.

◆ enable() [2/4]

template<class Derived >
static void enable ( UpdatableCRTP< Derived > * element)
inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 125 of file Updatable.hpp.

◆ enable() [3/4]

template<class Derived >
static void enable ( UpdatableCRTP< Derived > & element)
inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 127 of file Updatable.hpp.

◆ enable() [4/4]

template<class Derived >
template<class U , size_t N>
static void enable ( U(&) array[N])
inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 130 of file Updatable.hpp.

◆ disable() [1/4]

template<class Derived >
void disable ( )
inlineinherited

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

Definition at line 106 of file Updatable.hpp.

◆ disable() [2/4]

template<class Derived >
static void disable ( UpdatableCRTP< Derived > * element)
inlinestaticinherited

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

Definition at line 136 of file Updatable.hpp.

◆ disable() [3/4]

template<class Derived >
static void disable ( UpdatableCRTP< Derived > & element)
inlinestaticinherited

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

Definition at line 138 of file Updatable.hpp.

◆ disable() [4/4]

template<class Derived >
template<class U , size_t N>
static void disable ( U(&) array[N])
inlinestaticinherited

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

Definition at line 141 of file Updatable.hpp.

◆ isEnabled()

template<class Derived >
bool isEnabled ( ) const
inlineinherited

Check if this updatable is enabled.

Note
Assumes that the updatable is not added to a different linked list by the user.

Definition at line 120 of file Updatable.hpp.

◆ moveDown()

template<class Derived >
void moveDown ( )
inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

Member Data Documentation

◆ buttons

template<setting_t N, class Callback = EmptySelectorCallback>
AH::IncrementDecrementButtons buttons
privateinherited

Definition at line 48 of file IncrementDecrementSelector.hpp.

◆ wrap

template<setting_t N, class Callback = EmptySelectorCallback>
Wrap wrap
privateinherited

Definition at line 49 of file IncrementDecrementSelector.hpp.

◆ selectable

template<setting_t N, class Callback = EmptySelectorCallback>
Selectable<N>& selectable
privateinherited

Definition at line 141 of file Selector.hpp.

◆ callback

template<setting_t N, class Callback = EmptySelectorCallback>
Callback callback
inherited

Definition at line 144 of file Selector.hpp.

◆ setting

setting_t setting = 0
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 52 of file Selector.hpp.

◆ updatables

template<class Derived >
DoublyLinkedList< Derived > updatables
staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next

Derived * next
protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous

Derived * previous
protectedinherited

Definition at line 321 of file LinkedList.hpp.


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