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
AnalogVUDisplay< VU_t > Class Template Reference

#include <Display/MCU/VUDisplay.hpp>

Detailed Description

template<class VU_t = Interfaces::MCU::IVU>
class MCU::AnalogVUDisplay< VU_t >
Examples
2.VU-Meter-OLED-USB-DAC.ino.

Definition at line 112 of file VUDisplay.hpp.

Inheritance diagram for AnalogVUDisplay< VU_t >:
Collaboration diagram for AnalogVUDisplay< VU_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

 AnalogVUDisplay (DisplayInterface &display, VU_t &vu, PixelLocation loc, uint16_t radius, float theta_min, float theta_diff, uint16_t color)
void draw () override
 Draw this DisplayElement to the display buffer.
void drawNeedle (float angle)
bool getDirty () const override
 Check if this DisplayElement has to be re-drawn.
DisplayInterface & getDisplay ()
 Get a reference to the display that this element draws to.
const DisplayInterface & getDisplay () 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

DisplayInterface & display
DisplayElement * next
DisplayElement * previous

Static Protected Attributes

static DoublyLinkedList< DisplayElement > elements

Private Attributes

VU_t & vu
int16_t x
int16_t y
uint16_t r_sq
float theta_min
float theta_diff
uint16_t color

Constructor & Destructor Documentation

◆ AnalogVUDisplay()

template<class VU_t = Interfaces::MCU::IVU>
AnalogVUDisplay ( DisplayInterface & display,
VU_t & vu,
PixelLocation loc,
uint16_t radius,
float theta_min,
float theta_diff,
uint16_t color )
inline

Definition at line 114 of file VUDisplay.hpp.

Member Function Documentation

◆ draw()

template<class VU_t = Interfaces::MCU::IVU>
void draw ( )
inlineoverridevirtual

Draw this DisplayElement to the display buffer.

Implements DisplayElement.

Definition at line 121 of file VUDisplay.hpp.

◆ drawNeedle()

template<class VU_t = Interfaces::MCU::IVU>
void drawNeedle ( float angle)
inline

Definition at line 127 of file VUDisplay.hpp.

◆ getDirty()

template<class VU_t = Interfaces::MCU::IVU>
bool getDirty ( ) const
inlineoverridevirtual

Check if this DisplayElement has to be re-drawn.

Implements DisplayElement.

Definition at line 136 of file VUDisplay.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]

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]

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>
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]

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]

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

DoublyLinkedList< DisplayElement > & getAll ( )
inlinestaticinherited

Get the list of all DisplayElement instances.

Definition at line 100 of file DisplayElement.hpp.

Member Data Documentation

◆ vu

template<class VU_t = Interfaces::MCU::IVU>
VU_t& vu
private

Definition at line 139 of file VUDisplay.hpp.

◆ x

template<class VU_t = Interfaces::MCU::IVU>
int16_t x
private

Definition at line 141 of file VUDisplay.hpp.

◆ y

template<class VU_t = Interfaces::MCU::IVU>
int16_t y
private

Definition at line 142 of file VUDisplay.hpp.

◆ r_sq

template<class VU_t = Interfaces::MCU::IVU>
uint16_t r_sq
private

Definition at line 143 of file VUDisplay.hpp.

◆ theta_min

template<class VU_t = Interfaces::MCU::IVU>
float theta_min
private

Definition at line 144 of file VUDisplay.hpp.

◆ theta_diff

template<class VU_t = Interfaces::MCU::IVU>
float theta_diff
private

Definition at line 145 of file VUDisplay.hpp.

◆ color

template<class VU_t = Interfaces::MCU::IVU>
uint16_t color
private

Definition at line 146 of file VUDisplay.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:
Generated by doxygen 1.17.0