SpiralEffect

Source: SpiralEffect.h

SpiralEffect¶

class SpiralEffect

src/light/effects/SpiralEffect.h:10

Inherits: EffectBase

Effect winding a lit spiral up a conical layout.

SpiralEffect card

Public Attributes¶

uint8_t bpm = 40

uint8_t twist = 4

uint8_t hue_shift = 0

PolarLut::Controls polar : The polar address: whether to read it from a table, at what precision, and how a volumetric fixture's coordinates become an angle and a radius ([light/polar.h]).

Public Methods¶

virtual inline const char * tags() const override : Curated emoji tags for the module picker's chip filter — extras beyond the role chip (which the UI derives from role() on its own).

virtual inline Dim dimensions() const override : Which axes the effect iterates — a claim, not a guarantee about the layer.

virtual inline void defineControls() override : defineControls MUST be idempotent and pure: only controls_.clear() + controls_.addX().

virtual inline void prepare() override : Tier-3 of the control-change split (see onControlChanged above): the module (re)allocates / recomputes whatever derived state it owns — an effect's heap, a Layer's mapping LUT, the Drivers output buffer.

virtual inline void tick() override