#include <Display/MCU/VPotDisplay.hpp>

Detailed Description

template<class VPot_t = Interfaces::MCU::IVPot &>
class MCU::VPotDisplay< VPot_t >

Displays the position of a MCU V-Pot.

Examples: MCU-OLED-SSD1306-x2.ino, and MCU-OLED-SSD1306.ino.

Definition at line 18 of file VPotDisplay.hpp.

Inheritance diagram for VPotDisplay< VPot_t >:

Collaboration diagram for VPotDisplay< VPot_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
	VPotDisplay (DisplayInterface &display, VPot_t &&vpot, PixelLocation loc, uint16_t radius, uint16_t innerRadius, 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.
void	setAngleSpacing (float spacing)
float	getAngleSpacing () const
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 Member Functions
void	drawVPotSegment (uint8_t segment)

Protected Attributes
DisplayInterface &	display
DisplayElement *	next
DisplayElement *	previous

Static Protected Attributes
static DoublyLinkedList< DisplayElement >	elements

Private Attributes
VPot_t	vpot
int16_t	x
int16_t	y
uint16_t	radius
uint16_t	innerRadius
uint16_t	color
float	angleSpacing = 0.4887

Constructor & Destructor Documentation

◆ VPotDisplay()

template<class VPot_t = Interfaces::MCU::IVPot &>

VPotDisplay	(	DisplayInterface &	display,
		VPot_t &&	vpot,
		PixelLocation	loc,
		uint16_t	radius,
		uint16_t	innerRadius,
		uint16_t	color )

inline

Definition at line 21 of file VPotDisplay.hpp.

Member Function Documentation

◆ draw()

template<class VPot_t = Interfaces::MCU::IVPot &>

void draw ( )

inlineoverridevirtual

Draw this DisplayElement to the display buffer.

Implements DisplayElement.

Definition at line 27 of file VPotDisplay.hpp.

◆ getDirty()

template<class VPot_t = Interfaces::MCU::IVPot &>

bool getDirty ( ) const

inlineoverridevirtual

Check if this DisplayElement has to be re-drawn.

Implements DisplayElement.

Definition at line 40 of file VPotDisplay.hpp.

◆ setAngleSpacing()

template<class VPot_t = Interfaces::MCU::IVPot &>

void setAngleSpacing ( float spacing )

inline

Definition at line 42 of file VPotDisplay.hpp.

◆ getAngleSpacing()

template<class VPot_t = Interfaces::MCU::IVPot &>

float getAngleSpacing ( ) const

inline

Definition at line 43 of file VPotDisplay.hpp.

◆ drawVPotSegment()

template<class VPot_t = Interfaces::MCU::IVPot &>

void drawVPotSegment ( uint8_t segment )

inlineprotected

Definition at line 54 of file VPotDisplay.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

◆ vpot

template<class VPot_t = Interfaces::MCU::IVPot &>

VPot_t vpot

private

Definition at line 46 of file VPotDisplay.hpp.

◆ x

template<class VPot_t = Interfaces::MCU::IVPot &>

int16_t x

private

Definition at line 48 of file VPotDisplay.hpp.

◆ y

template<class VPot_t = Interfaces::MCU::IVPot &>

int16_t y

private

Definition at line 48 of file VPotDisplay.hpp.

◆ radius

template<class VPot_t = Interfaces::MCU::IVPot &>

uint16_t radius

private

Definition at line 49 of file VPotDisplay.hpp.

◆ innerRadius

template<class VPot_t = Interfaces::MCU::IVPot &>

uint16_t innerRadius

private

Definition at line 49 of file VPotDisplay.hpp.

◆ color

template<class VPot_t = Interfaces::MCU::IVPot &>

uint16_t color

private

Definition at line 49 of file VPotDisplay.hpp.

◆ angleSpacing

template<class VPot_t = Interfaces::MCU::IVPot &>

float angleSpacing = 0.4887

private

Definition at line 51 of file VPotDisplay.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:

VPotDisplay.hpp

Detailed Description

Enabling and disabling display elements

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Constructor & Destructor Documentation

◆ VPotDisplay()

Member Function Documentation

◆ draw()

◆ getDirty()

◆ setAngleSpacing()

◆ getAngleSpacing()

◆ drawVPotSegment()

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

◆ getDisplay() [1/2]

◆ getDisplay() [2/2]

◆ getAll()

Member Data Documentation

◆ vpot

◆ x

◆ y

◆ radius

◆ innerRadius

◆ color

◆ angleSpacing

◆ display

◆ elements

◆ next

◆ previous