if a class is derived from this class, it may use color bars More...

#include <jkqtpimagetools.h>

Inheritance diagram for JKQTPColorPaletteStyleAndToolsMixin:

Collaboration diagram for JKQTPColorPaletteStyleAndToolsMixin:

Public Member Functions
	JKQTPColorPaletteStyleAndToolsMixin (JKQTBasePlotter *parent)

virtual	~JKQTPColorPaletteStyleAndToolsMixin ()

virtual void	cbDrawOutside (JKQTPEnhancedPainter &painter, QRect leftSpace, QRect rightSpace, QRect topSpace, QRect bottomSpace)
	plots outside the actual plot field of view (e.g. color bars, scale bars, ...)

virtual void	cbGetDataMinMax (double &imin, double &imax)=0
	determine min/max data value of the image

virtual void	cbGetOutsideSize (JKQTPEnhancedPainter &painter, int &leftSpace, int &rightSpace, int &topSpace, int &bottomSpace)
	if the graph plots outside the actual plot field of view (e.g. color bars, scale bars, ...)

virtual void	cbSetParent (JKQTBasePlotter *parent)
	set the parent class for internal objects (e.g. color bars)

JKQTPMathImageColorRangeFailAction	getActionRangeMaxFail () const
	which action to take if a color is above imageMax and autoImageRange `==false`

JKQTPMathImageColorRangeFailAction	getActionRangeMinFail () const
	which action to take if a color is below imageMin and autoImageRange `==false`

bool	getAutoImageRange () const
	indicates whether to estimate min/max of the image automatically

int	getColorBarOffset () const
	offset between outside space border and color bar

double	getColorBarRelativeHeight () const
	height of the color bar, as multiple of plotHeight

JKQTPVerticalIndependentAxis *	getColorBarRightAxis ()
	object used for color bar axes at the right

const JKQTPVerticalIndependentAxis *	getColorBarRightAxis () const
	object used for color bar axes at the right

bool	getColorBarRightVisible () const
	right color bar visible

JKQTPHorizontalIndependentAxis *	getColorBarTopAxis ()
	object used for color bar axes at the top

const JKQTPHorizontalIndependentAxis *	getColorBarTopAxis () const
	object used for color bar axes at the top

bool	getColorBarTopVisible () const
	top color bar visible

int	getColorBarWidth () const
	width of the color bar

JKQTPMathImageColorPalette	getColorPalette () const
	palette for plotting an image

double	getImageMax () const
	image value range maximum

double	getImageMin () const
	image value range minimum

QString	getImageName () const
	name of the image displayed above color bar (may contain LaTeX markup!)

QString	getImageNameFontName () const
	font name when displaying imageName

double	getImageNameFontSize () const
	font size in points when displaying imageName

QColor	getInfColor () const
	color to use for an infinity value

QColor	getNanColor () const
	color to use for a not-a-number value

QColor	getRangeMaxFailColor () const
	color to use for some settings of rangeMaxFailAction

QColor	getRangeMinFailColor () const
	color to use for some settings of rangeMinFailAction

bool	getShowColorBar () const
	indicate whether to display a color bar

void	setAutoImageRange (bool __value)
	indicates whether to estimate min/max of the image automatically

void	setColorBarOffset (int __value)
	offset between outside space border and color bar

void	setColorBarRelativeHeight (double __value)
	height of the color bar, as multiple of plotHeight

void	setColorBarRightVisible (bool __value)
	right color bar visible

void	setColorBarTopVisible (bool __value)
	top color bar visible

void	setColorBarWidth (int __value)
	width of the color bar

void	setColorPalette (const JKQTPMathImageColorPalette &__value)
	palette for plotting an image

void	setColorPalette (int pal)
	palette for plotting an image

void	setImageMax (double __value)
	image value range maximum

void	setImageMin (double __value)
	image value range minimum

void	setImageName (const QString &__value)
	name of the image displayed above color bar (may contain LaTeX markup!)

void	setImageNameFontName (const QString &__value)
	font name when displaying imageName

void	setImageNameFontSize (double __value)
	font size in points when displaying imageName

void	setInfColor (const QColor &__value)
	color to use for an infinity value

void	setNanColor (const QColor &__value)
	color to use for a not-a-number value

void	setRangeMaxFailAction (const JKQTPMathImageColorRangeFailAction &__value)
	which action to take if a color is above imageMax and autoImageRange `==false`

void	setRangeMaxFailColor (const QColor &__value)
	color to use for some settings of rangeMaxFailAction

void	setRangeMinFailAction (const JKQTPMathImageColorRangeFailAction &__value)
	which action to take if a color is below imageMin and autoImageRange `==false`

void	setRangeMinFailColor (const QColor &__value)
	color to use for some settings of rangeMinFailAction

void	setShowColorBar (bool __value)
	indicate whether to display a color bar

Static Public Member Functions
static QIcon	getPaletteIcon (int i)
	get QIcon representing the given palette

static QIcon	getPaletteIcon (JKQTPMathImageColorPalette palette)
	get QIcon representing the given palette

static QImage	getPaletteImage (int i, size_t width)
	get QIcon representing the given palette

static QImage	getPaletteImage (JKQTPMathImageColorPalette palette, size_t width)
	get QIcon representing the given palette

static QIcon	getPaletteKeyIcon (int i)
	get QIcon representing the given palette

static QIcon	getPaletteKeyIcon (JKQTPMathImageColorPalette palette)
	get QIcon representing the given palette

static QImage	getPaletteKeyImage (int i, size_t width, size_t height)
	get QIcon representing the given palette

static QImage	getPaletteKeyImage (JKQTPMathImageColorPalette palette, size_t width, size_t height)
	get QIcon representing the given palette

static QStringList	getPalettes ()
	get list with all available palettes

static int	getPalettesCount ()
	get list with all available palettes

Protected Attributes
bool	autoImageRange
	indicates whether to estimate min/max of the image automatically

JKQTBasePlotter *	cbParent

int	colorBarOffset
	offset between outside space border and color bar

double	colorBarRelativeHeight
	height of the color bar, as multiple of plotHeight

JKQTPVerticalIndependentAxis *	colorBarRightAxis
	object used for color bar axes at the right

bool	colorBarRightVisible
	right color bar visible

JKQTPHorizontalIndependentAxis *	colorBarTopAxis
	object used for color bar axes at the top

bool	colorBarTopVisible
	top color bar visible

int	colorBarWidth
	width of the color bar

double	imageMax
	image value range maximum

double	imageMin
	image value range minimum

QString	imageName
	name of the image displayed above color bar (may contain LaTeX markup!)

QString	imageNameFontName
	font name when displaying imageName

double	imageNameFontSize
	font size in points when displaying imageName

QColor	infColor
	color to use for an infinity value

QColor	nanColor
	color to use for a not-a-number value

JKQTPMathImageColorPalette	palette
	palette for plotting an image

JKQTPMathImageColorRangeFailAction	rangeMaxFailAction
	which action to take if a color is above imageMax and autoImageRange `==false`

QColor	rangeMaxFailColor
	color to use for some settings of rangeMaxFailAction

JKQTPMathImageColorRangeFailAction	rangeMinFailAction
	which action to take if a color is below imageMin and autoImageRange `==false`

QColor	rangeMinFailColor
	color to use for some settings of rangeMinFailAction

bool	showColorBar
	indicate whether to display a color bar

Detailed Description

if a class is derived from this class, it may use color bars

Constructor & Destructor Documentation

◆ JKQTPColorPaletteStyleAndToolsMixin()

JKQTPColorPaletteStyleAndToolsMixin::JKQTPColorPaletteStyleAndToolsMixin ( JKQTBasePlotter * parent )

◆ ~JKQTPColorPaletteStyleAndToolsMixin()

virtual JKQTPColorPaletteStyleAndToolsMixin::~JKQTPColorPaletteStyleAndToolsMixin ( )

virtual

Member Function Documentation

◆ cbDrawOutside()

virtual void JKQTPColorPaletteStyleAndToolsMixin::cbDrawOutside	(	JKQTPEnhancedPainter &	painter,
		QRect	leftSpace,
		QRect	rightSpace,
		QRect	topSpace,
		QRect	bottomSpace
	)

virtual

plots outside the actual plot field of view (e.g. color bars, scale bars, ...)

Note: If you want to draw outside, then you'll also have to implement getOutsideSize(), so enough space is reserved

The four value supplied tell the method where to draw (inside one of the rectangles).

Reimplemented in JKQTPColorPaletteWithModifierStyleAndToolsMixin.

◆ cbGetDataMinMax()

virtual void JKQTPColorPaletteStyleAndToolsMixin::cbGetDataMinMax	(	double &	imin,
		double &	imax
	)

pure virtual

determine min/max data value of the image

Implemented in JKQTPMathImage, JKQTPXYParametrizedScatterGraph, and JKQTPParametrizedVectorFieldGraph.

◆ cbGetOutsideSize()

virtual void JKQTPColorPaletteStyleAndToolsMixin::cbGetOutsideSize	(	JKQTPEnhancedPainter &	painter,
		int &	leftSpace,
		int &	rightSpace,
		int &	topSpace,
		int &	bottomSpace
	)

virtual

if the graph plots outside the actual plot field of view (e.g. color bars, scale bars, ...)

Note: If you want to draw outside, then you'll also have to implement drawOutside()

Reimplemented in JKQTPColorPaletteWithModifierStyleAndToolsMixin.

◆ cbSetParent()

virtual void JKQTPColorPaletteStyleAndToolsMixin::cbSetParent ( JKQTBasePlotter * parent )

virtual

set the parent class for internal objects (e.g. color bars)

Reimplemented in JKQTPColorPaletteWithModifierStyleAndToolsMixin.

◆ getActionRangeMaxFail()

JKQTPMathImageColorRangeFailAction JKQTPColorPaletteStyleAndToolsMixin::getActionRangeMaxFail ( ) const

which action to take if a color is above imageMax and autoImageRange ==false

◆ getActionRangeMinFail()

JKQTPMathImageColorRangeFailAction JKQTPColorPaletteStyleAndToolsMixin::getActionRangeMinFail ( ) const

which action to take if a color is below imageMin and autoImageRange ==false

◆ getAutoImageRange()

bool JKQTPColorPaletteStyleAndToolsMixin::getAutoImageRange ( ) const

indicates whether to estimate min/max of the image automatically

◆ getColorBarOffset()

int JKQTPColorPaletteStyleAndToolsMixin::getColorBarOffset ( ) const

offset between outside space border and color bar

◆ getColorBarRelativeHeight()

double JKQTPColorPaletteStyleAndToolsMixin::getColorBarRelativeHeight ( ) const

height of the color bar, as multiple of plotHeight

◆ getColorBarRightAxis() [1/2]

JKQTPVerticalIndependentAxis * JKQTPColorPaletteStyleAndToolsMixin::getColorBarRightAxis ( )

object used for color bar axes at the right

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarRightAxis() [2/2]

const JKQTPVerticalIndependentAxis * JKQTPColorPaletteStyleAndToolsMixin::getColorBarRightAxis ( ) const

object used for color bar axes at the right

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarRightVisible()

bool JKQTPColorPaletteStyleAndToolsMixin::getColorBarRightVisible ( ) const

right color bar visible

◆ getColorBarTopAxis() [1/2]

JKQTPHorizontalIndependentAxis * JKQTPColorPaletteStyleAndToolsMixin::getColorBarTopAxis ( )

object used for color bar axes at the top

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarTopAxis() [2/2]

const JKQTPHorizontalIndependentAxis * JKQTPColorPaletteStyleAndToolsMixin::getColorBarTopAxis ( ) const

object used for color bar axes at the top

Note: this axis has some kind of a special role. It is used to format color bar axes

◆ getColorBarTopVisible()

bool JKQTPColorPaletteStyleAndToolsMixin::getColorBarTopVisible ( ) const

top color bar visible

◆ getColorBarWidth()

int JKQTPColorPaletteStyleAndToolsMixin::getColorBarWidth ( ) const

width of the color bar

◆ getColorPalette()

JKQTPMathImageColorPalette JKQTPColorPaletteStyleAndToolsMixin::getColorPalette ( ) const

palette for plotting an image

◆ getImageMax()

double JKQTPColorPaletteStyleAndToolsMixin::getImageMax ( ) const

image value range maximum

◆ getImageMin()

double JKQTPColorPaletteStyleAndToolsMixin::getImageMin ( ) const

image value range minimum

◆ getImageName()

QString JKQTPColorPaletteStyleAndToolsMixin::getImageName ( ) const

name of the image displayed above color bar (may contain LaTeX markup!)

◆ getImageNameFontName()

QString JKQTPColorPaletteStyleAndToolsMixin::getImageNameFontName ( ) const

font name when displaying imageName

◆ getImageNameFontSize()

double JKQTPColorPaletteStyleAndToolsMixin::getImageNameFontSize ( ) const

font size in points when displaying imageName

◆ getInfColor()

QColor JKQTPColorPaletteStyleAndToolsMixin::getInfColor ( ) const

color to use for an infinity value

◆ getNanColor()

QColor JKQTPColorPaletteStyleAndToolsMixin::getNanColor ( ) const

color to use for a not-a-number value