Package com.ctre.phoenix.led

Class TwinkleAnimation

java.lang.Object

com.ctre.phoenix.led.Animation

com.ctre.phoenix.led.TwinkleAnimation

public class TwinkleAnimation
extends Animation

Animation that randomly turns LEDs on and off to a certain color

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TwinkleAnimation.TwinklePercent	The percentage of LEDs that are allowed to be on at any one point

Constructor Summary

Constructors

Constructor	Description
TwinkleAnimation(int r, int g, int b)	Constructor for a TwinkleAnimation
TwinkleAnimation(int r, int g, int b, int w, double speed, int numLed, TwinkleAnimation.TwinklePercent divider)	Constructor for a TwinkleAnimation

Method Summary

Modifier and Type	Method	Description
com.ctre.phoenix.led.BaseStandardAnimation	getBaseStandardAnimation()
com.ctre.phoenix.led.BaseTwoSizeAnimation	getBaseTwoSizeAnimation()
void	setB(int b)	Sets the B value of the LEDs
void	setDivider(TwinkleAnimation.TwinklePercent divider)	Sets the percentage of LEDs that are allowed on
void	setG(int g)	Sets the G value of the LEDs
void	setR(int r)	Sets the R value of the LEDs
void	setW(int w)	Sets the W value of the LEDs

Methods inherited from class com.ctre.phoenix.led.Animation

setNumLed, setSpeed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TwinkleAnimation

public TwinkleAnimation(int r,
 int g,
 int b,
 int w,
 double speed,
 int numLed,
 TwinkleAnimation.TwinklePercent divider)

Constructor for a TwinkleAnimation

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 the CANdle controls

divider - What percentage of LEDs can be on at any point

TwinkleAnimation

public TwinkleAnimation(int r,
 int g,
 int b)

Constructor for a TwinkleAnimation

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]

Method Details

setDivider

public void setDivider(TwinkleAnimation.TwinklePercent divider)

Sets the percentage of LEDs that are allowed on

Parameters:

divider - The percentage of LEDs that are allowed on at any point

setR

public void setR(int r)

Sets the R value of the LEDs

Parameters:

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

setG

public void setG(int g)

Sets the G value of the LEDs

Parameters:

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

setB

public void setB(int b)

Sets the B value of the LEDs

Parameters:

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

setW

public void setW(int w)

Sets the W value of the LEDs

Parameters:

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

getBaseStandardAnimation

public com.ctre.phoenix.led.BaseStandardAnimation getBaseStandardAnimation()

getBaseTwoSizeAnimation

public com.ctre.phoenix.led.BaseTwoSizeAnimation getBaseTwoSizeAnimation()