Control Surface main
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 Class Referenceabstract

#include <MIDI_Inputs/MCU/VPotRing.hpp>

Detailed Description

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

Definition at line 154 of file VPotRing.hpp.

+ Inheritance diagram for VPotRing:
+ Collaboration diagram for VPotRing:

Data access

VPotState getState () const
 Get the full state of the VPot ring. 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 = VPotMatcher
 
using Parent = MatchingMIDIInputElement< MIDIMessageType::CONTROL_CHANGE, Matcher >
 
using MessageType = typename MIDIInputElement< Type >::MessageType
 

Public Member Functions

 VPotRing (uint8_t track, MIDIChannelCable channelCN=CHANNEL_1)
 Constructor. More...
 
void reset () override
 Reset the state 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
 

Protected Attributes

VPotMatcher matcher
 
MIDIInputElement< Type > * next
 
MIDIInputElement< Type > * previous
 
bool dirty = true
 

Static Protected Attributes

static DoublyLinkedList< MIDIInputElement< Type > > updatables
 

Private Attributes

VPotState state = {}
 

Member Typedef Documentation

◆ Matcher

Definition at line 159 of file VPotRing.hpp.

◆ Parent

Definition at line 160 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 ( uint8_t  track,
MIDIChannelCable  channelCN = CHANNEL_1 
)
inline

Constructor.

Parameters
trackThe track of the VPot [1, 8].
channelCNThe MIDI channel [CHANNEL_1, CHANNEL_16] and Cable Number [CABLE_1, CABLE_16].

Definition at line 172 of file VPotRing.hpp.

Member Function Documentation

◆ handleUpdateImpl()

bool handleUpdateImpl ( typename Matcher::Result  match)
inlineprotected

Definition at line 176 of file VPotRing.hpp.

◆ handleUpdate() [1/2]

void handleUpdate ( typename Matcher::Result  match)
inlineoverrideprotected

Definition at line 180 of file VPotRing.hpp.

◆ getState()

VPotState getState ( ) const
inline

Get the full state of the VPot ring.

Definition at line 189 of file VPotRing.hpp.

◆ getPosition()

uint8_t getPosition ( ) const
inline

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

Definition at line 192 of file VPotRing.hpp.

◆ getCenterLed()

bool getCenterLed ( ) const
inlineoverridevirtual

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

Implements IVPot.

Definition at line 194 of file VPotRing.hpp.

◆ getMode()

VPotState::Mode getMode ( ) const
inline

Return the mode of the V-Pot ring.

Definition at line 196 of file VPotRing.hpp.

◆ getStartOn()

uint8_t getStartOn ( ) const
inlineoverridevirtual

Get the first segment that should be on.

Implements IVPot.

Definition at line 199 of file VPotRing.hpp.

◆ getStartOff()

uint8_t getStartOff ( ) const
inlineoverridevirtual

Get the first segment that should be off.

Implements IVPot.

Definition at line 201 of file VPotRing.hpp.

◆ reset()

void reset ( )
inlineoverridevirtual

Reset the state to zero.

Reimplemented from MIDIInputElement< Type >.

Definition at line 206 of file VPotRing.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

◆ 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

◆ state

VPotState state = {}
private

Definition at line 214 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 220 of file VPotRing.hpp.

◆ matcher

VPotMatcher 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

MIDIInputElement< Type > * next
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

MIDIInputElement< Type > * 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: