The BLOCKS SDK
LEDRow Class Referenceabstract

Description

Represents an LED strip on a device.

Public Member Functions

 LEDRow (Block &)
 
virtual ~LEDRow ()
 Destructor. More...
 
virtual int getNumLEDs () const =0
 Return the number of LEDs in the row. More...
 
virtual void setLEDColour (int index, LEDColour newColour)=0
 Sets the colour of the corresponding LED. More...
 
virtual void setOverlayColour (LEDColour newColour)=0
 Overlays all LEDs with a single colour. More...
 
virtual void resetOverlayColour ()=0
 

Public Attributes

Blockblock
 The device that these lights belong to. More...
 

Constructor & Destructor Documentation

◆ LEDRow()

LEDRow::LEDRow ( Block )

◆ ~LEDRow()

virtual LEDRow::~LEDRow ( )
virtual

Destructor.

Member Function Documentation

◆ getNumLEDs()

virtual int LEDRow::getNumLEDs ( ) const
pure virtual

Return the number of LEDs in the row.

◆ setLEDColour()

virtual void LEDRow::setLEDColour ( int  index,
LEDColour  newColour 
)
pure virtual

Sets the colour of the corresponding LED.

◆ setOverlayColour()

virtual void LEDRow::setOverlayColour ( LEDColour  newColour)
pure virtual

Overlays all LEDs with a single colour.

Whilst the overlay is set subsequent calls to setLEDColour will happen behind* the overlay, and will be invisible to the user until the overlay is removed.

◆ resetOverlayColour()

virtual void LEDRow::resetOverlayColour ( )
pure virtual

Member Data Documentation

◆ block

Block& LEDRow::block

The device that these lights belong to.


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