FireAnimation

java.lang.Object

com.ctre.phoenix.led.Animation

com.ctre.phoenix.led.FireAnimation

public class FireAnimation extends Animation

Animation that looks similarly to a flame flickering

Constructor Summary

Constructors

Constructor

Description

FireAnimation()

Constructor for a FireAnimation.

FireAnimation(double brightness, double speed, int numLed, double sparking, double cooling)

Constructor for a FireAnimation
Method Summary

Modifier and Type

Method

Description

com.ctre.phoenix.led.BaseStandardAnimation

getBaseStandardAnimation()

com.ctre.phoenix.led.BaseTwoSizeAnimation

getBaseTwoSizeAnimation()

void

setBrightness(double brightness)

Sets the brightness of this animation

void

setCooling(double cooling)

Sets the cooling value of the FireAnimation

void

setSparking(double sparking)

Sets the sparking value of the FireAnimation

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
- FireAnimation
  
  public FireAnimation(double brightness, double speed, int numLed, double sparking, double cooling)
  
  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]
- FireAnimation
  
  public FireAnimation()
  
  Constructor for a FireAnimation. Call individual setters to tune the parameters further
Method Details
- setSparking
  
  public void setSparking(double sparking)
  
  Sets the sparking value of the FireAnimation
  
  Parameters:
  
  sparking - The rate at which the Fire "Sparks" [0, 1]
- setCooling
  
  public void setCooling(double cooling)
  
  Sets the cooling value of the FireAnimation
  
  Parameters:
  
  cooling - The rate at which the Fire "Cools" [0, 1]
- setBrightness
  
  public void setBrightness(double brightness)
  
  Sets the brightness of this animation
  
  Parameters:
  
  brightness - The brightness to run the animation at. This is a scalar from [0, 1]
- getBaseStandardAnimation
  
  public com.ctre.phoenix.led.BaseStandardAnimation getBaseStandardAnimation()
- getBaseTwoSizeAnimation
  
  public com.ctre.phoenix.led.BaseTwoSizeAnimation getBaseTwoSizeAnimation()