Color.hpp 2.98 KB
Newer Older
Mathieu Faverge's avatar
Mathieu Faverge committed
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
/*
** This file is part of the ViTE project.
**
** This software is governed by the CeCILL-A license under French law
** and abiding by the rules of distribution of free software. You can
** use, modify and/or redistribute the software under the terms of the
** CeCILL-A license as circulated by CEA, CNRS and INRIA at the following
** URL: "http://www.cecill.info".
** 
** As a counterpart to the access to the source code and rights to copy,
** modify and redistribute granted by the license, users are provided
** only with a limited warranty and the software's author, the holder of
** the economic rights, and the successive licensors have only limited
** liability.
** 
** In this respect, the user's attention is drawn to the risks associated
** with loading, using, modifying and/or developing or reproducing the
** software by the user in light of its specific status of free software,
** that may mean that it is complicated to manipulate, and that also
** therefore means that it is reserved for developers and experienced
** professionals having in-depth computer knowledge. Users are therefore
** encouraged to load and test the software's suitability as regards
** their requirements in conditions enabling the security of their
** systems and/or data to be ensured and, more generally, to use and
** operate it in the same conditions as regards security.
** 
** The fact that you are presently reading this means that you have had
** knowledge of the CeCILL-A license and that you accept its terms.
**
**
31
** ViTE developers are (for version 0.* to 1.0):
Mathieu Faverge's avatar
Mathieu Faverge committed
32
33
34
35
36
37
38
39
40
41
42
**
**        - COULOMB Kevin
**        - FAVERGE Mathieu
**        - JAZEIX Johnny
**        - LAGRASSE Olivier
**        - MARCOUEILLE Jule
**        - NOISETTE Pascal
**        - REDONDY Arthur
**        - VUCHENER Clément 
**
*/
43
44
45
46
47
#ifndef COLOR_HPP
#define COLOR_HPP

/*!
 *
48
 * \file Color.hpp
49
 *
50
51
52
53
54
 */
/*!
 *
 * \class Color
 * \brief Store a color in the trace
55
 *
56
57
58
59
60
61
62
 */
class Color: public Value {
private :
    double _r;
    double _g;
    double _b;

63
public:
64
65
66
    /*!
     *
     * \brief Constructor
67
     *
68
69
     */
    Color();
70

71
72
73
    /*!
     *
     * \brief Constructor
74
     *
75
76
     */
    Color(double, double, double);
77

78
79
    /*!
     *
Johnny Jazeix's avatar
Johnny Jazeix committed
80
     * \fn instantiate(const std::string &in, Color &out)
81
82
83
84
     * \brief Convert a string to a Color
     * \param in String to convert
     * \param out Color to be initialized
     * \return true, if the conversion succeeded
85
86
     *
     */
Johnny Jazeix's avatar
Johnny Jazeix committed
87
    static bool instantiate(const std::string &in, Color &out);
88

89
90
    /*!
     *
91
     * \fn to_string() const
92
     * \return a string of the color in the format "r g b".
93
94
     *
     */
95
    std::string to_string() const;
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
    
    /*!
     *
     * \fn get_red() const
     * \return red value
     *
     */
    double get_red() const;
    
    /*!
     *
     * \fn get_green() const;
     * \return green value
     *
     */
    double get_green() const;
    
    /*!
     *
     * \fn get_blue() const;
     * \return blue value
     *
     */
    double get_blue() const;
120

121
122
123
};

#endif // COLOR_HPP