Fesapi 2.9.0.1
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
resqml2::ContinuousColorMap Class Reference

Map of continuous colors. This class cannot be inherited. More...

#include <ContinuousColorMap.h>

Inheritance diagram for resqml2::ContinuousColorMap:
resqml2::AbstractColorMap

Public Member Functions

virtual ~ContinuousColorMap ()=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
 
uint64_t getColorCount () const final
 Gets color count.
 
gsoap_eml2_3::resqml22__InterpolationDomain getInterpolationDomain ()
 Gets interpolation domain.
 
std::string getInterpolationDomainAsString ()
 Gets interpolation domain as string.
 
gsoap_eml2_3::resqml22__InterpolationMethod getInterpolationMethod ()
 Gets interpolation method.
 
std::string getInterpolationMethodAsString ()
 Gets interpolation method as string.
 
std::string getXmlTag () const
 
- Public Member Functions inherited from resqml2::AbstractColorMap
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 ()
 

Static Public Attributes

static constexpr char const * XML_TAG = "ContinuousColorMap"
 The XML tag.
 

Detailed Description

Map of continuous colors. This class cannot be inherited.

Constructor & Destructor Documentation

◆ ~ContinuousColorMap()

virtual resqml2::ContinuousColorMap::~ContinuousColorMap ( )
virtualdefault

Destructor does nothing since the memory is managed by the gsoap context.

Member Function Documentation

◆ getColorCount()

uint64_t resqml2::ContinuousColorMap::getColorCount ( ) const
finalvirtual

Gets color count.

Returns
The color count.

Implements resqml2::AbstractColorMap.

◆ getInterpolationDomain()

gsoap_eml2_3::resqml22__InterpolationDomain resqml2::ContinuousColorMap::getInterpolationDomain ( )

Gets interpolation domain.

Returns
The interpolation domain.

◆ getInterpolationDomainAsString()

std::string resqml2::ContinuousColorMap::getInterpolationDomainAsString ( )

Gets interpolation domain as string.

Returns
The interpolation domain as string.

◆ getInterpolationMethod()

gsoap_eml2_3::resqml22__InterpolationMethod resqml2::ContinuousColorMap::getInterpolationMethod ( )

Gets interpolation method.

Returns
The interpolation method.

◆ getInterpolationMethodAsString()

std::string resqml2::ContinuousColorMap::getInterpolationMethodAsString ( )

Gets interpolation method as string.

Returns
The interpolation method as string.

◆ getXmlTag()

std::string resqml2::ContinuousColorMap::getXmlTag ( ) const
inline
Returns
The XML tag.

◆ setHsvColors()

void resqml2::ContinuousColorMap::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
colorCountthe size (number of colors) of the continuous color map
hsvColorsarray (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])
alphasarray (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.
colorTitlesvector (of size colorCount) of color titles. Titles are not set if colorTitles == nullptr (default value)
indicesarray (of size solorCount) of color indices. If indices == nullptr (default value), indices are set from 0 to colorCount - 1

Implements resqml2::AbstractColorMap.


The documentation for this class was generated from the following file: