ctre::phoenix::led::RainbowAnimation Class Reference
Animation that creates a rainbow throughout all the LEDs. More...
#include <ctre/phoenix/led/RainbowAnimation.h>
Inheritance diagram for ctre::phoenix::led::RainbowAnimation:
Public Member Functions | |
| RainbowAnimation (double brightness=1, double speed=1, int numLed=-1, bool reverseDirection=false, int ledOffset=0) | |
| Constructor for a RainbowAnimation. More... | |
 Public Member Functions inherited from ctre::phoenix::led::BaseStandardAnimation | |
| BaseStandardAnimation (int idx, double brightness, double speed, int numLed, double param4, double param5, bool reverseDirection, int ledOffset) | |
| Constructor for the BaseStandardAnimation object. More... | |
| ~BaseStandardAnimation () | |
| BaseStandardAnimation * | GetBaseStandardAnimation () |
| BaseTwoSizeAnimation * | GetBaseTwoSizeAnimation () |
| void | SetBrightness (double brightness) |
| Sets the brightness of this animation. More... | |
| void | SetParam4 (double param4) |
| void | SetParam5 (double param5) |
| void | SetReverseDirection (bool reverseDirection) |
| Set the Direction of the animation. More... | |
| double | GetBrightness () |
| double | GetParam4 () |
| double | GetParam5 () |
| bool | GetReverseDirection () |
| 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 BaseStandardAnimation * | GetBaseStandardAnimation ()=0 |
| virtual BaseTwoSizeAnimation * | GetBaseTwoSizeAnimation ()=0 |
| int | GetAnimationIdx () |
| double | GetSpeed () |
| int | GetNumLed () |
| int | GetLedOffset () |
Detailed Description
Animation that creates a rainbow throughout all the LEDs.
Constructor & Destructor Documentation
◆ RainbowAnimation()
| ctre::phoenix::led::RainbowAnimation::RainbowAnimation | ( | double | brightness = 1, |
| double | speed = 1, |
||
| int | numLed = -1, |
||
| bool | reverseDirection = false, |
||
| int | ledOffset = 0 |
||
| ) |
Constructor for a RainbowAnimation.
- Parameters
-
brightness The brightness of the LEDs [0, 1] speed How fast the rainbow travels through the leds [0, 1] numLed How many LEDs are controlled by the CANdle reverseDirection True to reverse the animation direction, so instead of going "toward" the CANdle, it will go "away" from the CANdle. ledOffset Where to start the animation
The documentation for this class was generated from the following file:
- ctre/phoenix/led/RainbowAnimation.h
