ctre::phoenix::led::BaseTwoSizeAnimation Class Reference

#include <BaseTwoSizeAnimation.h>

Inherits ctre::phoenix::led::Animation.

Inherited by ctre::phoenix::led::ColorFlowAnimation, ctre::phoenix::led::LarsonAnimation, ctre::phoenix::led::SingleFadeAnimation, ctre::phoenix::led::StrobeAnimation, ctre::phoenix::led::TwinkleAnimation, and ctre::phoenix::led::TwinkleOffAnimation.

Public Member Functions
	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

The base class for one generic type of animation. These animations do allow the user to specify a color.

Constructor & Destructor Documentation

BaseTwoSizeAnimation()

ctre::phoenix::led::BaseTwoSizeAnimation::BaseTwoSizeAnimation	(	int	idx,
		int	r,
		int	g,
		int	b,
		int	w,
		double	speed,
		int	numLed,
		int	direction,
		int	size
	)

Constructor for the BaseStandardAnimation object

Parameters

idx	The animation-specific ID
r	The amount of red to set, a value between [0, 255]
g	The amount of green to set, a value between [0, 255]
b	The amount of blue to set, a value between [0, 255]
w	The amount of white to set, a value between [0, 255]
speed	The rate at which the animation runs at. Higher is generally faster
numLed	The number of LEDs to run the animation on
direction	An animation-specific parameter for its direction
size	An animation-specific parameter for its size

Member Function Documentation

GetBaseStandardAnimation()

BaseStandardAnimation * ctre::phoenix::led::BaseTwoSizeAnimation::GetBaseStandardAnimation ( )

virtual

Implements ctre::phoenix::led::Animation.

GetBaseTwoSizeAnimation()

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

virtual

Implements ctre::phoenix::led::Animation.

SetB()

void ctre::phoenix::led::BaseTwoSizeAnimation::SetB

(

int

b

)

Sets the B value of the LEDs

Parameters

b	The amount of blue to set, a value between [0, 255]

SetG()

void ctre::phoenix::led::BaseTwoSizeAnimation::SetG

(

int

g

)

Sets the G value of the LEDs

Parameters

g	The amount of green to set, a value between [0, 255]

SetR()

void ctre::phoenix::led::BaseTwoSizeAnimation::SetR

(

int

r

)

Sets the R value of the LEDs

Parameters

r	The amount of red to set, a value between [0, 255]

SetW()

void ctre::phoenix::led::BaseTwoSizeAnimation::SetW

(

int

w

)

Sets the W value of the LEDs

Parameters

w	The amount of white to set, a value between [0, 255]

---

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

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