#include <MIDI_Outputs/Bankable/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 version can be banked.

Definition at line 20 of file Bankable/CCRotaryEncoder.hpp.

Inheritance diagram for CCRotaryEncoder:

Collaboration diagram for CCRotaryEncoder:

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
	CCRotaryEncoder (OutputBankConfig<> config, AHEncoder &&encoder, MIDIAddress address, int16_t speedMultiply=1, uint8_t pulsesPerStep=4)
	Construct a new Bankable CCRotaryEncoder object with the given pins, controller, channel, speed factor, and number of pulses per step.

void	begin () override
	Initialize this updatable.

void	update () override
	Update this updatable.

void	setSpeedMultiply (int16_t speedMultiply)

int16_t	getSpeedMultiply () const

int16_t	resetPositionOffset ()

Public Attributes
Sender	sender

Protected Attributes
BankAddress	address

Enc	encoder

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

Derived *	next

Derived *	previous

Static Protected Attributes
static DoublyLinkedList< Derived >	updatables

Constructor & Destructor Documentation

◆ CCRotaryEncoder()

CCRotaryEncoder	(	OutputBankConfig<>	config,
		AHEncoder &&	encoder,
		MIDIAddress	address,
		int16_t	speedMultiply = 1,
		uint8_t	pulsesPerStep = 4 )

inline

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

Parameters

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 address containing the controller number [0, 119], channel [Channel_1, Channel_16], and optional cable number [Cable_1, Cable_16]1, Cable_16].
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 54 of file Bankable/CCRotaryEncoder.hpp.

Member Function Documentation

◆ begin()

template<class Enc , class BankAddress , class Sender >

void begin ( )

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

Definition at line 39 of file Bankable/Abstract/MIDIRotaryEncoder.hpp.

◆ update()

template<class Enc , class BankAddress , class Sender >

void update ( )

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

Definition at line 41 of file Bankable/Abstract/MIDIRotaryEncoder.hpp.

◆ setSpeedMultiply()

template<class Enc , class BankAddress , class Sender >

void setSpeedMultiply ( int16_t speedMultiply )

inlineinherited

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

◆ getSpeedMultiply()

template<class Enc , class BankAddress , class Sender >

int16_t getSpeedMultiply ( ) const

inlineinherited

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

◆ resetPositionOffset()

template<class Enc , class BankAddress , class Sender >

int16_t resetPositionOffset ( )

inlineinherited

Definition at line 53 of file Bankable/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

◆ address

template<class Enc , class BankAddress , class Sender >

BankAddress address

protectedinherited

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

◆ encoder

template<class Enc , class BankAddress , class Sender >

Enc encoder

protectedinherited

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

◆ encstate

template<class Enc , class BankAddress , class Sender >

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

protectedinherited

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

◆ sender

template<class Enc , class BankAddress , class Sender >

Sender sender

inherited

Definition at line 64 of file Bankable/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:

Bankable/CCRotaryEncoder.hpp

Detailed Description

Enabling and disabling updatables

Main initialization and updating methods

Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

◆ CCRotaryEncoder()

Member Function Documentation

◆ begin()

◆ update()

◆ setSpeedMultiply()

◆ getSpeedMultiply()

◆ resetPositionOffset()

◆ beginAll()

◆ updateAll()

◆ enable() [1/4]

◆ enable() [2/4]

◆ enable() [3/4]

◆ enable() [4/4]

◆ disable() [1/4]

◆ disable() [2/4]

◆ disable() [3/4]

◆ disable() [4/4]

◆ isEnabled()

◆ moveDown()

Member Data Documentation

◆ address

◆ encoder

◆ encstate

◆ sender

◆ updatables

◆ next

◆ previous