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
BorrowedCCRotaryEncoder Class Reference

#include <MIDI_Outputs/CCRotaryEncoder.hpp>

Detailed Description

A class of MIDIOutputElements that read the input of a quadrature (rotary) encoder and send out relative MIDI Control Change events.

This class just saves a reference to the encoder you give it, so it can be shared with other classes.

This version cannot be banked.

Definition at line 62 of file CCRotaryEncoder.hpp.

+ Inheritance diagram for BorrowedCCRotaryEncoder:
+ Collaboration diagram for BorrowedCCRotaryEncoder:

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

 BorrowedCCRotaryEncoder (Encoder &encoder, MIDIAddress address, int16_t speedMultiply=1, uint8_t pulsesPerStep=4)
 Construct a new CCRotaryEncoder object with the given pins, address, channel, speed factor, and number of pulses per step. More...
 
void begin () override
 Initialize this updatable. More...
 
void update () override
 Update this updatable. More...
 
void setSpeedMultiply (int16_t speedMultiply)
 
int16_t getSpeedMultiply () const
 
MIDIAddress getAddress () const
 Get the MIDI address. More...
 
void setAddress (MIDIAddress address)
 Set the MIDI address. More...
 

Public Attributes

Sender sender
 

Protected Attributes

Node * next = nullptr
 
Node * previous = nullptr
 

Static Protected Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Private Attributes

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

Constructor & Destructor Documentation

◆ BorrowedCCRotaryEncoder()

BorrowedCCRotaryEncoder ( Encoder encoder,
MIDIAddress  address,
int16_t  speedMultiply = 1,
uint8_t  pulsesPerStep = 4 
)
inline

Construct a new CCRotaryEncoder object with the given pins, address, channel, speed factor, and number of pulses per step.

Parameters
encoderThe Encoder object to use. Saved by reference, so it must out-live this instance.
addressThe MIDI address containing the controller number [0, 119], channel [CHANNEL_1, CHANNEL_16], and optional cable number [0, 15].
speedMultiplyA constant factor to increase the speed of the rotary encoder. The difference in position will just be multiplied by this factor.
pulsesPerStepThe 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 89 of file CCRotaryEncoder.hpp.

Member Function Documentation

◆ begin()

void begin ( )
inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

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

◆ update()

void update ( )
inlineoverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

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

◆ setSpeedMultiply()

void setSpeedMultiply ( int16_t  speedMultiply)
inlineinherited

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

◆ getSpeedMultiply()

int16_t getSpeedMultiply ( ) const
inlineinherited

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

◆ getAddress()

MIDIAddress getAddress ( ) const
inlineinherited

Get the MIDI address.

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

◆ setAddress()

void setAddress ( MIDIAddress  address)
inlineinherited

Set the MIDI address.

Definition at line 53 of file Abstract/MIDIRotaryEncoder.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

◆ encoder

Enc encoder
privateinherited

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

◆ address

MIDIAddress address
privateinherited

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

◆ encstate

EncoderState<decltype(encoder.read())> encstate
privateinherited

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

◆ sender

Sender sender
inherited

Definition at line 61 of file Abstract/MIDIRotaryEncoder.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: