Control Surface main
MIDI Control Surface library for Arduino
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
BitmapDisplay< Value_t > Class Template Reference

#include <Display/BitmapDisplay.hpp>

Detailed Description

template<class Value_t = Interfaces::IValue &>
class BitmapDisplay< Value_t >

A class that displays a bitmap depending on the state of a MIDINote or any other object that has a getValue() method that returns true (or anything that evaluates to true) when the bitmap has to be displayed, as wel as a pair of getDirty()/clearDirty() methods to determine whether the display has to be updated.

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

Definition at line 17 of file BitmapDisplay.hpp.

+ Inheritance diagram for BitmapDisplay< Value_t >:
+ Collaboration diagram for BitmapDisplay< Value_t >:

Enabling and disabling display elements

void enable ()
 Enable this display element: insert it into the linked list of instances, so it gets drawn to the display.
 
void disable ()
 Disable this display element: remove it from the linked list of instances, so it no longer gets drawn to the display.
 
bool isEnabled () const
 Check if this display element is enabled.
 
static void enable (DisplayElement *element)
 Enable this display element: insert it into the linked list of instances, so it gets drawn to the display.
 
static void enable (DisplayElement &element)
 Enable this display element: insert it into the linked list of instances, so it gets drawn to the display.
 
template<class U , size_t N>
static void enable (U(&array)[N])
 Enable this display element: insert it into the linked list of instances, so it gets drawn to the display.
 
static void disable (DisplayElement *element)
 Disable this display element: remove it from the linked list of instances, so it no longer gets drawn to the display.
 
static void disable (DisplayElement &element)
 Disable this display element: remove it from the linked list of instances, so it no longer gets drawn to the display.
 
template<class U , size_t N>
static void disable (U(&array)[N])
 Disable this display element: remove it from the linked list of instances, so it no longer gets drawn to the display.
 

Public Member Functions

 BitmapDisplay (DisplayInterface &display, Value_t &&value, const XBitmap &xbm, PixelLocation loc, uint16_t color)
 
void draw () override
 Draw this DisplayElement to the display buffer.
 
bool getDirty () const override
 Check if this DisplayElement has to be re-drawn.
 
DisplayInterfacegetDisplay ()
 Get a reference to the display that this element draws to.
 
const DisplayInterfacegetDisplay () const
 Get a const reference to the display that this element draws to.
 

Static Public Member Functions

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

Protected Attributes

DisplayInterfacedisplay
 
DisplayElementnext
 
DisplayElementprevious
 

Static Protected Attributes

static DoublyLinkedList< DisplayElementelements
 

Private Attributes

Value_t value
 
const XBitmapxbm
 
int16_t x
 
int16_t y
 
uint16_t color
 

Constructor & Destructor Documentation

◆ BitmapDisplay()

template<class Value_t = Interfaces::IValue &>
BitmapDisplay ( DisplayInterface & display,
Value_t && value,
const XBitmap & xbm,
PixelLocation loc,
uint16_t color )
inline

Definition at line 19 of file BitmapDisplay.hpp.

Member Function Documentation

◆ draw()

template<class Value_t = Interfaces::IValue &>
void draw ( )
inlineoverridevirtual

Draw this DisplayElement to the display buffer.

Implements DisplayElement.

Definition at line 24 of file BitmapDisplay.hpp.

◆ getDirty()

template<class Value_t = Interfaces::IValue &>
bool getDirty ( ) const
inlineoverridevirtual

Check if this DisplayElement has to be re-drawn.

Implements DisplayElement.

Definition at line 30 of file BitmapDisplay.hpp.

◆ enable() [1/4]

void enable ( )
inlineprotectedinherited

Enable this display element: insert it into the linked list of instances, so it gets drawn to the display.

Definition at line 35 of file DisplayElement.hpp.

◆ enable() [2/4]

static void enable ( DisplayElement * element)
inlinestaticprotectedinherited

Enable this display element: insert it into the linked list of instances, so it gets drawn to the display.

Definition at line 62 of file DisplayElement.hpp.

◆ enable() [3/4]

static void enable ( DisplayElement & element)
inlinestaticprotectedinherited

Enable this display element: insert it into the linked list of instances, so it gets drawn to the display.

Definition at line 64 of file DisplayElement.hpp.

◆ enable() [4/4]

template<class U , size_t N>
static void enable ( U(&) array[N])
inlinestaticprotectedinherited

Enable this display element: insert it into the linked list of instances, so it gets drawn to the display.

Definition at line 67 of file DisplayElement.hpp.

◆ disable() [1/4]

void disable ( )
inlineprotectedinherited

Disable this display element: remove it from the linked list of instances, so it no longer gets drawn to the display.

Definition at line 45 of file DisplayElement.hpp.

◆ disable() [2/4]

static void disable ( DisplayElement * element)
inlinestaticprotectedinherited

Disable this display element: remove it from the linked list of instances, so it no longer gets drawn to the display.

Definition at line 73 of file DisplayElement.hpp.

◆ disable() [3/4]

static void disable ( DisplayElement & element)
inlinestaticprotectedinherited

Disable this display element: remove it from the linked list of instances, so it no longer gets drawn to the display.

Definition at line 75 of file DisplayElement.hpp.

◆ disable() [4/4]

template<class U , size_t N>
static void disable ( U(&) array[N])
inlinestaticprotectedinherited

Disable this display element: remove it from the linked list of instances, so it no longer gets drawn to the display.

Definition at line 78 of file DisplayElement.hpp.

◆ isEnabled()

bool isEnabled ( ) const
inlineprotectedinherited

Check if this display element is enabled.

Note
Assumes that the element is not added to a different linked list by the user.

Definition at line 59 of file DisplayElement.hpp.

◆ getDisplay() [1/2]

DisplayInterface & getDisplay ( )
inlineinherited

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

Definition at line 95 of file DisplayElement.hpp.

◆ getDisplay() [2/2]

const DisplayInterface & getDisplay ( ) const
inlineinherited

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

Definition at line 97 of file DisplayElement.hpp.

◆ getAll()

static DoublyLinkedList< DisplayElement > & getAll ( )
inlinestaticinherited

Get the list of all DisplayElement instances.

Definition at line 100 of file DisplayElement.hpp.

Member Data Documentation

◆ value

template<class Value_t = Interfaces::IValue &>
Value_t value
private

Definition at line 33 of file BitmapDisplay.hpp.

◆ xbm

template<class Value_t = Interfaces::IValue &>
const XBitmap& xbm
private

Definition at line 34 of file BitmapDisplay.hpp.

◆ x

template<class Value_t = Interfaces::IValue &>
int16_t x
private

Definition at line 35 of file BitmapDisplay.hpp.

◆ y

template<class Value_t = Interfaces::IValue &>
int16_t y
private

Definition at line 35 of file BitmapDisplay.hpp.

◆ color

template<class Value_t = Interfaces::IValue &>
uint16_t color
private

Definition at line 36 of file BitmapDisplay.hpp.

◆ display

DisplayInterface& display
protectedinherited

Definition at line 103 of file DisplayElement.hpp.

◆ elements

DoublyLinkedList< DisplayElement > elements
staticprotectedinherited

Definition at line 105 of file DisplayElement.hpp.

◆ next

DisplayElement * next
protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous

DisplayElement * previous
protectedinherited

Definition at line 321 of file LinkedList.hpp.


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