QWT API (English) 7.3.0
Qt Widget Library for Technical Applications - English API Documentation
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
QwtSaturationValueColorMap Class Reference

QwtSaturationValueColorMap varies the saturation and/or value for a given hue in the HSV color model. More...

#include <qwt_colormap.h>

Inheritance diagram for QwtSaturationValueColorMap:
QwtColorMap

Classes

class  PrivateData
 

Public Member Functions

 QwtSaturationValueColorMap ()
 Constructor.
 
void setHue (int hue)
 Set the hue coordinate.
 
void setSaturationInterval (int sat1, int sat2)
 Set the interval for the saturation coordinate.
 
void setValueInterval (int value1, int value2)
 Set the interval for the value coordinate.
 
void setAlpha (int alpha)
 Set the alpha coordinate.
 
int hue () const
 Return hue coordinate.
 
int saturation1 () const
 Return first saturation coordinate.
 
int saturation2 () const
 Return second saturation coordinate.
 
int value1 () const
 Return first value coordinate.
 
int value2 () const
 Return second value coordinate.
 
int alpha () const
 Return alpha coordinate.
 
virtual QRgb rgb (double vMin, double vMax, double value) const override
 Map a value of a given interval into a RGB value.
 
- Public Member Functions inherited from QwtColorMap
 QwtColorMap (Format=QwtColorMap::RGB)
 Constructor.
 
virtual ~QwtColorMap ()
 Destructor.
 
void setFormat (Format)
 Set the format of the color map.
 
Format format () const
 
virtual uint colorIndex (int numColors, double vMin, double vMax, double value) const
 Map a value of a given interval into a color index.
 
QColor color (double vMin, double vMax, double value) const
 
virtual QVector< QRgb > colorTable (int numColors) const
 Build and return a color map of arbitrary number of colors.
 
virtual QVector< QRgb > colorTable256 () const
 Build and return a color map of 256 colors.
 

Additional Inherited Members

- Public Types inherited from QwtColorMap
enum  Format { RGB , Indexed }
 Format for color mapping. More...
 

Detailed Description

QwtSaturationValueColorMap varies the saturation and/or value for a given hue in the HSV color model.

Value and saturation are in the range of 0 to 255 while hue is in the range of 0 to 359.

See also
QwtHueColorMap

Constructor & Destructor Documentation

◆ QwtSaturationValueColorMap()

QwtSaturationValueColorMap::QwtSaturationValueColorMap ( )

Constructor.

The value interval is initialized by 0 to 255, saturation by 255 to 255. Hue to 0 and alpha to 255. So the default setting interpolates the value coordinate only.

See also
setHue(), setSaturationInterval(), setValueInterval(), setAlpha()

Member Function Documentation

◆ alpha()

int QwtSaturationValueColorMap::alpha ( ) const

Return alpha coordinate.

Returns
Alpha coordinate.
See also
setAlpha()

◆ hue()

int QwtSaturationValueColorMap::hue ( ) const

Return hue coordinate.

Returns
Hue coordinate.
See also
setHue()

◆ rgb()

QRgb QwtSaturationValueColorMap::rgb ( double  vMin,
double  vMax,
double  value 
) const
overridevirtual

Map a value of a given interval into a RGB value.

Parameters
[in]vMinMinimum of the value interval.
[in]vMaxMaximum of the value interval.
[in]valueValue to map into a RGB value.
Returns
RGB value for value.

Implements QwtColorMap.

◆ saturation1()

int QwtSaturationValueColorMap::saturation1 ( ) const

Return first saturation coordinate.

Returns
First saturation coordinate.
See also
setSaturationInterval()

◆ saturation2()

int QwtSaturationValueColorMap::saturation2 ( ) const

Return second saturation coordinate.

Returns
Second saturation coordinate.
See also
setSaturationInterval()

◆ setAlpha()

void QwtSaturationValueColorMap::setAlpha ( int  alpha)

Set the alpha coordinate.

alpha needs to be in the range 0 to 255, where 255 means opaque and 0 means transparent.

Parameters
[in]alphaAlpha coordinate.
See also
alpha()

◆ setHue()

void QwtSaturationValueColorMap::setHue ( int  hue)

Set the hue coordinate.

Hue coordinates outside 0 to 359 will be interpreted as hue % 360.

Parameters
[in]hueHue coordinate.
See also
hue()

◆ setSaturationInterval()

void QwtSaturationValueColorMap::setSaturationInterval ( int  saturation1,
int  saturation2 
)

Set the interval for the saturation coordinate.

When saturation1 == saturation2 the map interpolates between the value coordinates only. saturation1/saturation2 need to be in the range 0 to 255.

Parameters
[in]saturation1First saturation.
[in]saturation2Second saturation.
See also
saturation1(), saturation2(), setValueInterval()

◆ setValueInterval()

void QwtSaturationValueColorMap::setValueInterval ( int  value1,
int  value2 
)

Set the interval for the value coordinate.

When value1 == value2 the map interpolates between the saturation coordinates only. value1/value2 need to be in the range 0 to 255.

Parameters
[in]value1First value.
[in]value2Second value.
See also
value1(), value2(), setSaturationInterval()

◆ value1()

int QwtSaturationValueColorMap::value1 ( ) const

Return first value coordinate.

Returns
First value coordinate.
See also
setValueInterval()

◆ value2()

int QwtSaturationValueColorMap::value2 ( ) const

Return second value coordinate.

Returns
Second value coordinate.
See also
setValueInterval()

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