itom  4.1.0
ito::ItomPaletteBase Class Reference

Public Member Functions

 ItomPaletteBase (const QString &name, const char type)
 
 ItomPaletteBase (const QString &name, const char type, const QColor &invCol1, const QColor &invCol2, const QColor &invalCol, const QVector< QGradientStop > &colStops)
 
 ItomPaletteBase (const QString &name, const char type, const QColor &start, const QColor &stop)
 
 ItomPaletteBase (const ItomPaletteBase &src)
 
QString getName () const
 
bool setName (const QString &name)
 
int getNumColorStops () const
 
int getType () const
 
double getPosFirst () const
 
double getPosLast () const
 
double getPos (unsigned int color) const
 Get the position of the n-th color-stop in the palette. More...
 
bool setInverseColorOne (const QColor &color)
 Set the first inverse color for this color bar. More...
 
QColor getInverseColorOne () const
 
bool setInverseColorTwo (const QColor &color)
 Set the second inverse color for this color bar. More...
 
QColor getInverseColorTwo () const
 
bool setInvalidColor (const QColor &color)
 Set the invalid color for this color bar. More...
 
QColor getInvalidColor () const
 Get the invalid color for this color bar. More...
 
int findUpper (double pos) const
 Find the next color stop and its values within this palette. More...
 
QVector< QPair< double, QColor > > getColorStops (void) const
 
bool setColorStops (const QVector< QPair< double, QColor > > &colorStops)
 
QColor getColor (unsigned int index) const
 Get the RGBA-Color of the n-th color-stop in the palette. More...
 
ItomPalette getPalette () const
 This function returns the internal structur of the palette. More...
 
bool isWriteProtected () const
 
void setWriteProtection ()
 
void removeWriteProtection ()
 
bool insertColorStop (double pos, const QColor &color)
 Insert a new color stop into the palette defined by color and position. More...
 
QVector< ito::uint32 > get256Colors (bool includeAlpha=false) const
 Transform the color stops to a 256 color vector. More...
 

Private Attributes

ItomPalette m_paletteData
 

Member Function Documentation

int ito::ItomPaletteBase::findUpper ( double  pos) const
inline

Find the next color stop and its values within this palette.

The palette itself is based on a small set of color stops. Between this stops, the color is linear interpolated. This function is used to give the next valid color stop for a position to allow such an interpolation.

Parameters
posthe position within the palette
Returns
int the index of the next color stop
QVector< ito::uint32 > ito::ItomPaletteBase::get256Colors ( bool  includeAlpha = false) const

Transform the color stops to a 256 color vector.

Transform the color stops to a 256 color vector

Parameters
updateInverseColorsrecalculate the ideals inverse color
QColor ito::ItomPaletteBase::getColor ( unsigned int  index) const

Get the RGBA-Color of the n-th color-stop in the palette.

This function returns the position (doubel value) of the color stop devined by int color

Parameters
indexindex of the color stop, whose color is returned
Returns
QColor the RGBA-Color of the color stop
QColor ito::ItomPaletteBase::getInvalidColor ( ) const

Get the invalid color for this color bar.

Each colorbar has a invalid color for inf and NaN values

Parameters
colornew color as QColor value
Returns
bool the invalid color or if not defined the first colorStop or else black
ItomPalette ito::ItomPaletteBase::getPalette ( ) const

This function returns the internal structur of the palette.

This function returns the internal structur of the palette

double ito::ItomPaletteBase::getPos ( unsigned int  color) const

Get the position of the n-th color-stop in the palette.

This function returns the position (doubel value) of the color stop devined by int color

Parameters
colorindex of the color to retrieve
Returns
double position of the color stop
bool ito::ItomPaletteBase::insertColorStop ( double  pos,
const QColor &  color 
)

Insert a new color stop into the palette defined by color and position.

The palette itself is based on a small set of color stops. Between this stops, the color is linear interpolated.

Parameters
posthe position within the palette
colornew color as QColor value
Returns
bool true if success
bool ito::ItomPaletteBase::setInvalidColor ( const QColor &  color)

Set the invalid color for this color bar.

Each colorbar has a invalid color for inf and NaN values

Parameters
colornew color as QColor value
Returns
bool true if success
bool ito::ItomPaletteBase::setInverseColorOne ( const QColor &  color)

Set the first inverse color for this color bar.

Each colorbar has 2 inverse colors to highlight lines, cursers ...

Parameters
colornew color as QColor value
Returns
bool true if success
bool ito::ItomPaletteBase::setInverseColorTwo ( const QColor &  color)

Set the second inverse color for this color bar.

Each colorbar has 2 inverse colors to highlight lines, cursers ...

Parameters
colornew color as QColor value
Returns
bool true if success

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