CTRE Phoenix C++ 5.33.1
ctre::phoenix::led::SingleFadeAnimation Class Reference

Animation that fades into and out of a specified color. More...

#include <ctre/phoenix/led/SingleFadeAnimation.h>

Inheritance diagram for ctre::phoenix::led::SingleFadeAnimation:
ctre::phoenix::led::BaseTwoSizeAnimation ctre::phoenix::led::Animation

Public Member Functions

 SingleFadeAnimation (int r, int g, int b, int w=0, double speed=1, int numLed=-1, int ledOffset=0)
 Constructor for a SingleFadeAnimation. More...
 
- Public Member Functions inherited from ctre::phoenix::led::BaseTwoSizeAnimation
 BaseTwoSizeAnimation (int idx, int r, int g, int b, int w, double speed, int numLed, int direction, int size, int ledOffset)
 Constructor for the BaseStandardAnimation object. More...
 
 ~BaseTwoSizeAnimation ()
 
BaseStandardAnimationGetBaseStandardAnimation ()
 
BaseTwoSizeAnimationGetBaseTwoSizeAnimation ()
 
void SetR (int r)
 Sets the R value of the LEDs. More...
 
void SetG (int g)
 Sets the G value of the LEDs. More...
 
void SetB (int b)
 Sets the B value of the LEDs. More...
 
void SetW (int w)
 Sets the W value of the LEDs. More...
 
void SetDirection (int direction)
 
void SetSize (int size)
 
int GetR ()
 
int GetG ()
 
int GetB ()
 
int GetW ()
 
int GetDirection ()
 
int GetSize ()
 
- Public Member Functions inherited from ctre::phoenix::led::Animation
 Animation (int idx, double speed, int numLed, int ledOffset)
 Constructor for an Animation class. More...
 
virtual ~Animation ()
 
void SetSpeed (double speed)
 Sets the speed of the animation. More...
 
void SetNumLed (int numLed)
 Sets the number of LEDs the animation will run on. More...
 
void SetLedOffset (int ledOffset)
 Sets where the animation starts along the strip. More...
 
virtual BaseStandardAnimationGetBaseStandardAnimation ()=0
 
virtual BaseTwoSizeAnimationGetBaseTwoSizeAnimation ()=0
 
int GetAnimationIdx ()
 
double GetSpeed ()
 
int GetNumLed ()
 
int GetLedOffset ()
 

Detailed Description

Animation that fades into and out of a specified color.

Constructor & Destructor Documentation

◆ SingleFadeAnimation()

ctre::phoenix::led::SingleFadeAnimation::SingleFadeAnimation ( int  r,
int  g,
int  b,
int  w = 0,
double  speed = 1,
int  numLed = -1,
int  ledOffset = 0 
)

Constructor for a SingleFadeAnimation.

Parameters
rHow much red should the color have [0, 255]
gHow much green should the color have [0, 255]
bHow much blue should the color have [0, 255]
wHow much white should the color have [0, 255]
speedHow fast should the color travel the strip [0, 1]
numLedHow many LEDs the CANdle controls
ledOffsetWhere to start the animation

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