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

The base class for one generic type of animation. More...

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

Inheritance diagram for ctre::phoenix::led::BaseStandardAnimation:
ctre::phoenix::led::Animation ctre::phoenix::led::FireAnimation ctre::phoenix::led::RainbowAnimation ctre::phoenix::led::RgbFadeAnimation

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 ()
 
BaseStandardAnimationGetBaseStandardAnimation ()
 
BaseTwoSizeAnimationGetBaseTwoSizeAnimation ()
 
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 BaseStandardAnimationGetBaseStandardAnimation ()=0
 
virtual BaseTwoSizeAnimationGetBaseTwoSizeAnimation ()=0
 
int GetAnimationIdx ()
 
double GetSpeed ()
 
int GetNumLed ()
 
int GetLedOffset ()
 

Detailed Description

The base class for one generic type of animation.

These animations do not allow the user to specify a color.

Constructor & Destructor Documentation

◆ BaseStandardAnimation()

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.

Parameters
idxThe animation-specific ID
brightnessThe brightness to run the animation at. This is a scalar from [0, 1]
speedThe rate at which the animation runs at. Higher is generally faster
numLedThe number of LEDs to run the animation on
param4Animation-specific parameter
param5Animation-specific parameter
reverseDirectionTrue to reverse the animation direction, so instead of going "away" from the CANdle, it will go "toward" the CANdle.
ledOffsetWhere to start the animation

◆ ~BaseStandardAnimation()

ctre::phoenix::led::BaseStandardAnimation::~BaseStandardAnimation ( )

Member Function Documentation

◆ GetBaseStandardAnimation()

BaseStandardAnimation * ctre::phoenix::led::BaseStandardAnimation::GetBaseStandardAnimation ( )
virtual

◆ GetBaseTwoSizeAnimation()

BaseTwoSizeAnimation * ctre::phoenix::led::BaseStandardAnimation::GetBaseTwoSizeAnimation ( )
virtual

◆ GetBrightness()

double ctre::phoenix::led::BaseStandardAnimation::GetBrightness ( )

◆ GetParam4()

double ctre::phoenix::led::BaseStandardAnimation::GetParam4 ( )

◆ GetParam5()

double ctre::phoenix::led::BaseStandardAnimation::GetParam5 ( )

◆ GetReverseDirection()

bool ctre::phoenix::led::BaseStandardAnimation::GetReverseDirection ( )

◆ SetBrightness()

void ctre::phoenix::led::BaseStandardAnimation::SetBrightness ( double  brightness)

Sets the brightness of this animation.

Parameters
brightnessThe brightness to run the animation at. This is a scalar from [0, 1]

◆ SetParam4()

void ctre::phoenix::led::BaseStandardAnimation::SetParam4 ( double  param4)

◆ SetParam5()

void ctre::phoenix::led::BaseStandardAnimation::SetParam5 ( double  param5)

◆ SetReverseDirection()

void ctre::phoenix::led::BaseStandardAnimation::SetReverseDirection ( bool  reverseDirection)

Set the Direction of the animation.

Parameters
reverseDirectionTrue to reverse the animation direction, so instead of fire going "away" from the CANdle, it will go "toward" the CANdle.

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