Public Types
enum	BounceMode { Front = 0 , Center = 1 , Back = 2 }

Public Member Functions
	LarsonAnimation (int r, int g, int b, int w=0, double speed=1, int numLed=-1, BounceMode mode=BounceMode::Front, int size=2)

void	SetBounceMode (BounceMode mode)

void	SetSize (int size)

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)

BaseStandardAnimation *	GetBaseStandardAnimation ()

BaseTwoSizeAnimation *	GetBaseTwoSizeAnimation ()

void	SetR (int r)

void	SetG (int g)

void	SetB (int b)

void	SetW (int w)

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)

void	SetSpeed (double speed)

void	SetNumLed (int numLed)

virtual BaseStandardAnimation *	GetBaseStandardAnimation ()=0

virtual BaseTwoSizeAnimation *	GetBaseTwoSizeAnimation ()=0

int	GetAnimationIdx ()

double	GetSpeed ()

int	GetNumLed ()

Detailed Description

Animation that sends a pocket of light across the LED strip.

Member Enumeration Documentation

How the pocket of light behaves when it reaches the end of the strip

Enumerator
Front	Bounce the pocket as soon as the first LED reaches the end of the strip
Center	Bounce the pocket once it is midway through the end of the strip
Back	Bounce the pocket once all the LEDs are off the strip

ctre::phoenix::led::LarsonAnimation::LarsonAnimation	(	int	r,
		int	g,
		int	b,
		int	w = `0`,
		double	speed = `1`,
		int	numLed = `-1`,
		BounceMode	mode = `BounceMode::Front`,
		int	size = `2`
	)

Constructor for a LarsonAnimation

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	The number of LEDs the CANdle will control
mode	How the pocket of LEDs will behave once it reaches the end of the strip
size	How large the pocket of LEDs are [0, 7]

void ctre::phoenix::led::LarsonAnimation::SetBounceMode ( BounceMode mode )

Sets the bounce mode of the animation.

Parameters

mode	How the pocket of LEDs will behave once it reaches the end of the strip

void ctre::phoenix::led::LarsonAnimation::SetSize ( int size )

Sets the size of the pocket of LEDs

Parameters

size	The size of the pocket [0, 7]

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