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
GenericEncoderSelector< N, Callback > Class Template Reference

#include <Selectors/EncoderSelector.hpp>

Detailed Description

template<setting_t N, class Callback = EmptySelectorCallback>
class GenericEncoderSelector< N, Callback >

Definition at line 17 of file EncoderSelector.hpp.

Inheritance diagram for GenericEncoderSelector< N, Callback >:
Collaboration diagram for GenericEncoderSelector< N, Callback >:

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.

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

 GenericEncoderSelector (Selectable< N > &selectable, const Callback &callback, const EncoderSwitchPinList &pins, int8_t pulsesPerStep=4, Wrap wrap=Wrap::Wrap)
void begin () override
 Initialize this updatable.
void update () override
 Update this updatable.
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

EmptySelectorCallback callback

Protected Attributes

setting_t setting = 0
 The selection of the selector.
Updatable< NormalUpdatable > * next
Updatable< NormalUpdatable > * previous

Static Protected Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables

Private Types

using Parent = GenericSelector<N, Callback>

Private Attributes

AHEncoder encoder
pin_t switchPin
int8_t pulsesPerStep
Wrap wrap
long previousPosition = 0
bool previousSwitchState = HIGH
Selectable< N > & selectable

Member Typedef Documentation

◆ Parent

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

Definition at line 18 of file EncoderSelector.hpp.

Constructor & Destructor Documentation

◆ GenericEncoderSelector()

template<setting_t N, class Callback = EmptySelectorCallback>
GenericEncoderSelector ( Selectable< N > & selectable,
const Callback & callback,
const EncoderSwitchPinList & pins,
int8_t pulsesPerStep = 4,
Wrap wrap = Wrap::Wrap )
inline

Definition at line 21 of file EncoderSelector.hpp.

Member Function Documentation

◆ begin()

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

Initialize this updatable.

Implements Updatable< T >.

Definition at line 28 of file EncoderSelector.hpp.

◆ update()

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

Update this updatable.

Implements Updatable< T >.

Definition at line 35 of file EncoderSelector.hpp.

◆ reset()

void reset ( )
inlineinherited

Reset the selection to the initial selection.

Definition at line 80 of file Selector.hpp.

◆ set()

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()

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()

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>
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>
void updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

Definition at line 186 of file Updatable.hpp.

◆ enable()

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.

◆ disable()

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.

◆ isEnabled()

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()

void moveDown ( )
inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

Member Data Documentation

◆ encoder

template<setting_t N, class Callback = EmptySelectorCallback>
AHEncoder encoder
private

Definition at line 61 of file EncoderSelector.hpp.

◆ switchPin

template<setting_t N, class Callback = EmptySelectorCallback>
pin_t switchPin
private

Definition at line 62 of file EncoderSelector.hpp.

◆ pulsesPerStep

template<setting_t N, class Callback = EmptySelectorCallback>
int8_t pulsesPerStep
private

Definition at line 63 of file EncoderSelector.hpp.

◆ wrap

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

Definition at line 64 of file EncoderSelector.hpp.

◆ previousPosition

template<setting_t N, class Callback = EmptySelectorCallback>
long previousPosition = 0
private

Definition at line 66 of file EncoderSelector.hpp.

◆ previousSwitchState

template<setting_t N, class Callback = EmptySelectorCallback>
bool previousSwitchState = HIGH
private

Definition at line 67 of file EncoderSelector.hpp.

◆ selectable

Selectable<N>& selectable
privateinherited

Definition at line 141 of file Selector.hpp.

◆ callback

EmptySelectorCallback 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

DoublyLinkedList<Updatable< NormalUpdatable >> updatables
staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable >* next
protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable >* previous
protectedinherited

Definition at line 321 of file LinkedList.hpp.

The documentation for this class was generated from the following file:
Generated by doxygen 1.17.0