LinesEffect

Source: LinesEffect.h

LinesEffect

class LinesEffect

src/light/effects/LinesEffect.h:13

Inherits: EffectBase

Test effect: axis-aligned planes sweeping in sync, where red, green and blue name x, y and z.

Three planes sweep together, each color naming the axis it moves along. That makes it the effect for verifying a preview's axis orientation. A second mode drops the sweep for a static panel-mapping aid instead.

Public Attributes

uint8_t speed = 30 : How fast the planes sweep.

uint8_t axis = 0 : Which axis sweeps, or all three together.

uint8_t mode = 0 : Sweep the planes, or show the static panel dots.

uint8_t panelW = 16 : A panel block's width in lights, for the dots mapping.

uint8_t panelH = 16 : Its height, kept separate since a non-square panel would otherwise skip whole rows.

Public Methods

virtual inline const char * tags() const override : Catalog tags for the visual catalog.

virtual inline Dim dimensions() const override : All three planes need all three axes.

virtual inline void defineControls() override : Publish the sweep, the axis and the panel geometry, hiding whichever mode is inactive.

virtual inline void tick() override : Sweep the three planes, or draw the panel dots when that mode is chosen.