CTRE Phoenix C++ 5.33.1
|
The base class for one generic type of animation. More...
#include <ctre/phoenix/led/BaseStandardAnimation.h>
Public Member Functions | |
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 () |
The base class for one generic type of animation.
These animations do not allow the user to specify a color.
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.
idx | The animation-specific ID |
brightness | The brightness to run the animation at. This is a scalar from [0, 1] |
speed | The rate at which the animation runs at. Higher is generally faster |
numLed | The number of LEDs to run the animation on |
param4 | Animation-specific parameter |
param5 | Animation-specific parameter |
reverseDirection | True to reverse the animation direction, so instead of going "away" from the CANdle, it will go "toward" the CANdle. |
ledOffset | Where to start the animation |
ctre::phoenix::led::BaseStandardAnimation::~BaseStandardAnimation | ( | ) |
|
virtual |
Implements ctre::phoenix::led::Animation.
|
virtual |
Implements ctre::phoenix::led::Animation.
double ctre::phoenix::led::BaseStandardAnimation::GetBrightness | ( | ) |
double ctre::phoenix::led::BaseStandardAnimation::GetParam4 | ( | ) |
double ctre::phoenix::led::BaseStandardAnimation::GetParam5 | ( | ) |
bool ctre::phoenix::led::BaseStandardAnimation::GetReverseDirection | ( | ) |
void ctre::phoenix::led::BaseStandardAnimation::SetBrightness | ( | double | brightness | ) |
Sets the brightness of this animation.
brightness | The brightness to run the animation at. This is a scalar from [0, 1] |
void ctre::phoenix::led::BaseStandardAnimation::SetParam4 | ( | double | param4 | ) |
void ctre::phoenix::led::BaseStandardAnimation::SetParam5 | ( | double | param5 | ) |
void ctre::phoenix::led::BaseStandardAnimation::SetReverseDirection | ( | bool | reverseDirection | ) |