This is an old version of the documentation. View the latest version here.
Control Surface  1.0.0
MIDI Control Surface library for Arduino
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
MIDIButtonMatrix< Sender, nb_rows, nb_cols > Class Template Reference

MIDIButtonMatrix. More...

#include <MIDIButtonMatrix.hpp>

Inheritance diagram for MIDIButtonMatrix< Sender, nb_rows, nb_cols >:
Collaboration diagram for MIDIButtonMatrix< Sender, nb_rows, nb_cols >:

Public Member Functions

void begin () final override
 Initialize this updatable. More...
 
void update () final override
 Update this updatable. More...
 
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 ()
 Check if this updatable is enabled. More...
 
void refresh ()
 Scan the matrix, read all button states, and call the onButtonChanged callback. More...
 

Static Public Member Functions

static void enable (Updatable *element)
 
static void enable (Updatable &element)
 
static void enable (U(&array)[N])
 
static void disable (Updatable< NormalUpdatable > *element)
 
static void disable (Updatable< NormalUpdatable > &element)
 
static void disable (U(&array)[N])
 
static void beginAll ()
 Begin all enabled instances of this class. More...
 
static void updateAll ()
 Update all enabled instances of this class. More...
 

Public Attributes

Sender sender
 

Protected Member Functions

 MIDIButtonMatrix (const PinList< nb_rows > &rowPins, const PinList< nb_cols > &colPins, const AddressMatrix< nb_rows, nb_cols > &addresses, MIDICNChannel channelCN, const Sender &sender)
 

Protected Attributes

Updatable< NormalUpdatable > * next
 
Updatable< NormalUpdatable > * previous
 

Private Member Functions

void onButtonChanged (uint8_t row, uint8_t col, bool state) final override
 The callback function that is called whenever a button changes state. More...
 
bool getPrevState (uint8_t col, uint8_t row)
 
void setPrevState (uint8_t col, uint8_t row, bool state)
 

Static Private Member Functions

static uint8_t positionToBits (uint8_t col, uint8_t row)
 
static uint8_t bitsToIndex (uint8_t bits)
 
static uint8_t bitsToBitmask (uint8_t bits)
 

Private Attributes

AddressMatrix< nb_rows, nb_cols > addresses
 
const MIDICNChannel baseChannelCN
 
unsigned long prevRefresh = 0
 
uint8_t prevStates [(nb_cols *nb_rows+7)/8]
 
const PinList< nb_rows > rowPins
 
const PinList< nb_cols > colPins
 

Static Private Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Detailed Description

template<class Sender, uint8_t nb_rows, uint8_t nb_cols>
class MIDIButtonMatrix< Sender, nb_rows, nb_cols >

MIDIButtonMatrix.

Todo:
Documentation.
See also
ButtonMatrix

Definition at line 15 of file Abstract/MIDIButtonMatrix.hpp.

Constructor & Destructor Documentation

◆ MIDIButtonMatrix()

template<class Sender, uint8_t nb_rows, uint8_t nb_cols>
MIDIButtonMatrix< Sender, nb_rows, nb_cols >::MIDIButtonMatrix ( const PinList< nb_rows > &  rowPins,
const PinList< nb_cols > &  colPins,
const AddressMatrix< nb_rows, nb_cols > &  addresses,
MIDICNChannel  channelCN,
const Sender &  sender 
)
inlineprotected
Todo:
Documentation

Definition at line 23 of file Abstract/MIDIButtonMatrix.hpp.

Member Function Documentation

◆ begin()

template<class Sender, uint8_t nb_rows, uint8_t nb_cols>
void MIDIButtonMatrix< Sender, nb_rows, nb_cols >::begin ( )
inlinefinaloverridevirtual

Initialize this updatable.

Implements Updatable<>.

Definition at line 31 of file Abstract/MIDIButtonMatrix.hpp.

◆ update()

template<class Sender, uint8_t nb_rows, uint8_t nb_cols>
void MIDIButtonMatrix< Sender, nb_rows, nb_cols >::update ( )
inlinefinaloverridevirtual

Update this updatable.

Implements Updatable<>.

Definition at line 33 of file Abstract/MIDIButtonMatrix.hpp.

◆ onButtonChanged()

template<class Sender, uint8_t nb_rows, uint8_t nb_cols>
void MIDIButtonMatrix< Sender, nb_rows, nb_cols >::onButtonChanged ( uint8_t  row,
uint8_t  col,
bool  state 
)
inlinefinaloverrideprivatevirtual

The callback function that is called whenever a button changes state.

Parameters
rowThe row of the button that changed state.
colThe column of the button that changed state.
stateThe new state of the button.

Implements ButtonMatrix< nb_rows, nb_cols >.

Definition at line 36 of file Abstract/MIDIButtonMatrix.hpp.

◆ enable() [1/4]

void Updatable< NormalUpdatable >::enable ( )
inlineinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 40 of file Updatable.hpp.

◆ enable() [2/4]

static void Updatable< NormalUpdatable >::enable ( Updatable<> *  element)
inlinestaticinherited

Definition at line 80 of file Updatable.hpp.

◆ enable() [3/4]

static void Updatable< NormalUpdatable >::enable ( Updatable<> &  element)
inlinestaticinherited

Definition at line 82 of file Updatable.hpp.

◆ enable() [4/4]

static void Updatable< NormalUpdatable >::enable ( U(&)  array[N])
inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ disable() [1/4]

void Updatable< NormalUpdatable >::disable ( )
inlineinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 50 of file Updatable.hpp.

◆ disable() [2/4]

static void Updatable< NormalUpdatable >::disable ( Updatable< NormalUpdatable<> > *  element)
inlinestaticinherited

Definition at line 90 of file Updatable.hpp.

◆ disable() [3/4]

static void Updatable< NormalUpdatable >::disable ( Updatable< NormalUpdatable<> > &  element)
inlinestaticinherited

Definition at line 92 of file Updatable.hpp.

◆ disable() [4/4]

static void Updatable< NormalUpdatable >::disable ( U(&)  array[N])
inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

◆ isEnabled()

bool Updatable< NormalUpdatable >::isEnabled ( )
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 64 of file Updatable.hpp.

◆ beginAll()

static void Updatable< NormalUpdatable >::beginAll ( )
inlinestaticinherited

Begin all enabled instances of this class.

See also
begin()

Definition at line 68 of file Updatable.hpp.

◆ updateAll()

static void Updatable< NormalUpdatable >::updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

Definition at line 75 of file Updatable.hpp.

◆ refresh()

template<uint8_t nb_rows, uint8_t nb_cols>
void ButtonMatrix< nb_rows, nb_cols >::refresh ( )
inherited

Scan the matrix, read all button states, and call the onButtonChanged callback.

Definition at line 17 of file ButtonMatrix.ipp.

◆ positionToBits()

template<uint8_t nb_rows, uint8_t nb_cols>
uint8_t ButtonMatrix< nb_rows, nb_cols >::positionToBits ( uint8_t  col,
uint8_t  row 
)
inlinestaticprivateinherited

Definition at line 52 of file ButtonMatrix.ipp.

◆ bitsToIndex()

template<uint8_t nb_rows, uint8_t nb_cols>
uint8_t ButtonMatrix< nb_rows, nb_cols >::bitsToIndex ( uint8_t  bits)
inlinestaticprivateinherited

Definition at line 59 of file ButtonMatrix.ipp.

◆ bitsToBitmask()

template<uint8_t nb_rows, uint8_t nb_cols>
uint8_t ButtonMatrix< nb_rows, nb_cols >::bitsToBitmask ( uint8_t  bits)
inlinestaticprivateinherited

Definition at line 64 of file ButtonMatrix.ipp.

◆ getPrevState()

template<uint8_t nb_rows, uint8_t nb_cols>
bool ButtonMatrix< nb_rows, nb_cols >::getPrevState ( uint8_t  col,
uint8_t  row 
)
privateinherited

Definition at line 69 of file ButtonMatrix.ipp.

◆ setPrevState()

template<uint8_t nb_rows, uint8_t nb_cols>
void ButtonMatrix< nb_rows, nb_cols >::setPrevState ( uint8_t  col,
uint8_t  row,
bool  state 
)
privateinherited

Definition at line 75 of file ButtonMatrix.ipp.

Member Data Documentation

◆ addresses

template<class Sender, uint8_t nb_rows, uint8_t nb_cols>
AddressMatrix<nb_rows, nb_cols> MIDIButtonMatrix< Sender, nb_rows, nb_cols >::addresses
private

Definition at line 44 of file Abstract/MIDIButtonMatrix.hpp.

◆ baseChannelCN

template<class Sender, uint8_t nb_rows, uint8_t nb_cols>
const MIDICNChannel MIDIButtonMatrix< Sender, nb_rows, nb_cols >::baseChannelCN
private

Definition at line 45 of file Abstract/MIDIButtonMatrix.hpp.

◆ sender

template<class Sender, uint8_t nb_rows, uint8_t nb_cols>
Sender MIDIButtonMatrix< Sender, nb_rows, nb_cols >::sender

Definition at line 48 of file Abstract/MIDIButtonMatrix.hpp.

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > Updatable< NormalUpdatable >::updatables
staticprivateinherited

Definition at line 101 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * DoublyLinkable< Updatable< NormalUpdatable > >::next
protectedinherited

Definition at line 301 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * DoublyLinkable< Updatable< NormalUpdatable > >::previous
protectedinherited

Definition at line 302 of file LinkedList.hpp.

◆ prevRefresh

template<uint8_t nb_rows, uint8_t nb_cols>
unsigned long ButtonMatrix< nb_rows, nb_cols >::prevRefresh = 0
privateinherited

Definition at line 73 of file ButtonMatrix.hpp.

◆ prevStates

template<uint8_t nb_rows, uint8_t nb_cols>
uint8_t ButtonMatrix< nb_rows, nb_cols >::prevStates[(nb_cols *nb_rows+7)/8]
privateinherited

Definition at line 74 of file ButtonMatrix.hpp.

◆ rowPins

template<uint8_t nb_rows, uint8_t nb_cols>
const PinList<nb_rows> ButtonMatrix< nb_rows, nb_cols >::rowPins
privateinherited

Definition at line 76 of file ButtonMatrix.hpp.

◆ colPins

template<uint8_t nb_rows, uint8_t nb_cols>
const PinList<nb_cols> ButtonMatrix< nb_rows, nb_cols >::colPins
privateinherited

Definition at line 77 of file ButtonMatrix.hpp.


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