CTRE Phoenix C++ 5.33.1
FireAnimation.h
Go to the documentation of this file.
1/* Copyright (C) Cross The Road Electronics 2024 */
2#pragma once
3
5
6namespace ctre {namespace phoenix {namespace led {
7
8/**
9 * Animation that looks similarly to a flame flickering
10 */
12public:
13 /**
14 * Constructor for a FireAnimation
15 * @param brightness How bright should the animation be [0, 1]
16 * @param speed How fast will the flame be processed at [0, 1]
17 * @param numLed How many LEDs is the CANdle controlling
18 * @param sparking The rate at which the Fire "Sparks" [0, 1]
19 * @param cooling The rate at which the Fire "Cools" along the travel [0, 1]
20 * @param reverseDirection True to reverse the animation direction, so instead of fire going "away" from the CANdle, it will go "toward" the CANdle.
21 * @param ledOffset Where to start the animation
22 */
23 FireAnimation(double brightness = 1, double speed = 1, int numLed = -1, double sparking = 1, double cooling = 1, bool reverseDirection = false, int ledOffset = 0);
24 /**
25 * Sets the sparking value of the FireAnimation
26 * @param sparking The rate at which the Fire "Sparks" [0, 1]
27 */
28 void SetSparking(double sparking);
29 /**
30 * Sets the cooling value of the FireAnimation
31 * @param cooling The rate at which the Fire "Cools" [0, 1]
32 */
33 void SetCooling(double cooling);
34};
35
36} // namespace led
37} // namespace phoenix
38} // namespace ctre
The base class for one generic type of animation.
Definition: BaseStandardAnimation.h:12
Animation that looks similarly to a flame flickering.
Definition: FireAnimation.h:11
FireAnimation(double brightness=1, double speed=1, int numLed=-1, double sparking=1, double cooling=1, bool reverseDirection=false, int ledOffset=0)
Constructor for a FireAnimation.
void SetCooling(double cooling)
Sets the cooling value of the FireAnimation.
void SetSparking(double sparking)
Sets the sparking value of the FireAnimation.
namespace ctre
Definition: paramEnum.h:5