Control Surface main
MIDI Control Surface library for Arduino
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
GenericMIDIRotaryEncoder< Enc, Sender > Class Template Reference

#include <MIDI_Outputs/Abstract/MIDIRotaryEncoder.hpp>

Detailed Description

template<class Enc, class Sender>
class GenericMIDIRotaryEncoder< Enc, Sender >

An abstract class for rotary encoders that send MIDI events.

Examples
MCP23017-RotaryEncoder-Interrupts.ino, and MCP23017-RotaryEncoder-No-Interrupts.ino.

Definition at line 21 of file Abstract/MIDIRotaryEncoder.hpp.

+ Inheritance diagram for GenericMIDIRotaryEncoder< Enc, Sender >:
+ Collaboration diagram for GenericMIDIRotaryEncoder< Enc, Sender >:

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

 GenericMIDIRotaryEncoder (Enc &&encoder, MIDIAddress address, int16_t speedMultiply, uint8_t pulsesPerStep, const Sender &sender)
 Construct a new MIDIRotaryEncoder.
 
void begin () override
 Initialize this updatable.
 
void update () override
 Update this updatable.
 
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 ()
 

Public Attributes

Sender sender
 

Protected Attributes

Derived * next
 
Derived * previous
 

Static Protected Attributes

static DoublyLinkedList< Derived > updatables
 

Private Attributes

Enc encoder
 
MIDIAddress address
 
EncoderState< decltype(encoder.read())> encstate
 

Constructor & Destructor Documentation

◆ GenericMIDIRotaryEncoder()

template<class Enc , class Sender >
GenericMIDIRotaryEncoder ( Enc && encoder,
MIDIAddress address,
int16_t speedMultiply,
uint8_t pulsesPerStep,
const Sender & sender )
inline

Construct a new MIDIRotaryEncoder.

Examples
MCP23017-RotaryEncoder-Interrupts.ino, and MCP23017-RotaryEncoder-No-Interrupts.ino.

Definition at line 28 of file Abstract/MIDIRotaryEncoder.hpp.

Member Function Documentation

◆ begin()

template<class Enc , class Sender >
void begin ( )
inlineoverridevirtual

Initialize this updatable.

Implements Updatable< T >.

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

◆ update()

template<class Enc , class Sender >
void update ( )
inlineoverridevirtual

Update this updatable.

Implements Updatable< T >.

Definition at line 36 of file Abstract/MIDIRotaryEncoder.hpp.

◆ setSpeedMultiply()

template<class Enc , class Sender >
void setSpeedMultiply ( int16_t speedMultiply)
inline

Definition at line 43 of file Abstract/MIDIRotaryEncoder.hpp.

◆ getSpeedMultiply()

template<class Enc , class Sender >
int16_t getSpeedMultiply ( ) const
inline

Definition at line 46 of file Abstract/MIDIRotaryEncoder.hpp.

◆ getAddress()

template<class Enc , class Sender >
MIDIAddress getAddress ( ) const
inline

Get the MIDI address.

Definition at line 49 of file Abstract/MIDIRotaryEncoder.hpp.

◆ setAddress()

template<class Enc , class Sender >
void setAddress ( MIDIAddress address)
inline

Set the MIDI address.

Definition at line 51 of file Abstract/MIDIRotaryEncoder.hpp.

◆ resetPositionOffset()

template<class Enc , class Sender >
int16_t resetPositionOffset ( )
inline

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

◆ beginAll()

template<class T = NormalUpdatable>
static 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>
static void updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

Definition at line 186 of file Updatable.hpp.

◆ enable() [1/4]

template<class Derived >
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.

◆ enable() [2/4]

template<class Derived >
static void enable ( UpdatableCRTP< Derived > * element)
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.

◆ enable() [3/4]

template<class Derived >
static void enable ( UpdatableCRTP< Derived > & element)
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.

◆ 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]

template<class Derived >
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.

◆ disable() [2/4]

template<class Derived >
static void disable ( UpdatableCRTP< Derived > * element)
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.

◆ disable() [3/4]

template<class Derived >
static void disable ( UpdatableCRTP< Derived > & element)
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.

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

template<class Derived >
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()

template<class Derived >
void moveDown ( )
inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

Member Data Documentation

◆ encoder

template<class Enc , class Sender >
Enc encoder
private

Definition at line 59 of file Abstract/MIDIRotaryEncoder.hpp.

◆ address

template<class Enc , class Sender >
MIDIAddress address
private

Definition at line 60 of file Abstract/MIDIRotaryEncoder.hpp.

◆ encstate

template<class Enc , class Sender >
EncoderState<decltype(encoder.read())> encstate
private

Definition at line 61 of file Abstract/MIDIRotaryEncoder.hpp.

◆ sender

template<class Enc , class Sender >
Sender sender

Definition at line 64 of file Abstract/MIDIRotaryEncoder.hpp.

◆ updatables

template<class Derived >
DoublyLinkedList< Derived > updatables
staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next

Derived * next
protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous

Derived * previous
protectedinherited

Definition at line 321 of file LinkedList.hpp.


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