Control Surface master
MIDI Control Surface library for Arduino
Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
CCIncrementDecrementButtons Class Reference

#include <MIDI_Outputs/CCIncrementDecrementButtons.hpp>

Detailed Description

A class of MIDIOutputElements that read the input of two momentary push buttons to increment or decrement a relative setting using relative MIDI Control Change events.


An optional note number can be provided to reset the setting.

This version cannot be banked.

Examples
CCIncrementDecrementButtons.ino.

Definition at line 19 of file CCIncrementDecrementButtons.hpp.

+ Inheritance diagram for CCIncrementDecrementButtons:
+ Collaboration diagram for CCIncrementDecrementButtons:

Enabling and disabling updatables

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 () const
 Check if this updatable is enabled. 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...
 

Public Member Functions

 CCIncrementDecrementButtons (const AH::IncrementDecrementButtons &buttons, MIDIAddress address, uint8_t multiplier=1, MIDIAddress resetNote=MIDIAddress::invalid(), const RelativeCCSender &relativeSender={}, const DigitalNoteSender &resetSender={})
 Construct a new CCIncrementDecrementButtons object. More...
 
void begin () override
 Initialize this updatable. More...
 
void update () override
 Update this updatable. More...
 
void send (long delta, MIDIAddress address)
 
void reset ()
 
void invert ()
 
AH::IncrementDecrementButtons::State getButtonsState () const
 
MIDIAddress getAddress () const
 Get the MIDI address. More...
 
void setAddress (MIDIAddress address)
 Set the MIDI address. More...
 
MIDIAddress getResetAddress () const
 Get the MIDI address of the reset action. More...
 
void setResetAddress (MIDIAddress address)
 Set the MIDI address of the reset action. More...
 

Public Attributes

RelativeCCSender relativeSender
 
DigitalNoteSender resetSender
 

Protected Attributes

Node * next = nullptr
 
Node * previous = nullptr
 

Static Protected Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Private Attributes

AH::IncrementDecrementButtons buttons
 
MIDIAddress address
 
uint8_t multiplier
 
MIDIAddress resetAddress
 

Constructor & Destructor Documentation

◆ CCIncrementDecrementButtons()

CCIncrementDecrementButtons ( const AH::IncrementDecrementButtons buttons,
MIDIAddress  address,
uint8_t  multiplier = 1,
MIDIAddress  resetNote = MIDIAddress::invalid(),
const RelativeCCSender relativeSender = {},
const DigitalNoteSender resetSender = {} 
)
inline

Construct a new CCIncrementDecrementButtons object.

Parameters
buttonsThe pins with the increment and decrement buttons connected.
The internal pull-up resistors will be enabled.
addressThe address to use for the relative events, containing the controller number [0, 119], channel [CHANNEL_1, CHANNEL_16], and optional cable number [CABLE_1, CABLE_16].
multiplierThe multiplier for the relative events. When setting it to 2, it will scroll twice as fast, for example.
resetNoteThe MIDI address to use to reset the setting, containing the note number [0, 119], channel [CHANNEL_1, CHANNEL_16], and optional cable number [CABLE_1, CABLE_16]. It will be triggered when the increment and decrement buttons are pressed simultaneously.
relativeSenderThe MIDI sender to use for the relative events.
resetSenderThe MIDI sender to use for reset events.

Definition at line 47 of file CCIncrementDecrementButtons.hpp.

Member Function Documentation

◆ begin()

void begin ( )
inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

Definition at line 32 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ update()

void update ( )
inlineoverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

Definition at line 34 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ send()

void send ( long  delta,
MIDIAddress  address 
)
inlineinherited

Definition at line 53 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ reset()

void reset ( )
inlineinherited

Definition at line 57 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ invert()

void invert ( )
inlineinherited

◆ getButtonsState()

AH::IncrementDecrementButtons::State getButtonsState ( ) const
inlineinherited

Definition at line 67 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ getAddress()

MIDIAddress getAddress ( ) const
inlineinherited

Get the MIDI address.

Definition at line 72 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ setAddress()

void setAddress ( MIDIAddress  address)
inlineinherited

Set the MIDI address.

Definition at line 74 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ getResetAddress()

MIDIAddress getResetAddress ( ) const
inlineinherited

Get the MIDI address of the reset action.

Definition at line 77 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ setResetAddress()

void setResetAddress ( MIDIAddress  address)
inlineinherited

Set the MIDI address of the reset action.

Definition at line 79 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ beginAll()

static void beginAll ( )
inlinestaticinherited

Begin all enabled instances of this class.

See also
begin()

Definition at line 186 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

Definition at line 190 of file Updatable.hpp.

◆ enable() [1/4]

void enable ( )
inlineinherited

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

Definition at line 100 of file Updatable.hpp.

◆ enable() [2/4]

static void enable ( UpdatableCRTP< Updatable< NormalUpdatable > > *  element)
inlinestaticinherited

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

Definition at line 129 of file Updatable.hpp.

◆ enable() [3/4]

static void enable ( UpdatableCRTP< Updatable< NormalUpdatable > > &  element)
inlinestaticinherited

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

Definition at line 131 of file Updatable.hpp.

◆ enable() [4/4]

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 134 of file Updatable.hpp.

◆ disable() [1/4]

void disable ( )
inlineinherited

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

Definition at line 110 of file Updatable.hpp.

◆ disable() [2/4]

static void disable ( UpdatableCRTP< Updatable< NormalUpdatable > > *  element)
inlinestaticinherited

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

Definition at line 140 of file Updatable.hpp.

◆ disable() [3/4]

static void disable ( UpdatableCRTP< Updatable< NormalUpdatable > > &  element)
inlinestaticinherited

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

Definition at line 142 of file Updatable.hpp.

◆ disable() [4/4]

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 145 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 124 of file Updatable.hpp.

◆ moveDown()

void moveDown ( )
inlineinherited

Move down this element in the list.

Definition at line 151 of file Updatable.hpp.

Member Data Documentation

◆ buttons

AH::IncrementDecrementButtons buttons
privateinherited

Definition at line 82 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ address

MIDIAddress address
privateinherited

Definition at line 83 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ multiplier

uint8_t multiplier
privateinherited

Definition at line 84 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ resetAddress

MIDIAddress resetAddress
privateinherited

Definition at line 85 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ relativeSender

RelativeCCSender relativeSender
inherited

Definition at line 88 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ resetSender

DigitalNoteSender resetSender
inherited

Definition at line 89 of file Abstract/MIDIIncrementDecrementButtons.hpp.

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables
staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next

Node* next = nullptr
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

Node* previous = nullptr
protectedinherited

Definition at line 325 of file LinkedList.hpp.


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