#include <MIDI_Outputs/Bankable/CCIncrementDecrementButtons.hpp>

Detailed Description

A class of MIDIOutputElements that read the input of two momentary push buttons to increment or decrement a relative setting using relative MIDI Control Change events.

An optional note number can be provided to reset the setting.

This version can be banked.

Definition at line 21 of file Bankable/CCIncrementDecrementButtons.hpp.

Inheritance diagram for CCIncrementDecrementButtons:

Collaboration diagram for CCIncrementDecrementButtons:

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
	CCIncrementDecrementButtons (OutputBankConfig<> config, AH::IncrementDecrementButtons buttons, MIDIAddress address, uint8_t multiplier=1, MIDIAddress resetNote=MIDIAddress::invalid(), const RelativeCCSender &relativeSender={}, const DigitalNoteSender &resetSender={})
	Construct a new Bankable CCIncrementDecrementButtons object. More...

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

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

void	send (long delta, MIDIAddress address)

void	reset ()

void	invert ()

AH::IncrementDecrementButtons::State	getButtonsState () const

Public Attributes
RelativeCCSender	relativeSender

DigitalNoteSender	resetSender

Protected Attributes
DualAddresses	addresses

AH::IncrementDecrementButtons	buttons

const uint8_t	multiplier

Updatable< NormalUpdatable > *	next

Updatable< NormalUpdatable > *	previous

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

Constructor & Destructor Documentation

◆ CCIncrementDecrementButtons()

CCIncrementDecrementButtons	(	OutputBankConfig<>	config,
		AH::IncrementDecrementButtons	buttons,
		MIDIAddress	address,
		uint8_t	multiplier = `1`,
		MIDIAddress	resetNote = `MIDIAddress::invalid()`,
		const RelativeCCSender &	relativeSender = `{}`,
		const DigitalNoteSender &	resetSender = `{}`
	)

inline

Construct a new Bankable CCIncrementDecrementButtons object.

Parameters

config	The bank configuration to use: the bank to add this element to, and whether to change the address, channel or cable number.
buttons	The pins with the increment and decrement buttons connected. The internal pull-up resistors will be enabled.
address	The address to use for the relative events, containing the controller number [0, 119], channel [CHANNEL_1, CHANNEL_16], and optional cable number [CABLE_1, CABLE_16].
multiplier	The multiplier for the relative events. When setting it to 2, it will scroll twice as fast, for example.
resetNote	The MIDI address to use to reset the setting, containing the note number [0, 119], channel [CHANNEL_1, CHANNEL_16], and optional cable number [CABLE_1, CABLE_16]. It will be triggered when the increment and decrement buttons are pressed simultaneously.
relativeSender	The MIDI sender to use for the relative events.
resetSender	The MIDI sender to use for reset events.

Definition at line 52 of file Bankable/CCIncrementDecrementButtons.hpp.

Member Function Documentation

◆ begin()

void begin ( )

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

Definition at line 35 of file Bankable/Abstract/MIDIIncrementDecrementButtons.hpp.

◆ update()

void update ( )

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

Definition at line 37 of file Bankable/Abstract/MIDIIncrementDecrementButtons.hpp.

◆ send()

void send	(	long	delta,
		MIDIAddress	address
	)

inlineinherited

Definition at line 57 of file Bankable/Abstract/MIDIIncrementDecrementButtons.hpp.

◆ reset()

void reset ( )

inlineinherited

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

◆ invert()

void invert ( )

inlineinherited

See also: AH::Button::invert()

Definition at line 70 of file Bankable/Abstract/MIDIIncrementDecrementButtons.hpp.

◆ getButtonsState()

AH::IncrementDecrementButtons::State getButtonsState ( ) const

inlineinherited

Definition at line 72 of file Bankable/Abstract/MIDIIncrementDecrementButtons.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

◆ addresses

DualAddresses addresses

protectedinherited

Definition at line 77 of file Bankable/Abstract/MIDIIncrementDecrementButtons.hpp.

◆ buttons

AH::IncrementDecrementButtons buttons

protectedinherited

Definition at line 78 of file Bankable/Abstract/MIDIIncrementDecrementButtons.hpp.

◆ multiplier

const uint8_t multiplier

protectedinherited

Definition at line 79 of file Bankable/Abstract/MIDIIncrementDecrementButtons.hpp.

◆ relativeSender

RelativeCCSender relativeSender

inherited

Definition at line 82 of file Bankable/Abstract/MIDIIncrementDecrementButtons.hpp.

◆ resetSender

DigitalNoteSender resetSender

inherited

Definition at line 83 of file Bankable/Abstract/MIDIIncrementDecrementButtons.hpp.

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables

staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * next

protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * previous

protectedinherited

Definition at line 325 of file LinkedList.hpp.

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

Bankable/CCIncrementDecrementButtons.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

◆ CCIncrementDecrementButtons()

Member Function Documentation

◆ begin()

◆ update()

◆ send()

◆ reset()

◆ invert()

◆ getButtonsState()

◆ 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

◆ addresses

◆ buttons

◆ multiplier

◆ relativeSender

◆ resetSender

◆ updatables

◆ next

◆ previous