Associates colors to a range of values. More...
#include <codac_ColorMap.h>
Collaboration diagram for codac::ColorMap:
Public Member Functions | |
| ColorMap (InterpolMode interpol_mode=InterpolMode::RGB) | |
| Creates a color map. More... | |
| ~ColorMap () | |
| ColorMap destructor. | |
| const ColorMap & | operator= (const ColorMap &x) |
| Returns a copy of a ColorMap. More... | |
| void | add_color_point (rgb color, float index) |
| Adds a RGB color point to the map. More... | |
| void | add_color_point (hsv color, float index) |
| Adds a HSV color point to the map. More... | |
| void | reverse () |
| Reverses the keys of the color map. | |
| void | set_opacity (float alpha) |
| Sets a constant opacity to all colors of the map. More... | |
| bool | is_opaque () const |
Returns true of all colors are opaque. More... | |
| rgb | color (double r) const |
| Evaluates the color map at \(r\), \(r\in[0,1]\). More... | |
| rgb | color (double t, const Trajectory &f) const |
| Evaluates the color map at \(f(t)\), \(t\in[t_0,t_f]\). More... | |
| void | displayColorMap (const std::string &fig_name="Color map") const |
| Creates a VIBesFig with the colors of the map. More... | |
Static Public Attributes | |
| static const ColorMap | HAXBY |
| predefined HAXBY color map (mainly used for DEM) | |
| static const ColorMap | DEFAULT |
| a predefined default color map | |
| static const ColorMap | BLUE_TUBE |
| a predefined color map for tubes | |
| static const ColorMap | RED_TUBE |
| a predefined color map for tubes | |
| static const ColorMap | RAINBOW |
| a predefined color map | |
Protected Attributes | |
| InterpolMode | m_interpol_mode = InterpolMode::RGB |
| interpolation mode | |
| std::map< float, rgb > | m_colormap |
| map of colors | |
Detailed Description
Associates colors to a range of values.
Constructor & Destructor Documentation
◆ ColorMap()
| codac::ColorMap::ColorMap | ( | InterpolMode | interpol_mode = InterpolMode::RGB | ) |
Creates a color map.
- Parameters
-
interpol_mode mode defining in which color space the color interpolation will be made (RGB by default)
Member Function Documentation
◆ operator=()
◆ add_color_point() [1/2]
| void codac::ColorMap::add_color_point | ( | rgb | color, |
| float | index | ||
| ) |
Adds a RGB color point to the map.
- Parameters
-
color RGB color to be added index key associated to the color (any float value)
◆ add_color_point() [2/2]
| void codac::ColorMap::add_color_point | ( | hsv | color, |
| float | index | ||
| ) |
Adds a HSV color point to the map.
- Parameters
-
color HSV color to be added index key associated to the color (any float value)
◆ set_opacity()
| void codac::ColorMap::set_opacity | ( | float | alpha | ) |
Sets a constant opacity to all colors of the map.
- Parameters
-
alpha opacity value, between 0. (transparent) and 1. (opaque)
◆ is_opaque()
| bool codac::ColorMap::is_opaque | ( | ) | const |
Returns true of all colors are opaque.
- Returns
- opacity test of the map
◆ color() [1/2]
| rgb codac::ColorMap::color | ( | double | r | ) | const |
Evaluates the color map at \(r\), \(r\in[0,1]\).
If r is not a key of the map, an interpolation is made to compute the corresponding color, according to the selected mode.
- Parameters
-
r input, between 0 and 1
- Returns
- an RGB color
◆ color() [2/2]
| rgb codac::ColorMap::color | ( | double | t, |
| const Trajectory & | f | ||
| ) | const |
Evaluates the color map at \(f(t)\), \(t\in[t_0,t_f]\).
If \(f(t)\) is not a key of the map, an interpolation is made to compute the corresponding color, according to the selected mode.
- Parameters
-
t input, between 0 and 1 f the trajectory function
- Returns
- an RGB color
◆ displayColorMap()
| void codac::ColorMap::displayColorMap | ( | const std::string & | fig_name = "Color map" | ) | const |
Creates a VIBesFig with the colors of the map.
- Parameters
-
fig_name a reference to the figure that will be displayed in the window's title
The documentation for this class was generated from the following file:
- /home/simon/codac/src/core/graphics/codac_ColorMap.h
