#include <MIDI_Outputs/Bankable/PBAbsoluteEncoder.hpp>
A class of MIDIOutputElements that read the input of a quadrature (rotary) encoder and send out absolute MIDI Pitch Bend events.
This version can be banked.
NumBanks | The number of banks. |
Definition at line 24 of file Bankable/PBAbsoluteEncoder.hpp.
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 | |
PBAbsoluteEncoder (const BankConfig< NumBanks > &config, AHEncoder &&encoder, MIDIChannelCable address, int16_t speedMultiply=1, uint8_t pulsesPerStep=4) | |
Construct a new Bankable PBAbsoluteEncoder object with the given pins, channel, speed factor, and number of pulses per step. | |
void | begin () override |
Initialize this updatable. | |
void | update () override |
Update this updatable. | |
void | forcedUpdate () |
Send the current value over MIDI, even if the position of the encoder didn't change. | |
void | forcedUpdate (setting_t bank) |
uint16_t | getValue (setting_t bank) const |
Get the absolute value of the encoder in the given bank. | |
uint16_t | getValue () const |
Get the absolute value of the encoder in the active bank. | |
void | setValue (uint16_t value, setting_t bank) |
Set the absolute value of the encoder in the given bank. | |
void | setValue (uint16_t value) |
Set the absolute value of the encoder in the active bank. | |
void | setSpeedMultiply (int16_t speedMultiply) |
int16_t | getSpeedMultiply () const |
int16_t | resetPositionOffset () |
Static Public Member Functions | |
static int16_t | getMaxValue () |
Get the maximum possible value that can be returned by getValue. | |
Public Attributes | |
Sender | sender |
Protected Attributes | |
Enc | encoder |
BankAddress | address |
Array< int16_t, NumBanks > | values = {{}} |
EncoderState< decltype(encoder.read())> | encstate |
Derived * | next |
Derived * | previous |
Static Protected Attributes | |
static constexpr int16_t | maxValue = uint16_t(1u << Sender::precision()) - 1 |
static DoublyLinkedList< Derived > | updatables |
|
inline |
Construct a new Bankable PBAbsoluteEncoder object with the given pins, channel, speed factor, and number of pulses per step.
config | The bank configuration to use: the bank to add this element to, and whether to change the address, channel or cable number. |
encoder | The Encoder object to use. Usually passed as a list of the two pins connected to the A and B outputs of the encoder, e.g. {2, 3} . The internal pull-up resistors will be enabled by the Encoder library. |
address | The MIDI channel [Channel_1, Channel_16], and optional cable number [0, 15]. |
speedMultiply | A constant factor to increase the speed of the rotary encoder. The difference in position will just be multiplied by this factor. |
pulsesPerStep | The number of pulses per physical click of the encoder. For a normal encoder, this is 4. If you want to increase the resolution, for the use of Jog wheels, for example, you can go as 1. Whereas a greater speedMultiply factor will increase the speed, increasing the number of pulsesPerStep will result in a lower speed. |
Definition at line 56 of file Bankable/PBAbsoluteEncoder.hpp.
|
inlineoverridevirtualinherited |
Initialize this updatable.
Implements Updatable< T >.
Definition at line 33 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.
|
inlineoverridevirtualinherited |
Update this updatable.
Implements Updatable< T >.
Definition at line 35 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.
|
inlineinherited |
Send the current value over MIDI, even if the position of the encoder didn't change.
Definition at line 52 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.
Definition at line 55 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.
Get the absolute value of the encoder in the given bank.
Definition at line 62 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.
|
inlineinherited |
Get the absolute value of the encoder in the active bank.
Definition at line 66 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.
Set the absolute value of the encoder in the given bank.
Definition at line 71 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.
Set the absolute value of the encoder in the active bank.
Definition at line 75 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.
Get the maximum possible value that can be returned by getValue.
Definition at line 78 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.
Definition at line 80 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.
|
inlineinherited |
Definition at line 83 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.
|
inlineinherited |
Definition at line 85 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.
|
inlinestaticinherited |
Begin all enabled instances of this class.
Definition at line 182 of file Updatable.hpp.
|
inlinestaticinherited |
Update all enabled instances of this class.
Definition at line 186 of file Updatable.hpp.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
inlineinherited |
Check if this updatable is enabled.
Definition at line 120 of file Updatable.hpp.
|
inlineinherited |
Move down this element in the list.
Definition at line 147 of file Updatable.hpp.
|
protectedinherited |
Definition at line 91 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.
|
protectedinherited |
Definition at line 92 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.
|
protectedinherited |
Definition at line 93 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.
|
protectedinherited |
Definition at line 94 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.
|
staticconstexprprotectedinherited |
Definition at line 96 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.
|
inherited |
Definition at line 99 of file Bankable/Abstract/MIDIAbsoluteEncoder.hpp.
|
staticprotectedinherited |
Definition at line 152 of file Updatable.hpp.
|
protectedinherited |
Definition at line 320 of file LinkedList.hpp.
|
protectedinherited |
Definition at line 321 of file LinkedList.hpp.