Animation that gradually lights the entire LED strip one LED at a time. More...

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

Inheritance diagram for ctre::phoenix::led::ColorFlowAnimation:

Public Types
enum	Direction { Forward = 0 , Backward = 1 }
	What direction does the color go. More...

Public Member Functions
	ColorFlowAnimation (int r, int g, int b, int w, double speed=1, int numLed=-1, Direction direction=Direction::Forward, int ledOffset=0)
	Constructor for a ColorFlowAnimation. More...

void	SetDirection (Direction direction)
	Sets the direction the color flow moves in. More...

Public Member Functions inherited from ctre::phoenix::led::BaseTwoSizeAnimation
	BaseTwoSizeAnimation (int idx, int r, int g, int b, int w, double speed, int numLed, int direction, int size, int ledOffset)
	Constructor for the BaseStandardAnimation object. More...

	~BaseTwoSizeAnimation ()

BaseStandardAnimation *	GetBaseStandardAnimation ()

BaseTwoSizeAnimation *	GetBaseTwoSizeAnimation ()

void	SetR (int r)
	Sets the R value of the LEDs. More...

void	SetG (int g)
	Sets the G value of the LEDs. More...

void	SetB (int b)
	Sets the B value of the LEDs. More...

void	SetW (int w)
	Sets the W value of the LEDs. More...

void	SetDirection (int direction)

void	SetSize (int size)

int	GetR ()

int	GetG ()

int	GetB ()

int	GetW ()

int	GetDirection ()

int	GetSize ()

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 BaseStandardAnimation *	GetBaseStandardAnimation ()=0

virtual BaseTwoSizeAnimation *	GetBaseTwoSizeAnimation ()=0

int	GetAnimationIdx ()

double	GetSpeed ()

int	GetNumLed ()

int	GetLedOffset ()

Detailed Description

Animation that gradually lights the entire LED strip one LED at a time.

Member Enumeration Documentation

◆ Direction

enum ctre::phoenix::led::ColorFlowAnimation::Direction

What direction does the color go.

Enumerator
Forward	Color goes forward, away from CANdle.
Backward	Color goes backward, toward CANdle.

Constructor & Destructor Documentation

◆ ColorFlowAnimation()

ctre::phoenix::led::ColorFlowAnimation::ColorFlowAnimation	(	int	r,
		int	g,
		int	b,
		int	w,
		double	speed = `1`,
		int	numLed = `-1`,
		Direction	direction = `Direction::Forward`,
		int	ledOffset = `0`
	)

Constructor for a ColorFlowAnimation.

Parameters

r	How much red should the color have [0, 255]
g	How much green should the color have [0, 255]
b	How much blue should the color have [0, 255]
w	How much white should the color have [0, 255]
speed	How fast should the color travel the strip [0, 1]
numLed	How many LEDs is the CANdle controlling
direction	What direction should the color move in
ledOffset	Where to start the animation

Member Function Documentation

◆ SetDirection()

void ctre::phoenix::led::ColorFlowAnimation::SetDirection ( Direction direction )

Sets the direction the color flow moves in.

Parameters

direction What direction should the color move in

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

ctre/phoenix/led/ColorFlowAnimation.h

Public Types