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 | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
NoteBitmapDisplay Class Reference

A class that displays a bitmap depending on the state of a MIDINote. More...

#include <NoteBitmapDisplay.hpp>

Inheritance diagram for NoteBitmapDisplay:
Collaboration diagram for NoteBitmapDisplay:

Public Member Functions

 NoteBitmapDisplay (DisplayInterface &display, INoteCCValue &note, const XBitmap &xbm, PixelLocation loc, uint16_t color)
 
void draw () override
 Draw this DisplayElement to the display buffer. More...
 
DisplayInterfacegetDisplay ()
 Get a reference to the display that this element draws to. More...
 
const DisplayInterfacegetDisplay () const
 Get a const reference to the display that this element draws to. More...
 

Static Public Member Functions

static DoublyLinkedList< DisplayElement > & getAll ()
 Get the list of all DisplayElement instances. More...
 

Protected Attributes

DisplayInterfacedisplay
 
DisplayElementnext
 
DisplayElementprevious
 

Static Protected Attributes

static DoublyLinkedList< DisplayElementelements
 

Private Attributes

INoteCCValuenote
 
const XBitmapxbm
 
int16_t x
 
int16_t y
 
uint16_t color
 

Detailed Description

A class that displays a bitmap depending on the state of a MIDINote.

Examples
MCU-OLED-SSD1306-x2.ino, MCU-OLED-SSD1306.ino, and VU-Meter-Bridge.ino.

Definition at line 10 of file NoteBitmapDisplay.hpp.

Constructor & Destructor Documentation

◆ NoteBitmapDisplay()

NoteBitmapDisplay::NoteBitmapDisplay ( DisplayInterface display,
INoteCCValue note,
const XBitmap xbm,
PixelLocation  loc,
uint16_t  color 
)
inline

Definition at line 12 of file NoteBitmapDisplay.hpp.

Member Function Documentation

◆ draw()

void NoteBitmapDisplay::draw ( )
inlineoverridevirtual

Draw this DisplayElement to the display buffer.

Implements DisplayElement.

Definition at line 17 of file NoteBitmapDisplay.hpp.

◆ getDisplay() [1/2]

DisplayInterface& DisplayElement::getDisplay ( )
inlineinherited

Get a reference to the display that this element draws to.

Definition at line 36 of file DisplayElement.hpp.

◆ getDisplay() [2/2]

const DisplayInterface& DisplayElement::getDisplay ( ) const
inlineinherited

Get a const reference to the display that this element draws to.

Definition at line 38 of file DisplayElement.hpp.

◆ getAll()

static DoublyLinkedList<DisplayElement>& DisplayElement::getAll ( )
inlinestaticinherited

Get the list of all DisplayElement instances.

Definition at line 41 of file DisplayElement.hpp.

Member Data Documentation

◆ note

INoteCCValue& NoteBitmapDisplay::note
private

Definition at line 23 of file NoteBitmapDisplay.hpp.

◆ xbm

const XBitmap& NoteBitmapDisplay::xbm
private

Definition at line 24 of file NoteBitmapDisplay.hpp.

◆ x

int16_t NoteBitmapDisplay::x
private

Definition at line 25 of file NoteBitmapDisplay.hpp.

◆ y

int16_t NoteBitmapDisplay::y
private

Definition at line 25 of file NoteBitmapDisplay.hpp.

◆ color

uint16_t NoteBitmapDisplay::color
private

Definition at line 26 of file NoteBitmapDisplay.hpp.

◆ display

DisplayInterface& DisplayElement::display
protectedinherited

Definition at line 44 of file DisplayElement.hpp.

◆ elements

DoublyLinkedList< DisplayElement > DisplayElement::elements
staticprotectedinherited

Definition at line 46 of file DisplayElement.hpp.

◆ next

DisplayElement * DoublyLinkable< DisplayElement >::next
protectedinherited

Definition at line 301 of file LinkedList.hpp.

◆ previous

DisplayElement * DoublyLinkable< DisplayElement >::previous
protectedinherited

Definition at line 302 of file LinkedList.hpp.


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