ctre::phoenix::led::FireAnimation Class Reference
Animation that looks similarly to a flame flickering. More...
#include <ctre/phoenix/led/FireAnimation.h>
Inheritance diagram for ctre::phoenix::led::FireAnimation:
Public Member Functions | |
| FireAnimation (double brightness=1, double speed=1, int numLed=-1, double sparking=1, double cooling=1, bool reverseDirection=false, int ledOffset=0) | |
| Constructor for a FireAnimation. More... | |
| void | SetSparking (double sparking) |
| Sets the sparking value of the FireAnimation. More... | |
| void | SetCooling (double cooling) |
| Sets the cooling value of the FireAnimation. 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 looks similarly to a flame flickering.
Constructor & Destructor Documentation
◆ FireAnimation()
| ctre::phoenix::led::FireAnimation::FireAnimation | ( | double | brightness = 1, |
| double | speed = 1, |
||
| int | numLed = -1, |
||
| double | sparking = 1, |
||
| double | cooling = 1, |
||
| bool | reverseDirection = false, |
||
| int | ledOffset = 0 |
||
| ) |
Constructor for a FireAnimation.
- Parameters
-
brightness How bright should the animation be [0, 1] speed How fast will the flame be processed at [0, 1] numLed How many LEDs is the CANdle controlling sparking The rate at which the Fire "Sparks" [0, 1] cooling The rate at which the Fire "Cools" along the travel [0, 1] reverseDirection True to reverse the animation direction, so instead of fire going "away" from the CANdle, it will go "toward" the CANdle. ledOffset Where to start the animation
Member Function Documentation
◆ SetCooling()
| void ctre::phoenix::led::FireAnimation::SetCooling | ( | double | cooling | ) |
Sets the cooling value of the FireAnimation.
- Parameters
-
cooling The rate at which the Fire "Cools" [0, 1]
◆ SetSparking()
| void ctre::phoenix::led::FireAnimation::SetSparking | ( | double | sparking | ) |
Sets the sparking value of the FireAnimation.
- Parameters
-
sparking The rate at which the Fire "Sparks" [0, 1]
The documentation for this class was generated from the following file:
- ctre/phoenix/led/FireAnimation.h
