Detailed Description

Pure fixed-point (s16x16) flow field implementation for maximum speed.

All internal computation uses Q16.16 fixed-point arithmetic — no float operations in any code path. Public API accepts float parameters which are converted to s16x16 before each draw.

Examples: FlowField.ino.

Definition at line 360 of file flowfield.h.

#include <flowfield.h>

Inheritance diagram for fl::FlowFieldFP:

Collaboration diagram for fl::FlowFieldFP:

Public Member Functions
	FlowFieldFP (const XYMap &xyMap, const Params &params=Params())

fl::string	fxName () const override

Public Member Functions inherited from fl::FlowField
	~FlowField () FL_NOEXCEPT override=default

void	draw (DrawContext context) override
	Handles timing, then delegates to drawImpl().

Params &	getParams ()

const Params &	getParams () const

NoiseBias2D &	noiseBias ()

const NoiseBias2D &	noiseBias () const

void	noisePunch (float amplitude=1.0f, BumpShape shape=BumpShape::HalfSine)
	Trigger a noise punch on both axes at center with proportional width.

void	noisePunchX (float center, float width, float amplitude=1.0f, BumpShape shape=BumpShape::HalfSine)
	Trigger a noise punch on the X axis (columns).

void	noisePunchY (float center, float width, float amplitude=1.0f, BumpShape shape=BumpShape::HalfSine)
	Trigger a noise punch on the Y axis (rows).

void	setColorShift (float speed)

void	setDotCount (int count)

void	setEmitterMode (int mode)

void	setEndpointSpeed (float speed)

void	setFlowAmplitudeX (float amp)

void	setFlowAmplitudeY (float amp)

void	setFlowShift (float shift)

void	setFlowSpeedX (float speed)

void	setFlowSpeedY (float speed)

void	setNoiseFrequency (float freq)

void	setNoiseFrequencyX (float freq)

void	setNoiseFrequencyY (float freq)

void	setPersistence (float halfLife)

void	setReverseXProfile (bool rev)

void	setShowFlowVectors (bool show)

void	setSpeed (float speed)
	Set time speed/scale (1.0 = normal, 0.5 = half speed, etc.)

float	speed () const

Public Member Functions inherited from fl::Fx2d
	Fx2d (const XYMap &xyMap)

u16	getHeight () const

u16	getWidth () const

XYMap &	getXYMap ()

const XYMap &	getXYMap () const

void	setXYMap (const XYMap &xyMap)

u16	xyMap (u16 x, u16 y) const

Public Member Functions inherited from fl::Fx
	Fx (u16 numLeds)

u16	getNumLeds () const

virtual bool	hasFixedFrameRate (float *fps) const

virtual void	pause (fl::u32 now)

virtual void	resume (fl::u32 now)

Protected Member Functions
void	drawImpl (DrawContext context, u32 dt_ms, u32 t_ms) override
	Subclasses implement rendering given the time delta and total time.

Protected Member Functions inherited from fl::FlowField
	FlowField (const XYMap &xyMap, const Params &params=Params())

Protected Member Functions inherited from fl::Fx
virtual	~Fx () FL_NOEXCEPT

Private Member Functions
void	drawAALine (s16x16 x0, s16x16 y0, s16x16 x1, s16x16 y1, s16x16 t, s16x16 colorShift)

void	drawDot (s16x16 cx, s16x16 cy, s16x16 diam, u8 cr, u8 cg, u8 cb)

void	drawFlowVectors (fl::span< CRGB > leds)

void	emitLissajousLine (s16x16 t)

void	emitOrbitalDots (s16x16 t)

void	flowAdvect (i32 dt_raw)

void	flowPrepare (s16x16 t)

int	idx (int y, int x) const

void	syncParams ()

Static Private Member Functions
static i32	clamp_q16 (i32 v, i32 lo, i32 hi)

static void	initPerm256 (u8 *perm, u32 seed)

static u8	q16_to_u8 (i32 v)

static CRGB	rainbow (s16x16 t, s16x16 speed, s16x16 phase)

Private Attributes
s16x16	mColorShift_fp

s16x16	mEndpointSpeed_fp

s16x16	mFlowAmpX_fp

s16x16	mFlowAmpY_fp

s16x16	mFlowShift_fp

s16x16	mFlowSpeedX_fp

s16x16	mFlowSpeedY_fp

s16x16	mNoiseFreqX_fp

s16x16	mNoiseFreqY_fp

u8	mPermX [256] = {}

u8	mPermY [256] = {}

s16x16	mPersistence_fp

FlowFieldFPState	mState

Friends
struct	FlowFieldFPProfiler

Additional Inherited Members
Public Types inherited from fl::FlowField
using	Params = FlowFieldParams

Public Types inherited from fl::Fx
using	DrawContext = ::fl::DrawContext

Protected Attributes inherited from fl::FlowField
NoiseBias2D	mNoiseBias

Params	mParams

Protected Attributes inherited from fl::Fx2d
XYMap	mXyMap

Protected Attributes inherited from fl::Fx
u16	mNumLeds

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

fl/fx/2d/flowfield.h
fl/fx/2d/flowfield.cpp.hpp

Detailed Description

Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Additional Inherited Members