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

The base class for one generic type of animation. More...

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

Inheritance diagram for ctre::phoenix::led::BaseTwoSizeAnimation:

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

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,
		int	ledOffset
	)

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
ledOffset	Where to start the animation

~BaseTwoSizeAnimation()

ctre::phoenix::led::BaseTwoSizeAnimation::~BaseTwoSizeAnimation

(

)

Member Function Documentation

GetB()

int ctre::phoenix::led::BaseTwoSizeAnimation::GetB

(

)

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.

GetDirection()

int ctre::phoenix::led::BaseTwoSizeAnimation::GetDirection

(

)

GetG()

int ctre::phoenix::led::BaseTwoSizeAnimation::GetG

(

)

GetR()

int ctre::phoenix::led::BaseTwoSizeAnimation::GetR

(

)

GetSize()

int ctre::phoenix::led::BaseTwoSizeAnimation::GetSize

(

)

GetW()

int ctre::phoenix::led::BaseTwoSizeAnimation::GetW

(

)

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]

SetDirection()

void ctre::phoenix::led::BaseTwoSizeAnimation::SetDirection

(

int

direction

)

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]

SetSize()

void ctre::phoenix::led::BaseTwoSizeAnimation::SetSize

(

int

size

)

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:

• ctre/phoenix/led/BaseTwoSizeAnimation.h