#include <MIDI_Outputs/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 cannot be banked.
Definition at line 17 of file 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 (AHEncoder &&encoder, MIDIChannelCable address, int16_t multiplier=1, uint8_t pulsesPerStep=4) | |
Construct a new PBAbsoluteEncoder object with the given pins, address, 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. | |
uint16_t | getValue () const |
Get the absolute value of the encoder. | |
void | setValue (uint16_t value) |
Set the absolute value of the encoder. | |
void | setSpeedMultiply (int16_t speedMultiply) |
int16_t | getSpeedMultiply () const |
MIDIAddress | getAddress () const |
Get the MIDI address. | |
void | setAddress (MIDIAddress address) |
Set the MIDI address. | |
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 | |
Derived * | next |
Derived * | previous |
Static Protected Attributes | |
static DoublyLinkedList< Derived > | updatables |
Private Attributes | |
Enc | encoder |
MIDIAddress | address |
int16_t | value = 0 |
EncoderState< decltype(encoder.read())> | encstate |
Static Private Attributes | |
static constexpr int16_t | maxValue = uint16_t(1u << Sender::precision()) - 1 |
|
inline |
Construct a new PBAbsoluteEncoder object with the given pins, address, channel, speed factor, and number of pulses per step.
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 [Cable_1, Cable_16]. |
multiplier | A constant factor to increase the speed of the rotary encoder. The 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 speedMultiplier factor will increase the speed, increasing the number of pulsesPerStep will result in a lower speed. |
Definition at line 44 of file PBAbsoluteEncoder.hpp.
|
inlineoverridevirtualinherited |
Initialize this updatable.
Implements Updatable< T >.
Definition at line 31 of file Abstract/MIDIAbsoluteEncoder.hpp.
|
inlineoverridevirtualinherited |
Update this updatable.
Implements Updatable< T >.
Definition at line 33 of file Abstract/MIDIAbsoluteEncoder.hpp.
|
inlineinherited |
Send the current value over MIDI, even if the position of the encoder didn't change.
Definition at line 48 of file Abstract/MIDIAbsoluteEncoder.hpp.
|
inlineinherited |
Get the absolute value of the encoder.
Definition at line 53 of file Abstract/MIDIAbsoluteEncoder.hpp.
|
inlineinherited |
Set the absolute value of the encoder.
Definition at line 58 of file Abstract/MIDIAbsoluteEncoder.hpp.
|
inlinestaticinherited |
Get the maximum possible value that can be returned by getValue.
Definition at line 61 of file Abstract/MIDIAbsoluteEncoder.hpp.
|
inlineinherited |
Definition at line 63 of file Abstract/MIDIAbsoluteEncoder.hpp.
|
inlineinherited |
Definition at line 66 of file Abstract/MIDIAbsoluteEncoder.hpp.
|
inlineinherited |
Get the MIDI address.
Definition at line 69 of file Abstract/MIDIAbsoluteEncoder.hpp.
|
inlineinherited |
Set the MIDI address.
Definition at line 71 of file Abstract/MIDIAbsoluteEncoder.hpp.
|
inlineinherited |
Definition at line 73 of file 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.
|
privateinherited |
Definition at line 79 of file Abstract/MIDIAbsoluteEncoder.hpp.
|
privateinherited |
Definition at line 80 of file Abstract/MIDIAbsoluteEncoder.hpp.
|
privateinherited |
Definition at line 81 of file Abstract/MIDIAbsoluteEncoder.hpp.
|
privateinherited |
Definition at line 82 of file Abstract/MIDIAbsoluteEncoder.hpp.
|
staticconstexprprivateinherited |
Definition at line 84 of file Abstract/MIDIAbsoluteEncoder.hpp.
|
inherited |
Definition at line 87 of file 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.