CTRE Phoenix C++ 5.33.1
RainbowAnimation.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 creates a rainbow throughout all the LEDs
10 */
12public:
13 /**
14 * Constructor for a RainbowAnimation
15 * @param brightness The brightness of the LEDs [0, 1]
16 * @param speed How fast the rainbow travels through the leds [0, 1]
17 * @param numLed How many LEDs are controlled by the CANdle
18 * @param reverseDirection True to reverse the animation direction, so instead of going "toward" the CANdle, it will go "away" from the CANdle.
19 * @param ledOffset Where to start the animation
20 */
21 RainbowAnimation(double brightness = 1, double speed = 1, int numLed = -1, bool reverseDirection = false, int ledOffset = 0);
22};
23
24} // namespace led
25} // namespace phoenix
26} // namespace ctre
The base class for one generic type of animation.
Definition: BaseStandardAnimation.h:12
Animation that creates a rainbow throughout all the LEDs.
Definition: RainbowAnimation.h:11
RainbowAnimation(double brightness=1, double speed=1, int numLed=-1, bool reverseDirection=false, int ledOffset=0)
Constructor for a RainbowAnimation.
namespace ctre
Definition: paramEnum.h:5