ctre::phoenix::led::Animation Class Reference

The base class for all animations that CANdle supports. More...

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

Inheritance diagram for ctre::phoenix::led::Animation:

Public Member Functions
	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.
virtual BaseStandardAnimation *	GetBaseStandardAnimation ()=0
virtual BaseTwoSizeAnimation *	GetBaseTwoSizeAnimation ()=0
int	GetAnimationIdx ()
double	GetSpeed ()
int	GetNumLed ()
int	GetLedOffset ()

Detailed Description

The base class for all animations that CANdle supports.

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

Animation()

ctre::phoenix::led::Animation::Animation	(	int	idx,
		double	speed,
		int	numLed,
		int	ledOffset )

Constructor for an Animation class.

Parameters

idx	The animation-specific ID
speed	The rate at which the animation runs at. Higher is generally faster
numLed	The number of LEDs to run the animation on
ledOffset	Where to start the animation

~Animation()

virtual ctre::phoenix::led::Animation::~Animation ( )

virtual

Member Function Documentation

GetAnimationIdx()

int ctre::phoenix::led::Animation::GetAnimationIdx

(

)

GetBaseStandardAnimation()

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

pure virtual

Implemented in ctre::phoenix::led::BaseStandardAnimation, and ctre::phoenix::led::BaseTwoSizeAnimation.

GetBaseTwoSizeAnimation()

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

pure virtual

Implemented in ctre::phoenix::led::BaseStandardAnimation, and ctre::phoenix::led::BaseTwoSizeAnimation.

GetLedOffset()

int ctre::phoenix::led::Animation::GetLedOffset

(

)

GetNumLed()

int ctre::phoenix::led::Animation::GetNumLed

(

)

GetSpeed()

double ctre::phoenix::led::Animation::GetSpeed

(

)

SetLedOffset()

void ctre::phoenix::led::Animation::SetLedOffset

(

int

ledOffset

)

Sets where the animation starts along the strip.

Parameters

ledOffset

Where to start the animation along the strip

SetNumLed()

void ctre::phoenix::led::Animation::SetNumLed

(

int

numLed

)

Sets the number of LEDs the animation will run on.

Parameters

numLed

The number of LEDs to run the animation on

SetSpeed()

void ctre::phoenix::led::Animation::SetSpeed

(

double

speed

)

Sets the speed of the animation.

Parameters

speed

The rate at which the animation runs at. Higher is generally faster

---

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

• ctre/phoenix/led/Animation.h