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

#include <Animation.h>

Inherited by ctre::phoenix::led::BaseStandardAnimation, and ctre::phoenix::led::BaseTwoSizeAnimation.

Public Member Functions
	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 all animations that CANdle supports.

Constructor & Destructor Documentation

Animation()

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

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

Member Function Documentation

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:

• Phoenix-api/cpp/src/main/native/include/ctre/phoenix/led/Animation.h