#include <FFXOverlay.h>

Inheritance diagram for FFXOverlay:

Public Member Functions
	FFXOverlay (uint16_t initSize, uint8_t initSpeed, bool initCont)

	FFXOverlay (uint16_t initSize, bool initCont)

	FFXOverlay (uint16_t initSize)

	FFXOverlay (uint16_t initSize, uint8_t initSpeed, uint8_t numCycles, unsigned long cycleDelay)

	~FFXOverlay ()

std::vector< uint8_t > *	getAlpha ()

virtual void	applyOverlay (CRGB overlay, CRGB leds)

virtual void	whileFrozen (CRGB *currFrame) override

virtual void	onVCycleEnd (CRGB *currFrame) override

bool	isDone ()

void	setLag (unsigned long newLag)

unsigned long	getLag ()

void	setMaxAlpha (uint8_t newMax)

uint8_t	getMaxAlpha ()

Public Member Functions inherited from FFXBase
	FFXBase (uint16_t initSize, unsigned long initInterval, unsigned long minRefresh, unsigned long maxRefresh)

	FFXBase (uint16_t initSize, unsigned long initInterval)

	FFXBase (uint16_t initSize, uint8_t initSpeed, unsigned long minRefresh, unsigned long maxRefresh)

	FFXBase (uint16_t initSize, uint8_t initSpeed)

	FFXBase (uint16_t initSize)

void	initialize (uint16_t initSize)

String	getFXName ()

uint8_t	getFXID ()

virtual void	setInterval (unsigned long newInterval) override

virtual void	setColor (CRGB newColor)

MovementType	getMovement ()

FFXBase::MovementType	getCurrMovement (uint16_t cycle)

void	setMovement (MovementType newMovement)

FFXColor &	getFXColor ()

CRGB	getColor ()

void	setFXColor (FFXColor &newColor)

uint16_t	mirror (uint16_t index)

void	rotateForward (CRGB *bufLeds, uint16_t steps)

void	rotateBackward (CRGB *bufLeds, uint16_t steps)

uint16_t	addOffsetWithWrap (uint16_t index, uint16_t offset)

uint16_t	subtractOffsetWithWrap (uint16_t index, uint16_t offset)

uint16_t	getNextPhase ()

uint16_t	getNextVPhase ()

uint16_t	getPrevPhase ()

uint16_t	getPrevVphase ()

uint16_t	getCurrPhase ()

uint16_t	getCurrVPhase ()

unsigned long	getCurrCycle ()

unsigned long	getCurrVCycle ()

uint16_t	getMovementPhase ()

uint16_t	getMovementVPhase ()

uint16_t	getNumLeds ()

uint16_t	getVCycleRange ()

uint16_t	setVCycleRange (uint16_t newRange)

virtual int	timingDelta (uint8_t phase, unsigned long sourceMillis)

int	timingDelta (unsigned long sourceMillis)

virtual void	onEachSecond (unsigned long secsRunning)

virtual void	onCycleStart (CRGB *currFrame)

virtual void	onCycleEnd (CRGB *currFrame)

virtual void	onVCycleStart (CRGB *currFrame)

virtual void	onBrightness (uint8_t newBrightness)

virtual void	initLeds (CRGB *bufLeds)

virtual void	writeNextFrame (CRGB *frameBuffer)=0

void	vCycleStart (CRGB *currFrame)

void	vCycleEnd (CRGB *currFrame)

void	cycleStart (CRGB *currFrame)

void	cycleEnd (CRGB *currFrame)

void	freeze ()

void	unFreeze ()

bool	isFrozen ()

void	update (CRGB *frameBuffer)

boolean	isUpdated ()

void	setUpdated (boolean newValue)

Public Member Functions inherited from FFXStateNotifier
	FFXStateNotifier ()

virtual	~FFXStateNotifier ()

void	addObserver (FFXStateObserver *obs)

void	notify (String source, String attribute, String value)

Public Member Functions inherited from FlexTimer
	FlexTimer (unsigned long minInterval, unsigned long maxInterval, unsigned long initInterval, boolean initStart)

	FlexTimer (unsigned long initInterval, boolean initStart)

	FlexTimer (unsigned long initInterval)

	FlexTimer (unsigned long minInterval, unsigned long maxInterval, bool initStart, uint8_t initSpeed)

virtual void	onStart (unsigned long currMillis) override

virtual void	onStep (unsigned long currMillis) override

void	setStartExpired (boolean newVal)

boolean	getStartExpired ()

unsigned long	getRangeMin ()

unsigned long	getRangeMax ()

void	setRange (unsigned long minInterval, unsigned long maxInterval)

virtual void	setSpeed (uint8_t newSpeed)

virtual uint8_t	getSpeed ()

void	addDelta (long delta)

virtual unsigned long	getLastUp () override

unsigned long	getCurrInterval ()

unsigned long	getSteps ()

Public Member Functions inherited from StepTimer
	StepTimer ()

	StepTimer (unsigned long initInterval, boolean startImmediate)

	StepTimer (unsigned long initInterval)

virtual	~StepTimer ()

void	start ()

void	start (unsigned long currMillis)

void	step ()

void	step (unsigned long currMillis)

void	stop ()

bool	isStarted ()

bool	isUp (unsigned long currMillis)

bool	isUp ()

unsigned long	nextUp ()

unsigned long	timeRemaining (unsigned long currMillis)

unsigned long	timeRemaining ()

unsigned long	getRollovers ()

unsigned long	timeSinceStarted (unsigned long currMillis)

unsigned long	timeSinceStarted ()

unsigned long	timeSinceTriggered (unsigned long currMillis)

unsigned long	timeSinceTriggered ()

virtual void	setIntervalImmediate (unsigned long newInterval)

unsigned long	getInterval ()

Protected Member Functions
void	moveAintoB (byte a, byte b, uint16_t size_a, uint16_t size_b, uint16_t end_position, size_t elementsize)

Protected Attributes
bool	continuous = false

bool	completed = false

uint8_t	repeat = 1

unsigned long	repeatDelayms = 500

unsigned long	nextCycleStart = 0

std::vector< uint8_t >	alpha

uint8_t	maxAlpha = 255

Protected Attributes inherited from FFXBase
uint8_t	fxid = 0

String	fxName = ""

FFXColor	currColor = FFXColor()

uint16_t	numLeds

MovementType	currMovement = MVT_FORWARD

uint16_t	currPhase = 1

uint16_t	currVPhase = 1

unsigned long	currCycle = 1

unsigned long	currVCycle = 1

uint16_t	vCycleRange

bool	changed = true

bool	initialized = false

unsigned long	defaultFrameRefresh = 50

unsigned long	secondsElapsed = 0

bool	frozen = false

Protected Attributes inherited from StepTimer
unsigned long	interval =DEFAULT_TIMER_INTERVAL

unsigned long	started =0

unsigned long	nextUpMillis =0

uint16_t	rollovers = 0

unsigned long	pendInterval = 0

Additional Inherited Members
Public Types inherited from FFXBase
enum	MovementType { MVT_FORWARD =1, MVT_BACKWARD =2, MVT_BACKFORTH =3, MVT_RANDOM =4, MVT_STILL =5 }

enum	FadeType { LINEAR =1, GAMMA =2, CUBIC =3 }

Static Public Member Functions inherited from FFXBase
static String	movementTypeStr (MovementType mvt)

static String	fadeMethodStr (FadeType value)

static uint8_t	alphaBlend (uint8_t a, uint8_t b, uint8_t alpha)

static CRGB	alphaBlend (CRGB &a, CRGB &b, uint8_t alpha, FadeType ftUp=LINEAR, FadeType ftDown=LINEAR)

static void	alphaBlend (CRGB a, CRGB b, CRGB *dest, uint16_t num, uint8_t alpha, FadeType ftUp=LINEAR, FadeType ftDown=LINEAR)

static uint16_t	mirror (uint16_t index, uint16_t range)

static void	rotateBufferForwardWithWrap (CRGB source, CRGB dest, uint8_t numLeds, uint8_t steps)

static void	rotateBufferBackwardWithWrap (CRGB source, CRGB dest, uint16_t numLeds, uint16_t steps)

Static Public Member Functions inherited from FlexTimer
static uint8_t	intervalToSpeed (unsigned long intv, unsigned long rMin, unsigned long rMax)

static unsigned long	speedToInterval (uint8_t speed, unsigned long rMin, unsigned long rMax)

Static Public Member Functions inherited from StepTimer
static unsigned long	addOffsetWithWrap (unsigned long index, unsigned long offset, unsigned long maximum)

static unsigned long	addOffsetWithWrap (unsigned long index, unsigned long offset)

static unsigned long	subtractOffsetWithWrap (unsigned long index, unsigned long offset, unsigned long maximum)

Static Public Attributes inherited from FlexTimer
static const unsigned long	MIN_INTERVAL = 1

static const unsigned long	MAX_INTERVAL = 5000U

Detailed Description

FFXOverlay - Base class of overlay effects. Overlays can be sized independently and independent from the strip they are run against. The overlay has an array of "Alpha" values, which determines the opacity of each pixel in the effect. This can be used to make the entire overlay, or segments of it, partially transparent.

Overlay effects have independent speed, a repeat value (how many times the cycle will run), and a repeat delay (the number of milliseconds between each repeat).

Constructor & Destructor Documentation

◆ FFXOverlay() [1/4]

FFXOverlay::FFXOverlay	(	uint16_t	initSize,
		uint8_t	initSpeed,
		bool	initCont
	)

inline

◆ FFXOverlay() [2/4]

FFXOverlay::FFXOverlay	(	uint16_t	initSize,
		bool	initCont
	)

inline

◆ FFXOverlay() [3/4]

FFXOverlay::FFXOverlay ( uint16_t initSize )

inline

◆ FFXOverlay() [4/4]

FFXOverlay::FFXOverlay	(	uint16_t	initSize,
		uint8_t	initSpeed,
		uint8_t	numCycles,
		unsigned long	cycleDelay
	)

inline

◆ ~FFXOverlay()

FFXOverlay::~FFXOverlay ( )

inline

Member Function Documentation

◆ applyOverlay()

void FFXOverlay::applyOverlay	(	CRGB *	overlay,
		CRGB *	leds
	)

virtual

◆ getAlpha()

std::vector<uint8_t>* FFXOverlay::getAlpha ( )

inline

◆ getLag()

unsigned long FFXOverlay::getLag ( )

inline

◆ getMaxAlpha()

uint8_t FFXOverlay::getMaxAlpha ( )

inline

◆ isDone()

bool FFXOverlay::isDone ( )

inline

◆ moveAintoB()

void FFXOverlay::moveAintoB	(	byte *	a,
		byte *	b,
		uint16_t	size_a,
		uint16_t	size_b,
		uint16_t	end_position,
		size_t	elementsize
	)

protected

◆ onVCycleEnd()

void FFXOverlay::onVCycleEnd ( CRGB * currFrame )

overridevirtual

Reimplemented from FFXBase.

◆ setLag()

void FFXOverlay::setLag ( unsigned long newLag )

inline

◆ setMaxAlpha()

void FFXOverlay::setMaxAlpha ( uint8_t newMax )

inline

◆ whileFrozen()

void FFXOverlay::whileFrozen ( CRGB * currFrame )

overridevirtual

Reimplemented from FFXBase.

Member Data Documentation

◆ alpha

std::vector<uint8_t> FFXOverlay::alpha

protected

◆ completed

bool FFXOverlay::completed = false

protected

◆ continuous

bool FFXOverlay::continuous = false

protected

◆ maxAlpha

uint8_t FFXOverlay::maxAlpha = 255

protected

◆ nextCycleStart

unsigned long FFXOverlay::nextCycleStart = 0

protected

◆ repeat

uint8_t FFXOverlay::repeat = 1

protected

◆ repeatDelayms

unsigned long FFXOverlay::repeatDelayms = 500

protected

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FFXOverlay() [1/4]

◆ FFXOverlay() [2/4]

◆ FFXOverlay() [3/4]

◆ FFXOverlay() [4/4]

◆ ~FFXOverlay()

Member Function Documentation

◆ applyOverlay()

◆ getAlpha()

◆ getLag()

◆ getMaxAlpha()

◆ isDone()

◆ moveAintoB()

◆ onVCycleEnd()

◆ setLag()

◆ setMaxAlpha()

◆ whileFrozen()

Member Data Documentation

◆ alpha

◆ completed

◆ continuous

◆ maxAlpha

◆ nextCycleStart

◆ repeat

◆ repeatDelayms