AnimatedLEDStripCppArduino/Color_Container.h at master-devel · AnimatedLEDStrip/AnimatedLEDStripCppArduino · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
#ifndef _COLOR_CONTAINER_H_
#define _COLOR_CONTAINER_H_

using namespace std;

#include <FastLED.h>

/** ColorContainer class - holds three color values (r,g,b) used for a LED strip LED */

class ColorContainer {

    int
            r,                                            /**< Variable to store the red value for the LED */
            g,                                            /**< Variable to store the green value for the LED */
            b;                                            /**< Variable to store the blue value for the LED */

public:
    ColorContainer();                                // Default Constructor for ColorContainer (sets r, g, b to 0)
    ColorContainer(
            long hexIn);                    // Constructor for ColorContainer (sets r, g, b based on number received (usually 6-digit hexadecimal))
    ColorContainer(int rIn, int gIn,
                   int bIn);    // Constructor for ColorContainer (sets r, g, b to parameters received)
    ColorContainer(
            const CRGB &CRGBIn);            // Constructor for ColorContainer (sets r, g, b based on values in the CRGB received)


    void
            setr(int intensity),                        // Sets the r value of a ColorContainer instance
            setg(int intensity),                        // Sets the g value of a ColorContainer instance
            setb(int intensity),                        // Sets the b value of a ColorContainer instance
            setrgb(int rIn, int gIn, int bIn),        // Sets the r, g and b values of a ColorContainer instance
            setrgb(
            long hexIn),                        // Sets the r, g and b values of a ColorContainer instance using hexadecimal input
            setrgb(
            const CRGB &CRGBIn),                // Sets the r, g and b values of a ColorContainer instance to the r, g and b values in a CRGB instance
            blackout();                                    // Sets the r, g and b values of a ColorContainer instance to 0

    int
            getr(),                                        // Returns the r value of a ColorContainer instance
            getg(),                                        // Returns the g value of a ColorContainer instance
            getb();                                        // Returns the b value of a ColorContainer instance

    long
    getColorHex();                                // Returns the r, g and b values as a 6-digit hexadecimal number

};


#endif // _COLOR_CONTAINER_H_