FFXAutoFader Class Reference

#include <FFXAutoFader.h>

Inheritance diagram for FFXAutoFader:

Public Member Functions
	FFXAutoFader ()
	FFXAutoFader (uint8_t initValue)
virtual	~FFXAutoFader ()
bool	isFading ()
bool	isUpdated ()
uint8_t	getTarget ()
void	setTarget (uint8_t newTarget)
uint8_t	getValue ()
void	update (CRGBSet &pixels)
virtual void	onUpdate (CRGBSet &pixels)=0
void	setInterval (uint16_t ms)
uint16_t	getInterval ()
void	updateFader ()

Detailed Description

FFXAutoFader - Abstract class to implement timed fading. Abstract method onUpdate( CRGBSet& ) should be overriden in descendant classes to implement the "effect". The update() method is included in looping to "track" the status of the fader. Target attribute always refers to the desired/set value (0-255), while the Value attribute refers to the current value. Upon a call to setTarget(), the fader will move consistently from its current value to the target value over the desired interval.

Constructor & Destructor Documentation

FFXAutoFader() [1/2]

FFXAutoFader::FFXAutoFader ( )

inline

FFXAutoFader() [2/2]

FFXAutoFader::FFXAutoFader ( uint8_t  initValue )

inline

~FFXAutoFader()

virtual FFXAutoFader::~FFXAutoFader ( )

inlinevirtual

Member Function Documentation

getInterval()

uint16_t FFXAutoFader::getInterval ( )

inline

getTarget()

uint8_t FFXAutoFader::getTarget ( )

inline

getValue()

uint8_t FFXAutoFader::getValue ( )

inline

isFading()

bool FFXAutoFader::isFading ( )

inline

isUpdated()

bool FFXAutoFader::isUpdated ( )

inline

onUpdate()

virtual void FFXAutoFader::onUpdate ( CRGBSet &  pixels )

pure virtual

Implemented in FFXAFDimmer, and FFXAFXFader.

setInterval()

void FFXAutoFader::setInterval ( uint16_t  ms )

inline

setTarget()

void FFXAutoFader::setTarget

(

uint8_t

newTarget

)

update()

void FFXAutoFader::update ( CRGBSet &  pixels )

inline

updateFader()

void FFXAutoFader::updateFader

(

)