Map of discrete colors. This class cannot be inherited.
More...
#include <DiscreteColorMap.h>
|
| virtual | ~DiscreteColorMap ()=default |
| |
| void | setHsvColors (unsigned int colorCount, double const *hsvColors, double const *alphas=nullptr, std::vector< std::string > const &colorTitles=std::vector< std::string >(), double const *indices=nullptr) final |
| | https://en.wikipedia.org/wiki/HSV_color_space
|
| |
| uint64_t | getColorCount () const final |
| | Gets color count.
|
| |
| virtual std::string | getXmlTag () const |
| |
| void | setRgbColors (unsigned int colorCount, double const *rgbColors, double const *alphas=nullptr, std::vector< std::string > const &colorTitles=std::vector< std::string >(), double const *indices=nullptr) |
| |
| void | setRgbColors (unsigned int colorCount, unsigned int const *rgbColors, double const *alphas=nullptr, std::vector< std::string > const &colorTitles=std::vector< std::string >(), double const *indices=nullptr) |
| |
| double | getHue (double colorIndex) const |
| |
| double | getSaturation (double colorIndex) const |
| |
| double | getValue (double colorIndex) const |
| |
| double | getAlpha (double colorIndex) const |
| |
| void | getRgbColor (double colorIndex, double &red, double &green, double &blue) const |
| |
| void | getRgbColor (double colorIndex, unsigned int &red, unsigned int &green, unsigned int &blue) const |
| |
| bool | hasColorTitle (double colorIndex) const |
| | Queries if 'colorIndex' has color title.
|
| |
| std::string | getColorTitle (double colorIndex) const |
| | Gets color title.
|
| |
|
void | loadTargetRelationships () |
| |
Map of discrete colors. This class cannot be inherited.
◆ ~DiscreteColorMap()
| virtual resqml2::DiscreteColorMap::~DiscreteColorMap |
( |
| ) |
|
|
virtualdefault |
Destructor does nothing since the memory is managed by the gsoap context.
◆ getColorCount()
| uint64_t resqml2::DiscreteColorMap::getColorCount |
( |
| ) |
const |
|
finalvirtual |
◆ getXmlTag()
| virtual std::string resqml2::DiscreteColorMap::getXmlTag |
( |
| ) |
const |
|
inlinevirtual |
Get the standard XML tag without XML namespace for serializing this data object.
◆ setHsvColors()
| void resqml2::DiscreteColorMap::setHsvColors |
( |
unsigned int | colorCount, |
|
|
double const * | hsvColors, |
|
|
double const * | alphas = nullptr, |
|
|
std::vector< std::string > const & | colorTitles = std::vector< std::string >(), |
|
|
double const * | indices = nullptr ) |
|
finalvirtual |
https://en.wikipedia.org/wiki/HSV_color_space
- Parameters
-
| colorCount | the size (number of colors) of the discrete color map. |
| hsvColors | array (of size colorCount * 3) of HSV colors with hsvColors[3*i] is the hue, hsvColors[3*i + 1] is the saturation and hsvColors[3*i + 2] is the value of the ith color (hue is in range [0, 360] while saturation and value are in range [0, 1]) |
| alphas | (Optional) array (of size colorCount) of numeric values in the range [0, 1] for alpha transparency channel (0 means transparent and 1 means opaque). If alphas == nullptr (default value), default alpha value is 1. |
| colorTitles | (Optional) vector (of size colorCount) of color titles. Titles are not set if colorTitles == nullptr (default value) |
| indices | (Optional) array (of size solorCount) of color indices. These indices are cast to unsigned int in the case of a discrete color map. If indices == nullptr (default value), indices are set from 0 to colorCount - 1. |
Implements resqml2::AbstractColorMap.
◆ XML_TAG
| const char* resqml2::DiscreteColorMap::XML_TAG |
|
static |
The standard XML tag without XML namespace for serializing this data object.
The documentation for this class was generated from the following file:
Public Member Functions inherited from resqml2::AbstractColorMap