#include <MIDI_Outputs/Bankable/CCPotentiometer.hpp>
A class of MIDIOutputElements that read the analog input from a potentiometer or fader, and send out 7-bit MIDI Control Change events.
The analog input is filtered and hysteresis is applied for maximum stability.
This version can be banked.
- Examples
- Bank.ino, Encoder-Selector-Bank.ino, MIDI-Controller-Finished-Example.ino, and MIDI_controller-97.ino.
Definition at line 22 of file Bankable/CCPotentiometer.hpp.
|
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.
|
|
|
static void | beginAll () |
| Begin all enabled instances of this class.
|
|
static void | updateAll () |
| Update all enabled instances of this class.
|
|
|
| CCPotentiometer (OutputBankConfig<> config, pin_t analogPin, MIDIAddress address) |
| Create a new Bankable CCPotentiometer object with the given analog pin, controller number and channel.
|
|
void | begin () final override |
| Initialize this updatable.
|
|
void | update () final override |
| Update this updatable.
|
|
void | forcedUpdate () |
| Send the value of the analog input over MIDI, even if the value didn't change.
|
|
void | map (MappingFunction fn) |
| Specify a mapping function that is applied to the raw analog value before sending.
|
|
void | invert () |
| Invert the analog value.
|
|
analog_t | getRawValue () const |
| Get the raw value of the analog input (this is the value without applying the filter or the mapping function first).
|
|
analog_t | getValue () const |
| Get the value of the analog input (this is the value after first applying the mapping function).
|
|
◆ FilteredAnalog
◆ CCPotentiometer()
Create a new Bankable CCPotentiometer object with the given analog pin, controller number and channel.
- Parameters
-
config | The bank configuration to use: the bank to add this element to, and whether to change the address, channel or cable number. |
analogPin | The analog input pin to read from. |
address | The MIDI address containing the controller number [0, 119], channel [Channel_1, Channel_16], and optional cable number [Cable_1, Cable_16]. |
Definition at line 39 of file Bankable/CCPotentiometer.hpp.
◆ begin()
|
inlinefinaloverridevirtualinherited |
◆ update()
|
inlinefinaloverridevirtualinherited |
◆ forcedUpdate()
◆ map()
Specify a mapping function that is applied to the raw analog value before sending.
- Parameters
-
fn | A function pointer to the mapping function. This function should take the filtered analog value of \( 16 -
\mathrm{ANALOG\_FILTER\_SHIFT\_FACTOR} \) bits as a parameter, and should return a value in the same range. |
- See also
- FilteredAnalog::map
Definition at line 64 of file Bankable/Abstract/MIDIFilteredAnalog.hpp.
◆ invert()
◆ getRawValue()
analog_t getRawValue |
( |
| ) |
const |
|
inlineinherited |
◆ getMaxRawValue()
static constexpr analog_t getMaxRawValue |
( |
| ) |
|
|
inlinestaticconstexprinherited |
◆ getValue()
analog_t getValue |
( |
| ) |
const |
|
inlineinherited |
◆ beginAll()
template<class T = NormalUpdatable>
◆ updateAll()
template<class T = NormalUpdatable>
static void updateAll |
( |
| ) |
|
|
inlinestaticinherited |
◆ enable() [1/4]
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]
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]
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]
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]
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]
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()
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()
Move down this element in the list.
Definition at line 147 of file Updatable.hpp.
◆ address
◆ filteredAnalog
◆ sender
◆ updatables
◆ next
◆ previous
The documentation for this class was generated from the following file: