SBK_BarDrive Library 2.1.2
LED bar meter control and queued animations for Arduino
Loading...
Searching...
No Matches
SBK_BarMeterAnimations.h File Reference

Built-in animation engine for SBK_BarMeter-based LED displays. More...

#include <Arduino.h>

Go to the source code of this file.

Data Structures

class  SBK_BarMeterAnimations< BarMeterT >
 Templated animation controller for SBK_BarMeter<T>. More...
struct  SBK_BarMeterAnimations< BarMeterT >::QueueEntry
struct  SBK_BarMeterAnimations< BarMeterT >::Block

Macros

#define SBK_BARDRIVE_QUEUE_CAPACITY   4
#define bpm   _param1
#define MIN_BASE_LEVEL   _param2
#define MIN_PEAK_LEVEL   _param3
#define PEAK_HOLD_TIME   _param4
#define bpmPtr   _liveBpmPtr()
#define currentLevel   _ledTracker1
#define peakLevel   _ledTracker2
#define beat   _updateIntv1
#define lastBeat   _lastUpdate1
#define lastRandomUpdate   _lastUpdate2
#define prevPeakUpdate   _lastUpdate3
#define blockLength   _param1
#define blockSpacing   _param2
#define requestedNumBlocks   _param3
#define maxBlocks   _param4
#define emitIndex   _param5
#define emittedBlocksCount   _counter1
#define emitCooldown   _counter2
#define stackLevel   _ledTracker1
#define smoothingFactor   _param1
#define currentLevel   _ledTracker1
#define peakLevel   _ledTracker3
#define baseUpdate   _updateIntv1
#define lastBaseUpdate   _lastUpdate1
#define peakHoldTime   _updateIntv3
#define lastPeakUpdate   _lastUpdate3

Detailed Description

Built-in animation engine for SBK_BarMeter-based LED displays.

This file defines the SBK_BarMeterAnimations template class, which provides a rich set of built-in animation sequences for LED bar meters. It supports dynamic animations like filling, bouncing, signal tracking, block emissions, random pixel updates, and more.

Compatible with any SBK_BarMeter<DriverT> instance, this class integrates directly with SBK_BarDrive through its .animations() accessor.

Highlights:

  • Looping and one-shot animations
  • Direction and logic inversion controls
  • Live signal tracking and pointer rendering
  • Block-based animations with emission control
  • BPM-synchronized beat pulse effect
  • Chainable animation starter functions
  • Pixel state aware when SBK_TRACK_PIXEL_STATE is defined
Template Parameters
BarMeterTA specific instantiation of SBK_BarMeter (e.g., SBK_BarMeter<SBK_MAX72xxSoft>)
Author
Samuel Barabé (Smart Builds & Kits)
Version
2.1.2
License MIT
Copyright
Copyright (c) 2025 Samuel Barabé

Definition in file SBK_BarMeterAnimations.h.

Macro Definition Documentation

◆ baseUpdate

#define baseUpdate   _updateIntv1

Definition at line 3049 of file SBK_BarMeterAnimations.h.

◆ beat

#define beat   _updateIntv1

Definition at line 2358 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_beatPulse(), and SBK_BarMeterAnimations< BarMeterT >::_beatPulseLive().

◆ blockLength

#define blockLength   _param1

Definition at line 2454 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_calculateSwitchedEmitTickCounter(), SBK_BarMeterAnimations< BarMeterT >::_emitBlock(), SBK_BarMeterAnimations< BarMeterT >::_mirrorBlocks(), SBK_BarMeterAnimations< BarMeterT >::_scrollingBlocks(), SBK_BarMeterAnimations< BarMeterT >::_stackingBlocks(), SBK_BarMeterAnimations< BarMeterT >::collidingBlocks(), SBK_BarMeterAnimations< BarMeterT >::downStackingBlocks(), SBK_BarMeterAnimations< BarMeterT >::downUnstackingBlocks(), SBK_BarMeterAnimations< BarMeterT >::explodingBlocks(), SBK_BarMeterAnimations< BarMeterT >::scrollingDownBlocks(), SBK_BarMeterAnimations< BarMeterT >::scrollingUpBlocks(), SBK_BarMeterAnimations< BarMeterT >::upStackingBlocks(), and SBK_BarMeterAnimations< BarMeterT >::upUnstackingBlocks().

◆ blockSpacing

#define blockSpacing   _param2

Definition at line 2455 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_calculateSwitchedEmitTickCounter(), SBK_BarMeterAnimations< BarMeterT >::_emitBlock(), SBK_BarMeterAnimations< BarMeterT >::_stackingBlocks(), SBK_BarMeterAnimations< BarMeterT >::collidingBlocks(), SBK_BarMeterAnimations< BarMeterT >::downStackingBlocks(), SBK_BarMeterAnimations< BarMeterT >::downUnstackingBlocks(), SBK_BarMeterAnimations< BarMeterT >::explodingBlocks(), SBK_BarMeterAnimations< BarMeterT >::scrollingDownBlocks(), SBK_BarMeterAnimations< BarMeterT >::scrollingUpBlocks(), SBK_BarMeterAnimations< BarMeterT >::upStackingBlocks(), and SBK_BarMeterAnimations< BarMeterT >::upUnstackingBlocks().

◆ bpm

#define bpm   _param1

Definition at line 2351 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_beatPulseLive(), and SBK_BarMeterAnimations< BarMeterT >::beatPulse().

◆ bpmPtr

#define bpmPtr   _liveBpmPtr()

Definition at line 2355 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_beatPulseLive(), and SBK_BarMeterAnimations< BarMeterT >::beatPulse().

◆ currentLevel [1/2]

#define currentLevel   _ledTracker1

Definition at line 2356 of file SBK_BarMeterAnimations.h.

◆ currentLevel [2/2]

#define currentLevel   _ledTracker1

Definition at line 2356 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_beatPulse(), and SBK_BarMeterAnimations< BarMeterT >::_followSignalFloatingPeak().

◆ emitCooldown

#define emitCooldown   _counter2

Definition at line 2460 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_emitBlock(), SBK_BarMeterAnimations< BarMeterT >::_mirrorBlocks(), SBK_BarMeterAnimations< BarMeterT >::_scrollingBlocks(), and SBK_BarMeterAnimations< BarMeterT >::_stackingBlocks().

◆ emitIndex

#define emitIndex   _param5

Definition at line 2458 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_emitBlock(), and SBK_BarMeterAnimations< BarMeterT >::_stackingBlocks().

◆ emittedBlocksCount

#define emittedBlocksCount   _counter1

Definition at line 2459 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_emitBlock(), SBK_BarMeterAnimations< BarMeterT >::_mirrorBlocks(), and SBK_BarMeterAnimations< BarMeterT >::_scrollingBlocks().

◆ lastBaseUpdate

#define lastBaseUpdate   _lastUpdate1

Definition at line 3050 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_followSignalFloatingPeak().

◆ lastBeat

#define lastBeat   _lastUpdate1

Definition at line 2359 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_beatPulse().

◆ lastPeakUpdate

#define lastPeakUpdate   _lastUpdate3

Definition at line 3052 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_followSignalFloatingPeak().

◆ lastRandomUpdate

#define lastRandomUpdate   _lastUpdate2

Definition at line 2360 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_beatPulse().

◆ maxBlocks

#define maxBlocks   _param4

Definition at line 2457 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_calculateSwitchedEmitTickCounter(), SBK_BarMeterAnimations< BarMeterT >::_emitBlock(), SBK_BarMeterAnimations< BarMeterT >::_mirrorBlocks(), SBK_BarMeterAnimations< BarMeterT >::_scrollingBlocks(), and SBK_BarMeterAnimations< BarMeterT >::_stackingBlocks().

◆ MIN_BASE_LEVEL

#define MIN_BASE_LEVEL   _param2

Definition at line 2352 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_beatPulse().

◆ MIN_PEAK_LEVEL

#define MIN_PEAK_LEVEL   _param3

Definition at line 2353 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_beatPulse().

◆ PEAK_HOLD_TIME

#define PEAK_HOLD_TIME   _param4

Definition at line 2354 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_beatPulse().

◆ peakHoldTime

#define peakHoldTime   _updateIntv3

Definition at line 3051 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_followSignalFloatingPeak(), and SBK_BarMeterAnimations< BarMeterT >::followSignalFloatingPeak().

◆ peakLevel [1/2]

#define peakLevel   _ledTracker3

Definition at line 2357 of file SBK_BarMeterAnimations.h.

◆ peakLevel [2/2]

#define peakLevel   _ledTracker2

Definition at line 2357 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_beatPulse(), and SBK_BarMeterAnimations< BarMeterT >::_followSignalFloatingPeak().

◆ prevPeakUpdate

#define prevPeakUpdate   _lastUpdate3

Definition at line 2361 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_beatPulse().

◆ requestedNumBlocks

#define requestedNumBlocks   _param3

Definition at line 2456 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_emitBlock(), SBK_BarMeterAnimations< BarMeterT >::_mirrorBlocks(), and SBK_BarMeterAnimations< BarMeterT >::_scrollingBlocks().

◆ SBK_BARDRIVE_QUEUE_CAPACITY

#define SBK_BARDRIVE_QUEUE_CAPACITY   4

Definition at line 40 of file SBK_BarMeterAnimations.h.

◆ smoothingFactor

#define smoothingFactor   _param1

Definition at line 2885 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_followDualSignalCenterMirror(), SBK_BarMeterAnimations< BarMeterT >::_followSignalFloatingPeak(), SBK_BarMeterAnimations< BarMeterT >::_followSignalSmooth(), SBK_BarMeterAnimations< BarMeterT >::_followSignalWithPointer(), SBK_BarMeterAnimations< BarMeterT >::followDualSignalFromCenter(), SBK_BarMeterAnimations< BarMeterT >::followDualSignalFromEdges(), SBK_BarMeterAnimations< BarMeterT >::followSignalFloatingPeak(), SBK_BarMeterAnimations< BarMeterT >::followSignalSmooth(), and SBK_BarMeterAnimations< BarMeterT >::followSignalWithPointer().

◆ stackLevel

#define stackLevel   _ledTracker1

Definition at line 2706 of file SBK_BarMeterAnimations.h.

Referenced by SBK_BarMeterAnimations< BarMeterT >::_stackingBlocks().