Gamedev Framework (gf)  0.3.0
A C++11 framework for 2D games
ColorRamp.h
1 /*
2  * Gamedev Framework (gf)
3  * Copyright (C) 2016 Julien Bernard
4  *
5  * This software is provided 'as-is', without any express or implied
6  * warranty. In no event will the authors be held liable for any damages
7  * arising from the use of this software.
8  *
9  * Permission is granted to anyone to use this software for any purpose,
10  * including commercial applications, and to alter it and redistribute it
11  * freely, subject to the following restrictions:
12  *
13  * 1. The origin of this software must not be misrepresented; you must not
14  * claim that you wrote the original software. If you use this software
15  * in a product, an acknowledgment in the product documentation would be
16  * appreciated but is not required.
17  * 2. Altered source versions must be plainly marked as such, and must not be
18  * misrepresented as being the original software.
19  * 3. This notice may not be removed or altered from any source distribution.
20  */
21 #ifndef GF_COLOR_RAMP_H
22 #define GF_COLOR_RAMP_H
23 
24 #include <map>
25 
26 #include "Portability.h"
27 #include "Vector.h"
28 
29 namespace gf {
30 #ifndef DOXYGEN_SHOULD_SKIP_THIS
31 inline namespace v1 {
32 #endif
33 
34  /**
35  * @ingroup graphics
36  * @brief A color ramp
37  *
38  *
39  * @sa gf::Color4f
40  */
41  struct GF_API ColorRamp {
42  public:
43  /**
44  * @brief Default constructor
45  *
46  * The color ramp is empty.
47  */
48  ColorRamp();
49 
50  /**
51  * @brief Check if the color ramp is empty
52  *
53  * @return True if the ramp is empty
54  */
55  bool isEmpty() const;
56 
57  /**
58  * @brief Add a color stop
59  *
60  * @param offset The offset of the color
61  * @param color The color
62  */
63  void addColorStop(float offset, const Color4f& color);
64 
65  /**
66  * @brief Compute a color from an offset
67  *
68  * @param offset The offset of the wanted color
69  * @return A color
70  */
71  Color4f computeColor(float offset) const;
72 
73  private:
74  float m_min;
75  float m_max;
76  std::map<float, Color4f> m_map;
77  };
78 
79 
80 #ifndef DOXYGEN_SHOULD_SKIP_THIS
81 }
82 #endif
83 }
84 
85 #endif // GF_COLOR_RAMP_H
A color ramp.
Definition: ColorRamp.h:41
bool isEmpty() const
Check if the color ramp is empty.
Color4f computeColor(float offset) const
Compute a color from an offset.
void addColorStop(float offset, const Color4f &color)
Add a color stop.
Definition: Action.h:34
#define GF_API
Definition: Portability.h:35
ColorRamp()
Default constructor.