CTRE_Phoenix 5.20.2
Public Member Functions | List of all members
ctre::phoenix::led::BaseStandardAnimation Class Reference

#include <BaseStandardAnimation.h>

Inherits ctre::phoenix::led::Animation.

Inherited by ctre::phoenix::led::FireAnimation, ctre::phoenix::led::RainbowAnimation, and ctre::phoenix::led::RgbFadeAnimation.

Public Member Functions

 BaseStandardAnimation (int idx, double brightness, double speed, int numLed, double param4, double param5)
 
BaseStandardAnimation * GetBaseStandardAnimation ()
 
BaseTwoSizeAnimation * GetBaseTwoSizeAnimation ()
 
void SetBrightness (double brightness)
 
void SetParam4 (double param4)
 
void SetParam5 (double param5)
 
double GetBrightness ()
 
double GetParam4 ()
 
double GetParam5 ()
 
- Public Member Functions inherited from ctre::phoenix::led::Animation
 Animation (int idx, double speed, int numLed)
 
void SetSpeed (double speed)
 
void SetNumLed (int numLed)
 
virtual BaseStandardAnimation * GetBaseStandardAnimation ()=0
 
virtual BaseTwoSizeAnimation * GetBaseTwoSizeAnimation ()=0
 
int GetAnimationIdx ()
 
double GetSpeed ()
 
int GetNumLed ()
 

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 
)

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

Member Function Documentation

◆ GetBaseStandardAnimation()

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

Implements ctre::phoenix::led::Animation.

◆ GetBaseTwoSizeAnimation()

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

Implements ctre::phoenix::led::Animation.

◆ 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]
The documentation for this class was generated from the following file: