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:

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.
	~BaseStandardAnimation ()
BaseStandardAnimation *	GetBaseStandardAnimation ()
BaseTwoSizeAnimation *	GetBaseTwoSizeAnimation ()
void	SetBrightness (double brightness)
	Sets the brightness of this animation.
void	SetParam4 (double param4)
void	SetParam5 (double param5)
void	SetReverseDirection (bool reverseDirection)
	Set the Direction of the animation.
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.
virtual	~Animation ()
void	SetSpeed (double speed)
	Sets the speed of the animation.
void	SetNumLed (int numLed)
	Sets the number of LEDs the animation will run on.
void	SetLedOffset (int ledOffset)
	Sets where the animation starts along the strip.
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.

Deprecated

This device's Phoenix 5 API is deprecated for removal in the 2027 season. Users should update to Phoenix 6 firmware and migrate to the Phoenix 6 API. A migration guide is available at https://v6.docs.ctr-electronics.com/en/stable/docs/migration/migration-guide/index.html.

If the Phoenix 5 API must be used for this device, the device must have 22.X firmware. This firmware is available in Tuner X after selecting Phoenix 5 in the firmware year dropdown.

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

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

~BaseStandardAnimation()

ctre::phoenix::led::BaseStandardAnimation::~BaseStandardAnimation

(

)

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.

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

brightness

The 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

reverseDirection

True 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:

• ctre/phoenix/led/BaseStandardAnimation.h