Control Surface master
MIDI Control Surface library for Arduino
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
VPotRing< BankSize > Class Template Referenceabstract

#include <MIDI_Inputs/MCU/VPotRing.hpp>

Detailed Description

template<uint8_t BankSize>
class MCU::Bankable::VPotRing< BankSize >

A MIDI input element that represents a Mackie Control Universal VPot ring.

This version can be banked.

Template Parameters
BankSizeThe number of banks.
Examples
MCU-OLED-SSD1306-x2.ino, and MCU-OLED-SSD1306.ino.

Definition at line 237 of file VPotRing.hpp.

+ Inheritance diagram for VPotRing< BankSize >:
+ Collaboration diagram for VPotRing< BankSize >:

Data access

VPotState getState (uint8_t bank) const
 Get the full state of the VPot ring. (For the given bank.) More...
 
uint8_t getPosition (uint8_t bank) const
 Return the position of the V-Pot ring. [0, 11]. More...
 
bool getCenterLed (uint8_t bank) const
 Return the status of the center LED of the V-Pot ring. More...
 
VPotState::Mode getMode (uint8_t bank) const
 Return the mode of the V-Pot ring. More...
 
uint8_t getStartOn (uint8_t bank) const
 Get the first segment that should be on. More...
 
uint8_t getStartOff (uint8_t bank) const
 Get the first segment that should be off. More...
 
VPotState getState () const
 Get the full state of the VPot ring. (For the active bank.) More...
 
uint8_t getPosition () const
 Return the position of the V-Pot ring. [0, 11]. More...
 
bool getCenterLed () const override
 Return the status of the center LED of the V-Pot ring. More...
 
VPotState::Mode getMode () const
 Return the mode of the V-Pot ring. More...
 
uint8_t getStartOn () const override
 Get the first segment that should be on. More...
 
uint8_t getStartOff () const override
 Get the first segment that should be off. More...
 

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...
 

Detecting changes

bool getDirty () const
 Check if the value was updated since the last time the dirty flag was cleared. More...
 
void clearDirty ()
 Clear the dirty flag. More...
 

Public Types

using Matcher = BankableVPotMatcher< BankSize >
 
using Parent = BankableMatchingMIDIInputElement< MIDIMessageType::CONTROL_CHANGE, Matcher >
 
using MessageType = typename MIDIInputElement< Type >::MessageType
 

Public Member Functions

 VPotRing (BankConfig< BankSize > config, uint8_t track, MIDIChannelCable channelCN=CHANNEL_1)
 Constructor. More...
 
void reset () override
 Reset all states to zero. More...
 
bool updateWith (MessageType midimsg) override
 Receive a new MIDI message and update the internal state. More...
 
virtual void handleUpdate (typename Matcher::Result match)=0
 
virtual void begin ()
 Initialize the input element. More...
 
virtual void update ()
 Update the value of the input element. Used for decaying VU meters etc. More...
 

Static Public Member Functions

static bool updateAllWith (MessageType midimsg)
 Update all. More...
 
static void updateAll ()
 Update all. More...
 
static void beginAll ()
 Begin all. More...
 
static void resetAll ()
 Reset all. More...
 

Public Attributes

bool ignoreReset = true
 Don't reset the state when calling the reset method. More...
 

Protected Member Functions

bool handleUpdateImpl (typename Matcher::Result match)
 
void handleUpdate (typename Matcher::Result match) override
 
void onBankSettingChange () override
 A function to be executed each time the bank setting changes. More...
 
uint8_t getActiveBank () const
 

Protected Attributes

BankableVPotMatcher< BankSize > matcher
 
MIDIInputElement< Type > * next
 
BankSettingChangeCallbacknext
 
MIDIInputElement< Type > * previous
 
BankSettingChangeCallbackprevious
 
bool dirty = true
 

Static Protected Attributes

static DoublyLinkedList< MIDIInputElement< Type > > updatables
 

Private Attributes

AH::Array< VPotState, BankSize > states = {{}}
 

Member Typedef Documentation

◆ Matcher

using Matcher = BankableVPotMatcher<BankSize>

Definition at line 242 of file VPotRing.hpp.

◆ Parent

Definition at line 243 of file VPotRing.hpp.

◆ MessageType

using MessageType = typename MIDIInputElement<Type>::MessageType
inherited

Definition at line 93 of file MIDIInputElement.hpp.

Constructor & Destructor Documentation

◆ VPotRing()

VPotRing ( BankConfig< BankSize >  config,
uint8_t  track,
MIDIChannelCable  channelCN = CHANNEL_1 
)
inline

Constructor.

Parameters
configThe bank configuration to use: the bank to add this element to, and whether to change the address, channel or cable number.
trackThe track of the VPot [1, 8].
channelCNThe MIDI channel [CHANNEL_1, CHANNEL_16] and Cable Number [CABLE_1, CABLE_16].

Definition at line 258 of file VPotRing.hpp.

Member Function Documentation

◆ handleUpdateImpl()

bool handleUpdateImpl ( typename Matcher::Result  match)
inlineprotected

Definition at line 263 of file VPotRing.hpp.

◆ handleUpdate() [1/2]

void handleUpdate ( typename Matcher::Result  match)
inlineoverrideprotected

Definition at line 269 of file VPotRing.hpp.

◆ getState() [1/2]

VPotState getState ( uint8_t  bank) const
inline

Get the full state of the VPot ring. (For the given bank.)

Definition at line 278 of file VPotRing.hpp.

◆ getPosition() [1/2]

uint8_t getPosition ( uint8_t  bank) const
inline

Return the position of the V-Pot ring. [0, 11].

(For the given bank.)

Definition at line 282 of file VPotRing.hpp.

◆ getCenterLed() [1/2]

bool getCenterLed ( uint8_t  bank) const
inline

Return the status of the center LED of the V-Pot ring.

(For the given bank.)

Definition at line 287 of file VPotRing.hpp.

◆ getMode() [1/2]

VPotState::Mode getMode ( uint8_t  bank) const
inline

Return the mode of the V-Pot ring.

(For the given bank.)

Definition at line 292 of file VPotRing.hpp.

◆ getStartOn() [1/2]

uint8_t getStartOn ( uint8_t  bank) const
inline

Get the first segment that should be on.

(For the given bank.)

Definition at line 298 of file VPotRing.hpp.

◆ getStartOff() [1/2]

uint8_t getStartOff ( uint8_t  bank) const
inline

Get the first segment that should be off.

(For the given bank.)

Definition at line 303 of file VPotRing.hpp.

◆ getState() [2/2]

VPotState getState ( ) const
inline

Get the full state of the VPot ring. (For the active bank.)

Definition at line 308 of file VPotRing.hpp.

◆ getPosition() [2/2]

uint8_t getPosition ( ) const
inline

Return the position of the V-Pot ring. [0, 11].

(For the active bank.)

Definition at line 312 of file VPotRing.hpp.

◆ getCenterLed() [2/2]

bool getCenterLed ( ) const
inlineoverridevirtual

Return the status of the center LED of the V-Pot ring.

(For the active bank.)

Implements IVPot.

Definition at line 315 of file VPotRing.hpp.

◆ getMode() [2/2]

VPotState::Mode getMode ( ) const
inline

Return the mode of the V-Pot ring.

(For the active bank.)

Definition at line 320 of file VPotRing.hpp.

◆ getStartOn() [2/2]

uint8_t getStartOn ( ) const
inlineoverridevirtual

Get the first segment that should be on.

(For the active bank.)

Implements IVPot.

Definition at line 324 of file VPotRing.hpp.

◆ getStartOff() [2/2]

uint8_t getStartOff ( ) const
inlineoverridevirtual

Get the first segment that should be off.

(For the active bank.)

Implements IVPot.

Definition at line 329 of file VPotRing.hpp.

◆ reset()

void reset ( )
inlineoverridevirtual

Reset all states to zero.

Reimplemented from MIDIInputElement< Type >.

Definition at line 336 of file VPotRing.hpp.

◆ onBankSettingChange()

void onBankSettingChange ( )
inlineoverrideprotectedvirtual

A function to be executed each time the bank setting changes.

Think of an LED that indicates whether a track is muted or not. If this LED is bankable, let's say with 4 tracks per bank, 2 banks, and a base address of 3, then this LED object keeps the state of tracks 3 and 7. When the bank setting is 0, the LED displays the state of track 3, when the bank setting is 1, the LED displays the state of track 7. To know when to update the LED, this callback is used.

Reimplemented from BankSettingChangeCallback.

Definition at line 344 of file VPotRing.hpp.

◆ getActiveBank()

uint8_t getActiveBank ( ) const
inlineprotectedinherited

Definition at line 126 of file MIDIInputElement.hpp.

◆ updateWith()

bool updateWith ( MessageType  midimsg)
inlineoverridevirtualinherited

Receive a new MIDI message and update the internal state.

Implements MIDIInputElement< Type >.

Definition at line 95 of file MIDIInputElement.hpp.

◆ handleUpdate() [2/2]

virtual void handleUpdate ( typename Matcher::Result  match)
pure virtualinherited

Implemented in VPotRingLEDs< BankSize >.

◆ begin()

virtual void begin ( )
inlinevirtualinherited

◆ update()

virtual void update ( )
inlinevirtualinherited

Update the value of the input element. Used for decaying VU meters etc.

Reimplemented in VULEDs< NumLEDs >, VULEDs< BankSize, NumLEDs >, VU, and VU< BankSize >.

Definition at line 40 of file MIDIInputElement.hpp.

◆ updateAllWith()

static bool updateAllWith ( MessageType  midimsg)
inlinestaticinherited

Update all.

Definition at line 46 of file MIDIInputElement.hpp.

◆ updateAll()

static void updateAll ( )
inlinestaticinherited

Update all.

Definition at line 57 of file MIDIInputElement.hpp.

◆ beginAll()

static void beginAll ( )
inlinestaticinherited

Begin all.

Definition at line 62 of file MIDIInputElement.hpp.

◆ resetAll()

static void resetAll ( )
inlinestaticinherited

Reset all.

Definition at line 67 of file MIDIInputElement.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< MIDIInputElement< Type > > *  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< MIDIInputElement< Type > > &  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< MIDIInputElement< Type > > *  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< MIDIInputElement< Type > > &  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.

◆ getDirty()

bool getDirty ( ) const
inlineinherited

Check if the value was updated since the last time the dirty flag was cleared.

Definition at line 64 of file InterfaceMIDIInputElements.hpp.

◆ clearDirty()

void clearDirty ( )
inlineinherited

Clear the dirty flag.

Definition at line 66 of file InterfaceMIDIInputElements.hpp.

Member Data Documentation

◆ states

AH::Array<VPotState, BankSize> states = {{}}
private

Definition at line 347 of file VPotRing.hpp.

◆ ignoreReset

bool ignoreReset = true

Don't reset the state when calling the reset method.

This is the default, because in the original MCU, VPots don't get reset when a Reset All Controllers message is received.

Definition at line 353 of file VPotRing.hpp.

◆ matcher

BankableVPotMatcher< BankSize > matcher
protectedinherited

Definition at line 105 of file MIDIInputElement.hpp.

◆ updatables

DoublyLinkedList< MIDIInputElement< Type > > updatables
staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next [1/2]

MIDIInputElement< Type > * next
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ next [2/2]

BankSettingChangeCallback * next
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous [1/2]

MIDIInputElement< Type > * previous
protectedinherited

Definition at line 325 of file LinkedList.hpp.

◆ previous [2/2]

BankSettingChangeCallback * previous
protectedinherited

Definition at line 325 of file LinkedList.hpp.

◆ dirty

bool dirty = true
protectedinherited

Definition at line 75 of file InterfaceMIDIInputElements.hpp.


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