2023-Robot
Robot code for 2023 FRC season by Argos, FRC team #1756
Loading...
Searching...
No Matches
argos_lib::led::Animation Struct Reference

A representation of a custom LED animation. More...

#include <animiation.h>

Public Member Functions

 Animation ()=delete
 Delete default constructor because it is meaningless.
 
 Animation (std::function< Strip()> update, unsigned numLEDs, unsigned offset)
 Construct a new Animation object.
 

Public Attributes

std::function< Strip()> update
 This function can be any callable that returns a sequence of LED colors.
 
unsigned numLEDs
 Number of LEDs in the animation.
 
unsigned offset
 Address of first LED.
 

Detailed Description

A representation of a custom LED animation.

Constructor & Destructor Documentation

◆ Animation() [1/2]

argos_lib::led::Animation::Animation ( )
delete

Delete default constructor because it is meaningless.

◆ Animation() [2/2]

argos_lib::led::Animation::Animation ( std::function< Strip()>  update,
unsigned  numLEDs,
unsigned  offset 
)
inline

Construct a new Animation object.

Parameters
updateFunction to call that generates the new LED states for this animation
numLEDsNumber of LEDs in the animation
offsetAddress of first LED controlled by this animation

Member Data Documentation

◆ numLEDs

unsigned argos_lib::led::Animation::numLEDs

Number of LEDs in the animation.

◆ offset

unsigned argos_lib::led::Animation::offset

Address of first LED.

◆ update

std::function<Strip()> argos_lib::led::Animation::update

This function can be any callable that returns a sequence of LED colors.


The documentation for this struct was generated from the following file: