#include <MIDI_Inputs/LEDs/NoteCCKPRangeFastLED.hpp>

Detailed Description

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper>
class NoteCCKPRangeFastLED< Type, RangeLen, ColorMapper >

Generic base class for classes that listen for MIDI Note, Control Change and Key Pressure events on a range of addresses and turns on the corresponding LED in a FastLED strip with a color that depends both on the index in the range and the value of the incoming MIDI message.

Template Parameters

Type	The type of MIDI messages to listen for: MIDIMessageType::NoteOn MIDIMessageType::ControlChange MIDIMessageType::KeyPressure
RangeLen	The length of the range of addresses to listen to.
ColorMapper	A callable that maps a 7-bit MIDI value and the index in the range to a FastLED CRGB color, see DefaultColorMapper for an example.

Examples: 10.Note-FastLED-ColorMapper.ino, and 9.Note-FastLED.ino.

Definition at line 61 of file NoteCCKPRangeFastLED.hpp.

Inheritance diagram for NoteCCKPRangeFastLED< Type, RangeLen, ColorMapper >:

Collaboration diagram for NoteCCKPRangeFastLED< Type, RangeLen, ColorMapper >:

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

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

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

void	moveDown ()
	Move down this element in the list.

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

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

static void	enable (U(&array)[N])
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

static void	disable (UpdatableCRTP *element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

static void	disable (UpdatableCRTP &element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

static void	disable (U(&array)[N])
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Public Types
using	Matcher = TwoByteRangeMIDIMatcher

using	MessageType

Public Member Functions
	NoteCCKPRangeFastLED (CRGB *ledcolors, MIDIAddress address, const ColorMapper &colormapper)

	NoteCCKPRangeFastLED (AH::Array< CRGB, RangeLen > &ledcolors, MIDIAddress address, const ColorMapper &colormapper)

	NoteCCKPRangeFastLED (CRGB *ledcolors, MIDIAddress address, const ColorMapper &colormapper, index_permuter_f index_permuter)

	NoteCCKPRangeFastLED (AH::Array< CRGB, RangeLen > &ledcolors, MIDIAddress address, const ColorMapper &colormapper, index_permuter_f index_permuter)

template<class ColorMapper_ = ColorMapper>
	NoteCCKPRangeFastLED (CRGB ledcolors, MIDIAddress address, typename std::enable_if< std::is_default_constructible< ColorMapper_ >::value >::type =nullptr)

template<class ColorMapper_ = ColorMapper>
	NoteCCKPRangeFastLED (AH::Array< CRGB, RangeLen > &ledcolors, MIDIAddress address, typename std::enable_if< std::is_default_constructible< ColorMapper_ >::value >::type *=nullptr)

void	setBrightness (uint8_t brightness)
	Set the maximum brightness of the LEDs.

uint8_t	getBrightness () const
	Get the maximum brightness of the LEDs.

void	setLEDIndexPermuter (index_permuter_f permuter)
	Change the mapping from the MIDI index to the LED index.

void	begin () override
	Initialize the input element.

void	handleUpdate (typename Matcher::Result match) override

void	reset () override
	Reset the input element to its initial state.

void	updateLED (uint8_t index, uint8_t value)

void	resetLEDs ()

bool	getDirty () const
	Check if the colors changed since the last time the dirty flag was cleared.

void	clearDirty ()
	Clear the dirty flag.

bool	updateWith (MessageType midimsg) override
	Receive a new MIDI message and update the internal state.

virtual void	handleUpdate (typename Matcher::Result match)=0

virtual void	update ()
	Update the value of the input element. Used for decaying VU meters etc.

Static Public Member Functions
static bool	updateAllWith (MessageType midimsg)
	Update all.

static void	updateAll ()
	Update all.

static void	beginAll ()
	Begin all.

static void	resetAll ()
	Reset all.

Public Attributes
ColorMapper	colormapper

Protected Attributes
TwoByteRangeMIDIMatcher	matcher

Node *	next = nullptr

Node *	previous = nullptr

Static Protected Attributes
static DoublyLinkedList< MIDIInputElement< Type > >	updatables

Static Private Member Functions
static uint8_t	identityPermuter (uint8_t i)

Private Attributes
CRGB *	ledcolors

bool	dirty = true

uint8_t	brightness = 255

index_permuter_f	ledIndexPermuter = identityPermuter

Member Typedef Documentation

◆ Matcher

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

using Matcher = TwoByteRangeMIDIMatcher

Definition at line 64 of file NoteCCKPRangeFastLED.hpp.

◆ MessageType

using MessageType

inherited

Definition at line 93 of file MIDIInputElement.hpp.

Constructor & Destructor Documentation

◆ NoteCCKPRangeFastLED() [1/6]

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

NoteCCKPRangeFastLED	(	CRGB *	ledcolors,
		MIDIAddress	address,
		const ColorMapper &	colormapper )

inline

Definition at line 66 of file NoteCCKPRangeFastLED.hpp.

◆ NoteCCKPRangeFastLED() [2/6]

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

NoteCCKPRangeFastLED	(	AH::Array< CRGB, RangeLen > &	ledcolors,
		MIDIAddress	address,
		const ColorMapper &	colormapper )

inline

Definition at line 72 of file NoteCCKPRangeFastLED.hpp.

◆ NoteCCKPRangeFastLED() [3/6]

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

NoteCCKPRangeFastLED	(	CRGB *	ledcolors,
		MIDIAddress	address,
		const ColorMapper &	colormapper,
		index_permuter_f	index_permuter )

inline

Definition at line 76 of file NoteCCKPRangeFastLED.hpp.

◆ NoteCCKPRangeFastLED() [4/6]

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

NoteCCKPRangeFastLED	(	AH::Array< CRGB, RangeLen > &	ledcolors,
		MIDIAddress	address,
		const ColorMapper &	colormapper,
		index_permuter_f	index_permuter )

inline

Definition at line 84 of file NoteCCKPRangeFastLED.hpp.

◆ NoteCCKPRangeFastLED() [5/6]

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

template<class ColorMapper_ = ColorMapper>

NoteCCKPRangeFastLED	(	CRGB *	ledcolors,
		MIDIAddress	address,
		typename std::enable_if< std::is_default_constructible< ColorMapper_ >::value >::type *	= nullptr )

inline

Definition at line 91 of file NoteCCKPRangeFastLED.hpp.

◆ NoteCCKPRangeFastLED() [6/6]

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

template<class ColorMapper_ = ColorMapper>

NoteCCKPRangeFastLED	(	AH::Array< CRGB, RangeLen > &	ledcolors,
		MIDIAddress	address,
		typename std::enable_if< std::is_default_constructible< ColorMapper_ >::value >::type *	= nullptr )

inline

Definition at line 99 of file NoteCCKPRangeFastLED.hpp.

Member Function Documentation

◆ setBrightness()

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

void setBrightness ( uint8_t brightness )

inline

Set the maximum brightness of the LEDs.

Parameters

brightness The maximum brightness [0, 255]

Definition at line 110 of file NoteCCKPRangeFastLED.hpp.

◆ getBrightness()

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

uint8_t getBrightness ( ) const

inline

Get the maximum brightness of the LEDs.

Definition at line 112 of file NoteCCKPRangeFastLED.hpp.

◆ setLEDIndexPermuter()

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

void setLEDIndexPermuter ( index_permuter_f permuter )

inline

Change the mapping from the MIDI index to the LED index.

The MIDI index is derived from the note or controller number.

The function should take the (zero-based) MIDI index value as a parameter, and return the corresponding LED index (zero-based). By default, the LED index is the same as the MIDI index.

Definition at line 123 of file NoteCCKPRangeFastLED.hpp.

◆ begin()

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

void begin ( )

inlineoverridevirtual

Initialize the input element.

Reimplemented from MIDIInputElement< Type >.

Definition at line 127 of file NoteCCKPRangeFastLED.hpp.

◆ handleUpdate() [1/2]

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

void handleUpdate ( typename Matcher::Result match )

inlineoverride

Definition at line 129 of file NoteCCKPRangeFastLED.hpp.

◆ reset()

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

void reset ( )

inlineoverridevirtual

Reset the input element to its initial state.

Reimplemented from MIDIInputElement< Type >.

Definition at line 133 of file NoteCCKPRangeFastLED.hpp.

◆ updateLED()

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

void updateLED	(	uint8_t	index,
		uint8_t	value )

inline

Definition at line 135 of file NoteCCKPRangeFastLED.hpp.

◆ resetLEDs()

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

void resetLEDs ( )

inline

Definition at line 148 of file NoteCCKPRangeFastLED.hpp.

◆ getDirty()

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

bool getDirty ( ) const

inline

Check if the colors changed since the last time the dirty flag was cleared.

When it's dirty, you should probably call FastLED.show() in the main loop.

Definition at line 156 of file NoteCCKPRangeFastLED.hpp.

◆ clearDirty()

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

void clearDirty ( )

inline

Clear the dirty flag.

Definition at line 158 of file NoteCCKPRangeFastLED.hpp.

◆ identityPermuter()

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

static uint8_t identityPermuter ( uint8_t i )

inlinestaticprivate

Definition at line 166 of file NoteCCKPRangeFastLED.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

◆ update()

template<MIDIMessageType Type>

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()

template<MIDIMessageType Type>

static bool updateAllWith ( MessageType midimsg )

inlinestaticinherited

Update all.

Definition at line 46 of file MIDIInputElement.hpp.

◆ updateAll()

template<MIDIMessageType Type>

static void updateAll ( )

inlinestaticinherited

Update all.

Definition at line 57 of file MIDIInputElement.hpp.

◆ beginAll()

template<MIDIMessageType Type>

static void beginAll ( )

inlinestaticinherited

Begin all.

Definition at line 62 of file MIDIInputElement.hpp.

◆ resetAll()

template<MIDIMessageType Type>

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 96 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 125 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 127 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 130 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 106 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 136 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 138 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 141 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 120 of file Updatable.hpp.

◆ moveDown()

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

Member Data Documentation

◆ ledcolors

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

CRGB* ledcolors

private

Definition at line 161 of file NoteCCKPRangeFastLED.hpp.

◆ dirty

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

bool dirty = true

private

Definition at line 162 of file NoteCCKPRangeFastLED.hpp.

◆ brightness

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

uint8_t brightness = 255

private

Definition at line 163 of file NoteCCKPRangeFastLED.hpp.

◆ ledIndexPermuter

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

index_permuter_f ledIndexPermuter = identityPermuter

private

Definition at line 164 of file NoteCCKPRangeFastLED.hpp.

◆ colormapper

template<MIDIMessageType Type, uint8_t RangeLen, class ColorMapper >

ColorMapper colormapper

Definition at line 169 of file NoteCCKPRangeFastLED.hpp.

◆ matcher

TwoByteRangeMIDIMatcher matcher

protectedinherited

Definition at line 105 of file MIDIInputElement.hpp.

◆ updatables

DoublyLinkedList< MIDIInputElement< Type > > updatables

staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next

template<class Node >

Node* next = nullptr

protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous

template<class Node >

Node* previous = nullptr

protectedinherited

Definition at line 321 of file LinkedList.hpp.

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

NoteCCKPRangeFastLED.hpp

Detailed Description

Enabling and disabling updatables

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Static Private Member Functions

Private Attributes

Member Typedef Documentation

◆ Matcher

◆ MessageType

Constructor & Destructor Documentation

◆ NoteCCKPRangeFastLED() [1/6]

◆ NoteCCKPRangeFastLED() [2/6]

◆ NoteCCKPRangeFastLED() [3/6]

◆ NoteCCKPRangeFastLED() [4/6]

◆ NoteCCKPRangeFastLED() [5/6]

◆ NoteCCKPRangeFastLED() [6/6]

Member Function Documentation

◆ setBrightness()

◆ getBrightness()

◆ setLEDIndexPermuter()

◆ begin()

◆ handleUpdate() [1/2]

◆ reset()

◆ updateLED()

◆ resetLEDs()

◆ getDirty()

◆ clearDirty()

◆ identityPermuter()

◆ updateWith()

◆ handleUpdate() [2/2]

◆ update()

◆ updateAllWith()

◆ updateAll()

◆ beginAll()

◆ resetAll()

◆ 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

◆ ledcolors

◆ dirty

◆ brightness

◆ ledIndexPermuter

◆ colormapper

◆ matcher

◆ updatables

◆ next

◆ previous