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

#include <MIDI_Outputs/ManyAddresses/CCRotaryEncoder.hpp>

Inheritance diagram for CCRotaryEncoder< NumBanks >:

Collaboration diagram for CCRotaryEncoder< NumBanks >:

Public Types
using	Mutex = typename std::conditional< ThreadSafe, DefaultMutEx, EmptyMutex >::type

using	LockGuard = typename std::conditional< ThreadSafe, DefaultLockGuard< Mutex >, EmptyLockGuard< Mutex > >::type

Public Member Functions
	CCRotaryEncoder (const Bank< NumBanks > &bank, const EncoderPinList &pins, const Array< MIDIAddress, NumBanks > &addresses, int8_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. More...

void	begin () final override
	Initialize this updatable. More...

void	update () final override
	Update this updatable. More...

Static Public Member Functions
static Mutex &	getMutex ()

Public Attributes
RelativeCCSender	sender

Protected Attributes
Updatable< NormalUpdatable, false > *	next

Updatable< NormalUpdatable, false > *	previous

Static Protected Attributes
static DoublyLinkedList< Updatable< NormalUpdatable, false > >	updatables

static Mutex	mutex

Private Attributes
ManyAddresses< NumBanks >	address

Encoder	encoder

const uint8_t	speedMultiply

const uint8_t	pulsesPerStep

long	previousPosition

Main initialization and updating methods
static void	applyToAll (const LockGuard &, void(Derived::*method)(Args &&...), Args &&... args)

static void	applyToAll (void(Derived::*method)(Args &&...), Args &&... args)

Enabling and disabling updatables
void	enable (const LockGuard &lock)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

void	disable (const LockGuard &lock)
	Disable this updatable: remove it from the linked list of instances, so it no longer 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 LockGuard &) const
	Check if this updatable is enabled. More...

bool	isEnabled ()
	Check if this updatable is enabled. More...

void	moveDown (const LockGuard &)
	Move down this element in the list. 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...

Detailed Description

template<setting_t NumBanks>
class Bankable::ManyAddresses::CCRotaryEncoder< NumBanks >

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 using an arbitrary list of alternative addresses.

Template Parameters

NumBanks The number of variants/alternative addresses the element has.

Definition at line 26 of file ManyAddresses/CCRotaryEncoder.hpp.

Member Typedef Documentation

◆ Mutex

using Mutex = typename std::conditional<ThreadSafe, DefaultMutEx, EmptyMutex>::type

inherited

Definition at line 36 of file Updatable.hpp.

◆ LockGuard

using LockGuard = typename std::conditional<ThreadSafe, DefaultLockGuard<Mutex>, EmptyLockGuard<Mutex> >::type

inherited

Definition at line 38 of file Updatable.hpp.

Constructor & Destructor Documentation

◆ CCRotaryEncoder()

CCRotaryEncoder	(	const Bank< NumBanks > &	bank,
		const EncoderPinList &	pins,
		const Array< MIDIAddress, NumBanks > &	addresses,
		int8_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

bank	The bank that selects the address to use.
pins	A list of the two pins connected to the A and B outputs of the encoder. The internal pull-up resistors will be enabled by the Encoder library.
addresses	The list of MIDI addresses containing the controller number [0, 119], channel [CHANNEL_1, CHANNEL_16], and optional cable number [CABLE_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 58 of file ManyAddresses/CCRotaryEncoder.hpp.

Member Function Documentation

◆ begin()

void begin

inlinefinaloverridevirtualinherited

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

void update

inlinefinaloverridevirtualinherited

Update this updatable.

Implements Updatable<>.

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

◆ beginAll()

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 208 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 212 of file Updatable.hpp.

◆ getMutex()

static Mutex& getMutex ( )

inlinestaticinherited

Definition at line 79 of file Updatable.hpp.

◆ applyToAll() [1/2]

static void applyToAll	(	const LockGuard &	,
		void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ applyToAll() [2/2]

static void applyToAll	(	void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 93 of file Updatable.hpp.