Public Member Functions
	FireAnimation (double brightness=1, double speed=1, int numLed=-1, double sparking=1, double cooling=1)

void	SetSparking (double sparking)

void	SetCooling (double cooling)

Public Member Functions inherited from ctre::phoenix::led::BaseStandardAnimation
	BaseStandardAnimation (int idx, double brightness, double speed, int numLed, double param4, double param5)

BaseStandardAnimation *	GetBaseStandardAnimation ()

BaseTwoSizeAnimation *	GetBaseTwoSizeAnimation ()

void	SetBrightness (double brightness)

void	SetParam4 (double param4)

void	SetParam5 (double param5)

double	GetBrightness ()

double	GetParam4 ()

double	GetParam5 ()

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 looks similarly to a flame flickering

Constructor & Destructor Documentation

ctre::phoenix::led::FireAnimation::FireAnimation	(	double	brightness = `1`,
		double	speed = `1`,
		int	numLed = `-1`,
		double	sparking = `1`,
		double	cooling = `1`
	)

Constructor for a FireAnimation

Parameters

brightness	How bright should the animation be [0, 1]
speed	How fast will the flame be processed at [0, 1]
numLed	How many LEDs is the CANdle controlling
sparking	The rate at which the Fire "Sparks" [0, 1]
cooling	The rate at which the Fire "Cools" along the travel [0, 1]

void ctre::phoenix::led::FireAnimation::SetCooling ( double cooling )

Sets the cooling value of the FireAnimation

Parameters

cooling The rate at which the Fire "Cools" [0, 1]

void ctre::phoenix::led::FireAnimation::SetSparking ( double sparking )

Sets the sparking value of the FireAnimation

Parameters

sparking The rate at which the Fire "Sparks" [0, 1]

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