A plottable representing a two-dimensional color map in a plot. More...

#include <qcustomplot.h>

Inheritance diagram for QCPColorMap:

[legend]

Collaboration diagram for QCPColorMap:

[legend]

Signals
void	dataRangeChanged (const QCPRange &newRange)

void	dataScaleTypeChanged (QCPAxis::ScaleType scaleType)

void	gradientChanged (const QCPColorGradient &newGradient)

void	dataRangeChanged (QCPRange newRange)

void	dataScaleTypeChanged (QCPAxis::ScaleType scaleType)

void	gradientChanged (QCPColorGradient newGradient)

Signals inherited from QCPAbstractPlottable
void	selectionChanged (bool selected)

void	selectionChanged (const QCPDataSelection &selection)

void	selectableChanged (QCP::SelectionType selectable)

void	selectionChanged (bool selected)

void	selectableChanged (bool selectable)

Signals inherited from QCPLayerable
void	layerChanged (QCPLayer *newLayer)

void	layerChanged (QCPLayer *newLayer)

Public Member Functions
	QCPColorMap (QCPAxis keyAxis, QCPAxis valueAxis)

virtual	~QCPColorMap ()

QCPColorMapData *	data () const

QCPRange	dataRange () const

QCPAxis::ScaleType	dataScaleType () const

bool	interpolate () const

bool	tightBoundary () const

QCPColorGradient	gradient () const

QCPColorScale *	colorScale () const

void	setData (QCPColorMapData *data, bool copy=false)

Q_SLOT void	setDataRange (const QCPRange &dataRange)

Q_SLOT void	setDataScaleType (QCPAxis::ScaleType scaleType)

Q_SLOT void	setGradient (const QCPColorGradient &gradient)

void	setInterpolate (bool enabled)

void	setTightBoundary (bool enabled)

void	setColorScale (QCPColorScale *colorScale)

void	rescaleDataRange (bool recalculateDataBounds=false)

Q_SLOT void	updateLegendIcon (Qt::TransformationMode transformMode=Qt::SmoothTransformation, const QSize &thumbSize=QSize(32, 18))

virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const

virtual QCPRange	getKeyRange (bool &foundRange, QCP::SignDomain inSignDomain=QCP::sdBoth) const

virtual QCPRange	getValueRange (bool &foundRange, QCP::SignDomain inSignDomain=QCP::sdBoth, const QCPRange &inKeyRange=QCPRange()) const

	QCPColorMap (QCPAxis keyAxis, QCPAxis valueAxis)

virtual	~QCPColorMap ()

QCPColorMapData *	data () const

QCPRange	dataRange () const

QCPAxis::ScaleType	dataScaleType () const

bool	interpolate () const

bool	tightBoundary () const

QCPColorGradient	gradient () const

QCPColorScale *	colorScale () const

void	setData (QCPColorMapData *data, bool copy=false)

Q_SLOT void	setDataRange (const QCPRange &dataRange)

Q_SLOT void	setDataScaleType (QCPAxis::ScaleType scaleType)

Q_SLOT void	setGradient (const QCPColorGradient &gradient)

void	setInterpolate (bool enabled)

void	setTightBoundary (bool enabled)

void	setColorScale (QCPColorScale *colorScale)

void	rescaleDataRange (bool recalculateDataBounds=false)

Q_SLOT void	updateLegendIcon (Qt::TransformationMode transformMode=Qt::SmoothTransformation, const QSize &thumbSize=QSize(32, 18))

virtual void	clearData ()

virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const

Public Member Functions inherited from QCPAbstractPlottable
	QCPAbstractPlottable (QCPAxis keyAxis, QCPAxis valueAxis)

virtual	~QCPAbstractPlottable ()

QString	name () const

bool	antialiasedFill () const

bool	antialiasedScatters () const

QPen	pen () const

QBrush	brush () const

QCPAxis *	keyAxis () const

QCPAxis *	valueAxis () const

QCP::SelectionType	selectable () const

bool	selected () const

QCPDataSelection	selection () const

QCPSelectionDecorator *	selectionDecorator () const

void	setName (const QString &name)

void	setAntialiasedFill (bool enabled)

void	setAntialiasedScatters (bool enabled)

void	setPen (const QPen &pen)

void	setBrush (const QBrush &brush)

void	setKeyAxis (QCPAxis *axis)

void	setValueAxis (QCPAxis *axis)

Q_SLOT void	setSelectable (QCP::SelectionType selectable)

Q_SLOT void	setSelection (QCPDataSelection selection)

void	setSelectionDecorator (QCPSelectionDecorator *decorator)

virtual QCPPlottableInterface1D *	interface1D ()

void	coordsToPixels (double key, double value, double &x, double &y) const

const QPointF	coordsToPixels (double key, double value) const

void	pixelsToCoords (double x, double y, double &key, double &value) const

void	pixelsToCoords (const QPointF &pixelPos, double &key, double &value) const

void	rescaleAxes (bool onlyEnlarge=false) const

void	rescaleKeyAxis (bool onlyEnlarge=false) const

void	rescaleValueAxis (bool onlyEnlarge=false, bool inKeyRange=false) const

bool	addToLegend (QCPLegend *legend)

bool	addToLegend ()

bool	removeFromLegend (QCPLegend *legend) const

bool	removeFromLegend () const

	QCPAbstractPlottable (QCPAxis keyAxis, QCPAxis valueAxis)

QString	name () const

bool	antialiasedFill () const

bool	antialiasedScatters () const

bool	antialiasedErrorBars () const

QPen	pen () const

QPen	selectedPen () const

QBrush	brush () const

QBrush	selectedBrush () const

QCPAxis *	keyAxis () const

QCPAxis *	valueAxis () const

bool	selectable () const

bool	selected () const

void	setName (const QString &name)

void	setAntialiasedFill (bool enabled)

void	setAntialiasedScatters (bool enabled)

void	setAntialiasedErrorBars (bool enabled)

void	setPen (const QPen &pen)

void	setSelectedPen (const QPen &pen)

void	setBrush (const QBrush &brush)

void	setSelectedBrush (const QBrush &brush)

void	setKeyAxis (QCPAxis *axis)

void	setValueAxis (QCPAxis *axis)

Q_SLOT void	setSelectable (bool selectable)

Q_SLOT void	setSelected (bool selected)

virtual bool	addToLegend ()

virtual bool	removeFromLegend () const

void	rescaleAxes (bool onlyEnlarge=false) const

void	rescaleKeyAxis (bool onlyEnlarge=false) const

void	rescaleValueAxis (bool onlyEnlarge=false) const

Public Member Functions inherited from QCPLayerable
	QCPLayerable (QCustomPlot plot, QString targetLayer=QString(), QCPLayerable parentLayerable=0)

virtual	~QCPLayerable ()

bool	visible () const

QCustomPlot *	parentPlot () const

QCPLayerable *	parentLayerable () const

QCPLayer *	layer () const

bool	antialiased () const

void	setVisible (bool on)

Q_SLOT bool	setLayer (QCPLayer *layer)

bool	setLayer (const QString &layerName)

void	setAntialiased (bool enabled)

bool	realVisibility () const

	QCPLayerable (QCustomPlot plot, QString targetLayer=QString(), QCPLayerable parentLayerable=0)

	~QCPLayerable ()

bool	visible () const

QCustomPlot *	parentPlot () const

QCPLayerable *	parentLayerable () const

QCPLayer *	layer () const

bool	antialiased () const

void	setVisible (bool on)

Q_SLOT bool	setLayer (QCPLayer *layer)

bool	setLayer (const QString &layerName)

void	setAntialiased (bool enabled)

bool	realVisibility () const

Protected Member Functions
virtual void	updateMapImage ()

virtual void	draw (QCPPainter *painter)

virtual void	drawLegendIcon (QCPPainter *painter, const QRectF &rect) const

virtual void	updateMapImage ()

virtual void	draw (QCPPainter *painter)

virtual void	drawLegendIcon (QCPPainter *painter, const QRectF &rect) const

virtual QCPRange	getKeyRange (bool &foundRange, SignDomain inSignDomain=sdBoth) const

virtual QCPRange	getValueRange (bool &foundRange, SignDomain inSignDomain=sdBoth) const

Protected Member Functions inherited from QCPAbstractPlottable
virtual QRect	clipRect () const

virtual QCP::Interaction	selectionCategory () const

void	applyDefaultAntialiasingHint (QCPPainter *painter) const

virtual void	selectEvent (QMouseEvent event, bool additive, const QVariant &details, bool selectionStateChanged)

virtual void	deselectEvent (bool *selectionStateChanged)

void	applyFillAntialiasingHint (QCPPainter *painter) const

void	applyScattersAntialiasingHint (QCPPainter *painter) const

virtual QRect	clipRect () const

virtual QCP::Interaction	selectionCategory () const

void	applyDefaultAntialiasingHint (QCPPainter *painter) const

virtual void	selectEvent (QMouseEvent event, bool additive, const QVariant &details, bool selectionStateChanged)

virtual void	deselectEvent (bool *selectionStateChanged)

void	coordsToPixels (double key, double value, double &x, double &y) const

const QPointF	coordsToPixels (double key, double value) const

void	pixelsToCoords (double x, double y, double &key, double &value) const

void	pixelsToCoords (const QPointF &pixelPos, double &key, double &value) const

QPen	mainPen () const

QBrush	mainBrush () const

void	applyFillAntialiasingHint (QCPPainter *painter) const

void	applyScattersAntialiasingHint (QCPPainter *painter) const

void	applyErrorBarsAntialiasingHint (QCPPainter *painter) const

double	distSqrToLine (const QPointF &start, const QPointF &end, const QPointF &point) const

Protected Member Functions inherited from QCPLayerable
virtual void	parentPlotInitialized (QCustomPlot *parentPlot)

virtual void	mousePressEvent (QMouseEvent *event, const QVariant &details)

virtual void	mouseMoveEvent (QMouseEvent *event, const QPointF &startPos)

virtual void	mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos)

virtual void	mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details)

virtual void	wheelEvent (QWheelEvent *event)

void	initializeParentPlot (QCustomPlot *parentPlot)

void	setParentLayerable (QCPLayerable *parentLayerable)

bool	moveToLayer (QCPLayer *layer, bool prepend)

void	applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const

virtual void	parentPlotInitialized (QCustomPlot *parentPlot)

void	initializeParentPlot (QCustomPlot *parentPlot)

void	setParentLayerable (QCPLayerable *parentLayerable)

bool	moveToLayer (QCPLayer *layer, bool prepend)

void	applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const

Protected Attributes
QCPRange	mDataRange

QCPAxis::ScaleType	mDataScaleType

QCPColorMapData *	mMapData

QCPColorGradient	mGradient

bool	mInterpolate

bool	mTightBoundary

QPointer< QCPColorScale >	mColorScale

QImage	mMapImage

QImage	mUndersampledMapImage

QPixmap	mLegendIcon

bool	mMapImageInvalidated

Protected Attributes inherited from QCPAbstractPlottable
QString	mName

bool	mAntialiasedFill

bool	mAntialiasedScatters

QPen	mPen

QBrush	mBrush

QPointer< QCPAxis >	mKeyAxis

QPointer< QCPAxis >	mValueAxis

QCP::SelectionType	mSelectable

QCPDataSelection	mSelection

QCPSelectionDecorator *	mSelectionDecorator

bool	mAntialiasedErrorBars

QPen	mSelectedPen

QBrush	mSelectedBrush

bool	mSelectable

bool	mSelected

Protected Attributes inherited from QCPLayerable
bool	mVisible

QCustomPlot *	mParentPlot

QPointer< QCPLayerable >	mParentLayerable

QCPLayer *	mLayer

bool	mAntialiased

Additional Inherited Members
Protected Types inherited from QCPAbstractPlottable
enum	SignDomain { sdNegative , sdBoth , sdPositive }

Detailed Description

A plottable representing a two-dimensional color map in a plot.

The data is stored in the class QCPColorMapData, which can be accessed via the data() method.

A color map has three dimensions to represent a data point: The key dimension, the value dimension and the data dimension. As with other plottables such as graphs, key and value correspond to two orthogonal axes on the QCustomPlot surface that you specify in the QCPColorMap constructor. The data dimension however is encoded as the color of the point at (key, value).

Set the number of points (or cells) in the key/value dimension via QCPColorMapData::setSize. The plot coordinate range over which these points will be displayed is specified via QCPColorMapData::setRange. The first cell will be centered on the lower range boundary and the last cell will be centered on the upper range boundary. The data can be set by either accessing the cells directly with QCPColorMapData::setCell or by addressing the cells via their plot coordinates with QCPColorMapData::setData. If possible, you should prefer setCell, since it doesn't need to do any coordinate transformation and thus performs a bit better.

The cell with index (0, 0) is at the bottom left, if the color map uses normal (i.e. not reversed) key and value axes.

To show the user which colors correspond to which data values, a QCPColorScale is typically placed to the right of the axis rect. See the documentation there for details on how to add and use a color scale.

Changing the appearance

The central part of the appearance is the color gradient, which can be specified via setGradient. See the documentation of QCPColorGradient for details on configuring a color gradient.

The data range that is mapped to the colors of the gradient can be specified with setDataRange. To make the data range encompass the whole data set minimum to maximum, call rescaleDataRange.

Transparency

Transparency in color maps can be achieved by two mechanisms. On one hand, you can specify alpha values for color stops of the QCPColorGradient, via the regular QColor interface. This will cause the color map data which gets mapped to colors around those color stops to appear with the accordingly interpolated transparency.

On the other hand you can also directly apply an alpha value to each cell independent of its data, by using the alpha map feature of QCPColorMapData. The relevant methods are QCPColorMapData::setAlpha, QCPColorMapData::fillAlpha and QCPColorMapData::clearAlpha().

The two transparencies will be joined together in the plot and otherwise not interfere with each other. They are mixed in a multiplicative matter, so an alpha of e.g. 50% (128/255) in both modes simultaneously, will result in a total transparency of 25% (64/255).

Usage

Like all data representing objects in QCustomPlot, the QCPColorMap is a plottable (QCPAbstractPlottable). So the plottable-interface of QCustomPlot applies (QCustomPlot::plottable, QCustomPlot::removePlottable, etc.)

Usually, you first create an instance:

which registers it with the QCustomPlot instance of the passed axes. Note that this QCustomPlot instance takes ownership of the plottable, so do not delete it manually but use QCustomPlot::removePlottable() instead. The newly created plottable can be modified, e.g.:

Note: The QCPColorMap always displays the data at equal key/value intervals, even if the key or value axis is set to a logarithmic scaling. If you want to use QCPColorMap with logarithmic axes, you shouldn't use the QCPColorMapData::setData method as it uses a linear transformation to determine the cell index. Rather directly access the cell index with QCPColorMapData::setCell.

The data is stored in the class QCPColorMapData, which can be accessed via the data() method.

A color map has three dimensions to represent a data point: The key dimension, the value dimension and the data dimension. As with other plottables such as graphs, key and value correspond to two orthogonal axes on the QCustomPlot surface that you specify in the QColorMap constructor. The data dimension however is encoded as the color of the point at (key, value).

Set the number of points (or cells) in the key/value dimension via QCPColorMapData::setSize. The plot coordinate range over which these points will be displayed is specified via QCPColorMapData::setRange. The first cell will be centered on the lower range boundary and the last cell will be centered on the upper range boundary. The data can be set by either accessing the cells directly with QCPColorMapData::setCell or by addressing the cells via their plot coordinates with QCPColorMapData::setData. If possible, you should prefer setCell, since it doesn't need to do any coordinate transformation and thus performs a bit better.

The cell with index (0, 0) is at the bottom left, if the color map uses normal (i.e. not reversed) key and value axes.

To show the user which colors correspond to which data values, a QCPColorScale is typically placed to the right of the axis rect. See the documentation there for details on how to add and use a color scale.

Changing the appearance

The central part of the appearance is the color gradient, which can be specified via setGradient. See the documentation of QCPColorGradient for details on configuring a color gradient.

The data range that is mapped to the colors of the gradient can be specified with setDataRange. To make the data range encompass the whole data set minimum to maximum, call rescaleDataRange.

Usage

Like all data representing objects in QCustomPlot, the QCPColorMap is a plottable (QCPAbstractPlottable). So the plottable-interface of QCustomPlot applies (QCustomPlot::plottable, QCustomPlot::addPlottable, QCustomPlot::removePlottable, etc.)

Usually, you first create an instance and add it to the customPlot:

and then modify the properties of the newly created color map, e.g.:

Note: The QCPColorMap always displays the data at equal key/value intervals, even if the key or value axis is set to a logarithmic scaling. If you want to use QCPColorMap with logarithmic axes, you shouldn't use the QCPColorMapData::setData method as it uses a linear transformation to determine the cell index. Rather directly access the cell index with QCPColorMapData::setCell.

Definition at line 6784 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPColorMap() [1/2]

QCPColorMap::QCPColorMap	(	QCPAxis *	keyAxis,
		QCPAxis *	valueAxis
	)

explicit

Constructs a color map with the specified keyAxis and valueAxis.

The created QCPColorMap is automatically registered with the QCustomPlot instance inferred from keyAxis. This QCustomPlot instance takes ownership of the QCPColorMap, so do not delete it manually but use QCustomPlot::removePlottable() instead.

Constructs a color map with the specified keyAxis and valueAxis.

The constructed QCPColorMap can be added to the plot with QCustomPlot::addPlottable, QCustomPlot then takes ownership of the color map.

Definition at line 27278 of file qcustomplot.cpp.

◆ ~QCPColorMap() [1/2]

QCPColorMap::~QCPColorMap ( )

virtual

Definition at line 27287 of file qcustomplot.cpp.

References mMapData.

◆ QCPColorMap() [2/2]

QCPColorMap::QCPColorMap	(	QCPAxis *	keyAxis,
		QCPAxis *	valueAxis
	)

explicit

◆ ~QCPColorMap() [2/2]

virtual QCPColorMap::~QCPColorMap ( )

virtual

Member Function Documentation

◆ clearData()

void QCPColorMap::clearData ( )

virtual

Clears the colormap data by calling QCPColorMapData::clear() on the internal data. This also resizes the map to 0x0 cells.

Implements QCPAbstractPlottable.

Definition at line 21399 of file qcustomplot.cpp.

References QCPColorMapData::clear(), and mMapData.

◆ colorScale() [1/2]

QCPColorScale* QCPColorMap::colorScale ( ) const

inline

Definition at line 6808 of file qcustomplot.h.

Referenced by setColorScale().

◆ colorScale() [2/2]

QCPColorScale* QCPColorMap::colorScale ( ) const

inline

Definition at line 3686 of file qcustomplot.h.

◆ data() [1/2]

QCPColorMapData * QCPColorMap::data ( ) const

inline

Returns a pointer to the internal data storage of type QCPColorMapData. Access this to modify data points (cells) and the color map key/value range.

See also: setData

Definition at line 6802 of file qcustomplot.h.

Referenced by setData(), and updateLegendIcon().

◆ data() [2/2]

QCPColorMapData* QCPColorMap::data ( ) const

inline

Definition at line 3680 of file qcustomplot.h.

◆ dataRange() [1/2]

QCPRange QCPColorMap::dataRange ( ) const

inline

Definition at line 6803 of file qcustomplot.h.

Referenced by setDataRange().

◆ dataRange() [2/2]

QCPRange QCPColorMap::dataRange ( ) const

inline

Definition at line 3681 of file qcustomplot.h.

◆ dataRangeChanged [1/2]

void QCPColorMap::dataRangeChanged ( const QCPRange & newRange )

signal

This signal is emitted when the data range changes.

See also: setDataRange

Referenced by setColorScale(), and setDataRange().

◆ dataRangeChanged [2/2]

void QCPColorMap::dataRangeChanged ( QCPRange newRange )

signal

This signal is emitted when the data range changes.

See also: setDataRange

◆ dataScaleType() [1/2]

QCPAxis::ScaleType QCPColorMap::dataScaleType ( ) const

inline

Definition at line 6804 of file qcustomplot.h.

◆ dataScaleType() [2/2]

QCPAxis::ScaleType QCPColorMap::dataScaleType ( ) const

inline

Definition at line 3682 of file qcustomplot.h.

◆ dataScaleTypeChanged [1/2]

void QCPColorMap::dataScaleTypeChanged ( QCPAxis::ScaleType scaleType )

signal

This signal is emitted when the data scale type changes.

See also: setDataScaleType

Referenced by setColorScale(), and setDataScaleType().

◆ dataScaleTypeChanged [2/2]

void QCPColorMap::dataScaleTypeChanged ( QCPAxis::ScaleType scaleType )

signal

◆ draw() [1/2]

void QCPColorMap::draw ( QCPPainter * painter )

protectedvirtual

◆ draw() [2/2]

virtual void QCPColorMap::draw ( QCPPainter * painter )

protectedvirtual

Implements QCPAbstractPlottable.

◆ drawLegendIcon() [1/2]

void QCPColorMap::drawLegendIcon	(	QCPPainter *	painter,
		const QRectF &	rect
	)		const

protectedvirtual

Implements QCPAbstractPlottable.

Definition at line 27842 of file qcustomplot.cpp.

References QCPAbstractPlottable::applyDefaultAntialiasingHint(), and mLegendIcon.

◆ drawLegendIcon() [2/2]

virtual void QCPColorMap::drawLegendIcon	(	QCPPainter *	painter,
		const QRectF &	rect
	)		const

protectedvirtual

Implements QCPAbstractPlottable.

◆ getKeyRange() [1/2]

QCPRange QCPColorMap::getKeyRange	(	bool &	foundRange,
		QCP::SignDomain	inSignDomain = `QCP::sdBoth`
	)		const

virtual

Returns the coordinate range that all data in this plottable span in the key axis dimension. For logarithmic plots, one can set inSignDomain to either QCP::sdNegative or QCP::sdPositive in order to restrict the returned range to that sign domain. E.g. when only negative range is wanted, set inSignDomain to QCP::sdNegative and all positive points will be ignored for range calculation. For no restriction, just set inSignDomain to QCP::sdBoth (default). foundRange is an output parameter that indicates whether a range could be found or not. If this is false, you shouldn't use the returned range (e.g. no points in data).

Note that foundRange is not the same as QCPRange::validRange, since the range returned by this function may have size zero (e.g. when there is only one data point). In this case foundRange would return true, but the returned range is not a valid range in terms of QCPRange::validRange.

See also: rescaleAxes, getValueRange

Implements QCPAbstractPlottable.

Definition at line 27552 of file qcustomplot.cpp.

References e, QCPColorMapData::keyRange(), mMapData, result, QCP::sdNegative, and QCP::sdPositive.

◆ getKeyRange() [2/2]

QCPRange QCPColorMap::getKeyRange	(	bool &	foundRange,
		SignDomain	inSignDomain = `sdBoth`
	)		const

protectedvirtual

Implements QCPAbstractPlottable.

Definition at line 21658 of file qcustomplot.cpp.

References e, QCPColorMapData::keyRange(), mMapData, result, QCPAbstractPlottable::sdNegative, and QCPAbstractPlottable::sdPositive.

◆ getValueRange() [1/2]

QCPRange QCPColorMap::getValueRange	(	bool &	foundRange,
		QCP::SignDomain	inSignDomain = `QCP::sdBoth`,
		const QCPRange &	inKeyRange = `QCPRange()`
	)		const

virtual

Returns the coordinate range that the data points in the specified key range (inKeyRange) span in the value axis dimension. For logarithmic plots, one can set inSignDomain to either QCP::sdNegative or QCP::sdPositive in order to restrict the returned range to that sign domain. E.g. when only negative range is wanted, set inSignDomain to QCP::sdNegative and all positive points will be ignored for range calculation. For no restriction, just set inSignDomain to QCP::sdBoth (default). foundRange is an output parameter that indicates whether a range could be found or not. If this is false, you shouldn't use the returned range (e.g. no points in data).

If inKeyRange has both lower and upper bound set to zero (is equal to QCPRange()), all data points are considered, without any restriction on the keys.

Note that foundRange is not the same as QCPRange::validRange, since the range returned by this function may have size zero (e.g. when there is only one data point). In this case foundRange would return true, but the returned range is not a valid range in terms of QCPRange::validRange.

See also: rescaleAxes, getKeyRange

Implements QCPAbstractPlottable.

Definition at line 27572 of file qcustomplot.cpp.

References e, QCPColorMapData::keyRange(), QCPRange::lower, mMapData, result, QCP::sdNegative, QCP::sdPositive, QCPRange::upper, and QCPColorMapData::valueRange().

◆ getValueRange() [2/2]

QCPRange QCPColorMap::getValueRange	(	bool &	foundRange,
		SignDomain	inSignDomain = `sdBoth`
	)		const

protectedvirtual

called by rescaleAxes functions to get the full data value bounds. For logarithmic plots, one can set inSignDomain to either sdNegative or sdPositive in order to restrict the returned range to that sign domain. E.g. when only negative range is wanted, set inSignDomain to sdNegative and all positive points will be ignored for range calculation. For no restriction, just set inSignDomain to sdBoth (default). foundRange is an output parameter that indicates whether a range could be found or not. If this is false, you shouldn't use the returned range (e.g. no points in data).

Note that foundRange is not the same as QCPRange::validRange, since the range returned by this function may have size zero, which wouldn't count as a valid range.

See also: rescaleAxes, getKeyRange

Implements QCPAbstractPlottable.

Definition at line 21678 of file qcustomplot.cpp.

References e, mMapData, result, QCPAbstractPlottable::sdNegative, QCPAbstractPlottable::sdPositive, and QCPColorMapData::valueRange().

◆ gradient() [1/2]

QCPColorGradient QCPColorMap::gradient ( ) const

inline

Definition at line 6807 of file qcustomplot.h.

Referenced by setGradient().

◆ gradient() [2/2]

QCPColorGradient QCPColorMap::gradient ( ) const

inline

Definition at line 3685 of file qcustomplot.h.

◆ gradientChanged [1/2]

void QCPColorMap::gradientChanged ( const QCPColorGradient & newGradient )

signal

This signal is emitted when the gradient changes.

See also: setGradient

Referenced by setColorScale(), and setGradient().

◆ gradientChanged [2/2]

void QCPColorMap::gradientChanged ( QCPColorGradient newGradient )

signal

This signal is emitted when the gradient changes.

See also: setGradient

◆ interpolate() [1/2]

bool QCPColorMap::interpolate ( ) const

inline

Definition at line 6805 of file qcustomplot.h.

◆ interpolate() [2/2]

bool QCPColorMap::interpolate ( ) const

inline

Definition at line 3683 of file qcustomplot.h.

◆ rescaleDataRange() [1/2]

void QCPColorMap::rescaleDataRange ( bool recalculateDataBounds = false )

Sets the data range (setDataRange) to span the minimum and maximum values that occur in the current data set. This corresponds to the rescaleKeyAxis or rescaleValueAxis methods, only for the third data dimension of the color map.

The minimum and maximum values of the data set are buffered in the internal QCPColorMapData instance (data). As data is updated via its QCPColorMapData::setCell or QCPColorMapData::setData, the buffered minimum and maximum values are updated, too. For performance reasons, however, they are only updated in an expanding fashion. So the buffered maximum can only increase and the buffered minimum can only decrease. In consequence, changes to the data that actually lower the maximum of the data set (by overwriting the cell holding the current maximum with a smaller value), aren't recognized and the buffered maximum overestimates the true maximum of the data set. The same happens for the buffered minimum. To recalculate the true minimum and maximum by explicitly looking at each cell, the method QCPColorMapData::recalculateDataBounds can be used. For convenience, setting the parameter recalculateDataBounds calls this method before setting the data range to the buffered minimum and maximum.

See also: setDataRange

Definition at line 27484 of file qcustomplot.cpp.

References QCPColorMapData::dataBounds(), mMapData, QCPColorMapData::recalculateDataBounds(), and setDataRange().

◆ rescaleDataRange() [2/2]

void QCPColorMap::rescaleDataRange ( bool recalculateDataBounds = false )

◆ selectTest() [1/2]

double QCPColorMap::selectTest	(	const QPointF &	pos,
		bool	onlySelectable,
		QVariant *	details = `0`
	)		const

virtual

This function is used to decide whether a click hits a layerable object or not.

pos is a point in pixel coordinates on the QCustomPlot surface. This function returns the shortest pixel distance of this point to the object. If the object is either invisible or the distance couldn't be determined, -1.0 is returned. Further, if onlySelectable is true and the object is not selectable, -1.0 is returned, too.

If the object is represented not by single lines but by an area like a QCPItemText or the bars of a QCPBars plottable, a click inside the area should also be considered a hit. In these cases this function thus returns a constant value greater zero but still below the parent plot's selection tolerance. (typically the selectionTolerance multiplied by 0.99).

Providing a constant value for area objects allows selecting line objects even when they are obscured by such area objects, by clicking close to the lines (i.e. closer than 0.99*selectionTolerance).

The actual setting of the selection state is not done by this function. This is handled by the parent QCustomPlot when the mouseReleaseEvent occurs, and the finally selected object is notified via the selectEvent/ deselectEvent methods.

details is an optional output parameter. Every layerable subclass may place any information in details. This information will be passed to selectEvent when the parent QCustomPlot decides on the basis of this selectTest call, that the object was successfully selected. The subsequent call to selectEvent will carry the details. This is useful for multi-part objects (like QCPAxis). This way, a possibly complex calculation to decide which part was clicked is only done once in selectTest. The result (i.e. the actually clicked part) can then be placed in details. So in the subsequent selectEvent, the decision which part was selected doesn't have to be done a second time for a single selection operation.

In the case of 1D Plottables (QCPAbstractPlottable1D, like QCPGraph or QCPBars) details will be set to a QCPDataSelection, describing the closest data point to pos.

You may pass 0 as details to indicate that you are not interested in those selection details.

See also: selectEvent, deselectEvent, mousePressEvent, wheelEvent, QCustomPlot::setInteractions, QCPAbstractPlottable1D::selectTestRect

This function is used to decide whether a click hits a layerable object or not.

pos is a point in pixel coordinates on the QCustomPlot surface. This function returns the shortest pixel distance of this point to the object. If the object is either invisible or the distance couldn't be determined, -1.0 is returned. Further, if onlySelectable is true and the object is not selectable, -1.0 is returned, too.

If the object is represented not by single lines but by an area like a QCPItemText or the bars of a QCPBars plottable, a click inside the area should also be considered a hit. In these cases this function thus returns a constant value greater zero but still below the parent plot's selection tolerance. (typically the selectionTolerance multiplied by 0.99).

Providing a constant value for area objects allows selecting line objects even when they are obscured by such area objects, by clicking close to the lines (i.e. closer than 0.99*selectionTolerance).

The actual setting of the selection state is not done by this function. This is handled by the parent QCustomPlot when the mouseReleaseEvent occurs, and the finally selected object is notified via the selectEvent/deselectEvent methods.

details is an optional output parameter. Every layerable subclass may place any information in details. This information will be passed to selectEvent when the parent QCustomPlot decides on the basis of this selectTest call, that the object was successfully selected. The subsequent call to selectEvent will carry the details. This is useful for multi-part objects (like QCPAxis). This way, a possibly complex calculation to decide which part was clicked is only done once in selectTest. The result (i.e. the actually clicked part) can then be placed in details. So in the subsequent selectEvent, the decision which part was selected doesn't have to be done a second time for a single selection operation.

You may pass 0 as details to indicate that you are not interested in those selection details.

See also: selectEvent, deselectEvent, QCustomPlot::setInteractions

Implements QCPAbstractPlottable.

Definition at line 27527 of file qcustomplot.cpp.

References QCPRange::contains(), QCPColorMapData::isEmpty(), QCPColorMapData::keyRange(), QCPAbstractPlottable::mKeyAxis, mMapData, QCPLayerable::mParentPlot, QCPAbstractPlottable::mSelectable, QCPAbstractPlottable::mValueAxis, QCPAbstractPlottable::pixelsToCoords(), QCustomPlot::selectionTolerance(), QCP::stNone, and QCPColorMapData::valueRange().

◆ selectTest() [2/2]

virtual double QCPColorMap::selectTest	(	const QPointF &	pos,
		bool	onlySelectable,
		QVariant *	details = `0`
	)		const

virtual

This function is used to decide whether a click hits a layerable object or not.

pos is a point in pixel coordinates on the QCustomPlot surface. This function returns the shortest pixel distance of this point to the object. If the object is either invisible or the distance couldn't be determined, -1.0 is returned. Further, if onlySelectable is true and the object is not selectable, -1.0 is returned, too.

If the object is represented not by single lines but by an area like a QCPItemText or the bars of a QCPBars plottable, a click inside the area should also be considered a hit. In these cases this function thus returns a constant value greater zero but still below the parent plot's selection tolerance. (typically the selectionTolerance multiplied by 0.99).

Providing a constant value for area objects allows selecting line objects even when they are obscured by such area objects, by clicking close to the lines (i.e. closer than 0.99*selectionTolerance).

The actual setting of the selection state is not done by this function. This is handled by the parent QCustomPlot when the mouseReleaseEvent occurs, and the finally selected object is notified via the selectEvent/ deselectEvent methods.

details is an optional output parameter. Every layerable subclass may place any information in details. This information will be passed to selectEvent when the parent QCustomPlot decides on the basis of this selectTest call, that the object was successfully selected. The subsequent call to selectEvent will carry the details. This is useful for multi-part objects (like QCPAxis). This way, a possibly complex calculation to decide which part was clicked is only done once in selectTest. The result (i.e. the actually clicked part) can then be placed in details. So in the subsequent selectEvent, the decision which part was selected doesn't have to be done a second time for a single selection operation.

In the case of 1D Plottables (QCPAbstractPlottable1D, like QCPGraph or QCPBars) details will be set to a QCPDataSelection, describing the closest data point to pos.

You may pass 0 as details to indicate that you are not interested in those selection details.

See also: selectEvent, deselectEvent, mousePressEvent, wheelEvent, QCustomPlot::setInteractions, QCPAbstractPlottable1D::selectTestRect

This function is used to decide whether a click hits a layerable object or not.

pos is a point in pixel coordinates on the QCustomPlot surface. This function returns the shortest pixel distance of this point to the object. If the object is either invisible or the distance couldn't be determined, -1.0 is returned. Further, if onlySelectable is true and the object is not selectable, -1.0 is returned, too.

If the object is represented not by single lines but by an area like a QCPItemText or the bars of a QCPBars plottable, a click inside the area should also be considered a hit. In these cases this function thus returns a constant value greater zero but still below the parent plot's selection tolerance. (typically the selectionTolerance multiplied by 0.99).

Providing a constant value for area objects allows selecting line objects even when they are obscured by such area objects, by clicking close to the lines (i.e. closer than 0.99*selectionTolerance).

The actual setting of the selection state is not done by this function. This is handled by the parent QCustomPlot when the mouseReleaseEvent occurs, and the finally selected object is notified via the selectEvent/deselectEvent methods.

details is an optional output parameter. Every layerable subclass may place any information in details. This information will be passed to selectEvent when the parent QCustomPlot decides on the basis of this selectTest call, that the object was successfully selected. The subsequent call to selectEvent will carry the details. This is useful for multi-part objects (like QCPAxis). This way, a possibly complex calculation to decide which part was clicked is only done once in selectTest. The result (i.e. the actually clicked part) can then be placed in details. So in the subsequent selectEvent, the decision which part was selected doesn't have to be done a second time for a single selection operation.

You may pass 0 as details to indicate that you are not interested in those selection details.

See also: selectEvent, deselectEvent, QCustomPlot::setInteractions

Implements QCPAbstractPlottable.

◆ setColorScale() [1/2]

void QCPColorMap::setColorScale ( QCPColorScale * colorScale )

Associates the color scale colorScale with this color map.

This means that both the color scale and the color map synchronize their gradient, data range and data scale type (setGradient, setDataRange, setDataScaleType). Multiple color maps can be associated with one single color scale. This causes the color maps to also synchronize those properties, via the mutual color scale.

This function causes the color map to adopt the current color gradient, data range and data scale type of colorScale. After this call, you may change these properties at either the color map or the color scale, and the setting will be applied to both.

Pass 0 as colorScale to disconnect the color scale from this color map again.

Definition at line 27420 of file qcustomplot.cpp.

References colorScale(), dataRangeChanged(), dataScaleTypeChanged(), gradientChanged(), mColorScale, setDataRange(), setDataScaleType(), and setGradient().

◆ setColorScale() [2/2]

void QCPColorMap::setColorScale ( QCPColorScale * colorScale )

◆ setData() [1/2]

void QCPColorMap::setData	(	QCPColorMapData *	data,
		bool	copy = `false`
	)

Replaces the current data with the provided data.

If copy is set to true, the data object will only be copied. if false, the color map takes ownership of the passed data and replaces the internal data pointer with it. This is significantly faster than copying for large datasets.

Definition at line 27297 of file qcustomplot.cpp.

References copy, data(), mMapData, and mMapImageInvalidated.

◆ setData() [2/2]

void QCPColorMap::setData	(	QCPColorMapData *	data,
		bool	copy = `false`
	)

◆ setDataRange() [1/2]

void QCPColorMap::setDataRange ( const QCPRange & dataRange )

Sets the data range of this color map to dataRange. The data range defines which data values are mapped to the color gradient.

To make the data range span the full range of the data set, use rescaleDataRange.

See also: QCPColorScale::setDataRange

Definition at line 27323 of file qcustomplot.cpp.

References dataRange(), dataRangeChanged(), QCPRange::lower, mDataRange, mDataScaleType, mMapImageInvalidated, QCPRange::sanitizedForLinScale(), QCPRange::sanitizedForLogScale(), QCPAxis::stLogarithmic, QCPRange::upper, and QCPRange::validRange().

Referenced by rescaleDataRange(), setColorScale(), and setDataScaleType().

◆ setDataRange() [2/2]

Q_SLOT void QCPColorMap::setDataRange ( const QCPRange & dataRange )

◆ setDataScaleType() [1/2]

void QCPColorMap::setDataScaleType ( QCPAxis::ScaleType scaleType )

Sets whether the data is correlated with the color gradient linearly or logarithmically.

See also: QCPColorScale::setDataScaleType

Definition at line 27342 of file qcustomplot.cpp.

References dataScaleTypeChanged(), mDataRange, mDataScaleType, mMapImageInvalidated, QCPRange::sanitizedForLogScale(), setDataRange(), and QCPAxis::stLogarithmic.

Referenced by setColorScale().

◆ setDataScaleType() [2/2]

Q_SLOT void QCPColorMap::setDataScaleType ( QCPAxis::ScaleType scaleType )

◆ setGradient() [1/2]

void QCPColorMap::setGradient ( const QCPColorGradient & gradient )

Sets the color gradient that is used to represent the data. For more details on how to create an own gradient or use one of the preset gradients, see QCPColorGradient.

The colors defined by the gradient will be used to represent data values in the currently set data range, see setDataRange. Data points that are outside this data range will either be colored uniformly with the respective gradient boundary color, or the gradient will repeat, depending on QCPColorGradient::setPeriodic.

See also: QCPColorScale::setGradient

Definition at line 27365 of file qcustomplot.cpp.

References gradient(), gradientChanged(), mGradient, and mMapImageInvalidated.

Referenced by setColorScale().

◆ setGradient() [2/2]

Q_SLOT void QCPColorMap::setGradient ( const QCPColorGradient & gradient )

◆ setInterpolate() [1/2]

void QCPColorMap::setInterpolate ( bool enabled )

Sets whether the color map image shall use bicubic interpolation when displaying the color map shrinked or expanded, and not at a 1:1 pixel-to-data scale.

A 10*10 color map, with interpolation

and without interpolation enabled"

Definition at line 27381 of file qcustomplot.cpp.

References mInterpolate, and mMapImageInvalidated.

◆ setInterpolate() [2/2]

void QCPColorMap::setInterpolate ( bool enabled )

◆ setTightBoundary() [1/2]

void QCPColorMap::setTightBoundary ( bool enabled )

Sets whether the outer most data rows and columns are clipped to the specified key and value range (see QCPColorMapData::setKeyRange, QCPColorMapData::setValueRange).

if enabled is set to false, the data points at the border of the color map are drawn with the same width and height as all other data points. Since the data points are represented by rectangles of one color centered on the data coordinate, this means that the shown color map extends by half a data point over the specified key/value range in each direction.

A color map, with tight boundary

enabled and disabled"

Definition at line 27401 of file qcustomplot.cpp.

References mTightBoundary.

◆ setTightBoundary() [2/2]

void QCPColorMap::setTightBoundary ( bool enabled )

◆ tightBoundary() [1/2]

bool QCPColorMap::tightBoundary ( ) const

inline

Definition at line 6806 of file qcustomplot.h.

◆ tightBoundary() [2/2]

bool QCPColorMap::tightBoundary ( ) const

inline

Definition at line 3684 of file qcustomplot.h.

◆ updateLegendIcon() [1/2]

void QCPColorMap::updateLegendIcon	(	Qt::TransformationMode	transformMode = `Qt::SmoothTransformation`,
		const QSize &	thumbSize = `QSize(32, 18)`
	)

Takes the current appearance of the color map and updates the legend icon, which is used to represent this color map in the legend (see QCPLegend).

The transformMode specifies whether the rescaling is done by a faster, low quality image scaling algorithm (Qt::FastTransformation) or by a slower, higher quality algorithm (Qt::SmoothTransformation).

The current color map appearance is scaled down to thumbSize. Ideally, this should be equal to the size of the legend icon (see QCPLegend::setIconSize). If it isn't exactly the configured legend icon size, the thumb will be rescaled during drawing of the legend item.

See also: setDataRange

Definition at line 27504 of file qcustomplot.cpp.

References data(), QCPAbstractPlottable::keyAxis(), mLegendIcon, mMapImage, QCPAxis::orientation(), updateMapImage(), and QCPAbstractPlottable::valueAxis().

◆ updateLegendIcon() [2/2]

Q_SLOT void QCPColorMap::updateLegendIcon	(	Qt::TransformationMode	transformMode = `Qt::SmoothTransformation`,
		const QSize &	thumbSize = `QSize(32, 18)`
	)

◆ updateMapImage() [1/2]

void QCPColorMap::updateMapImage ( )

protectedvirtual

◆ updateMapImage() [2/2]

virtual void QCPColorMap::updateMapImage ( )

protectedvirtual

Member Data Documentation

◆ mColorScale

QPointer< QCPColorScale > QCPColorMap::mColorScale

protected

Definition at line 6850 of file qcustomplot.h.

Referenced by setColorScale().

◆ mDataRange

QCPRange QCPColorMap::mDataRange

protected

Definition at line 6844 of file qcustomplot.h.

Referenced by setDataRange(), setDataScaleType(), and updateMapImage().

◆ mDataScaleType

QCPAxis::ScaleType QCPColorMap::mDataScaleType

protected

Definition at line 6845 of file qcustomplot.h.

Referenced by setDataRange(), setDataScaleType(), and updateMapImage().

◆ mGradient

QCPColorGradient QCPColorMap::mGradient

protected

Definition at line 6847 of file qcustomplot.h.

Referenced by setGradient(), and updateMapImage().

◆ mInterpolate

bool QCPColorMap::mInterpolate

protected

Definition at line 6848 of file qcustomplot.h.

Referenced by draw(), setInterpolate(), and updateMapImage().

◆ mLegendIcon

QPixmap QCPColorMap::mLegendIcon

protected

Definition at line 6854 of file qcustomplot.h.

Referenced by drawLegendIcon(), and updateLegendIcon().

◆ mMapData

QCPColorMapData * QCPColorMap::mMapData

protected

Definition at line 6846 of file qcustomplot.h.

Referenced by clearData(), draw(), getKeyRange(), getValueRange(), rescaleDataRange(), selectTest(), setData(), updateMapImage(), and ~QCPColorMap().

◆ mMapImage

QImage QCPColorMap::mMapImage

protected

Definition at line 6853 of file qcustomplot.h.

Referenced by draw(), updateLegendIcon(), and updateMapImage().

◆ mMapImageInvalidated

bool QCPColorMap::mMapImageInvalidated

protected

Definition at line 6855 of file qcustomplot.h.

Referenced by draw(), setData(), setDataRange(), setDataScaleType(), setGradient(), setInterpolate(), and updateMapImage().

◆ mTightBoundary

bool QCPColorMap::mTightBoundary

protected

Definition at line 6849 of file qcustomplot.h.

Referenced by draw(), and setTightBoundary().

◆ mUndersampledMapImage

QImage QCPColorMap::mUndersampledMapImage

protected

Definition at line 6853 of file qcustomplot.h.

Referenced by updateMapImage().

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

/root/ACloudViewer/app/extern/QCustomPlot/qcustomplot.h
/root/ACloudViewer/app/extern/QCustomPlot/qcustomplot.cpp

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Changing the appearance

Transparency

Usage

Changing the appearance

Usage

Constructor & Destructor Documentation

◆ QCPColorMap() [1/2]

◆ ~QCPColorMap() [1/2]

◆ QCPColorMap() [2/2]

◆ ~QCPColorMap() [2/2]

Member Function Documentation

◆ clearData()

◆ colorScale() [1/2]

◆ colorScale() [2/2]

◆ data() [1/2]

◆ data() [2/2]

◆ dataRange() [1/2]

◆ dataRange() [2/2]

◆ dataRangeChanged [1/2]

◆ dataRangeChanged [2/2]

◆ dataScaleType() [1/2]

◆ dataScaleType() [2/2]

◆ dataScaleTypeChanged [1/2]

◆ dataScaleTypeChanged [2/2]

◆ draw() [1/2]

◆ draw() [2/2]

◆ drawLegendIcon() [1/2]

◆ drawLegendIcon() [2/2]

◆ getKeyRange() [1/2]

◆ getKeyRange() [2/2]

◆ getValueRange() [1/2]

◆ getValueRange() [2/2]

◆ gradient() [1/2]

◆ gradient() [2/2]

◆ gradientChanged [1/2]

◆ gradientChanged [2/2]

◆ interpolate() [1/2]

◆ interpolate() [2/2]

◆ rescaleDataRange() [1/2]

◆ rescaleDataRange() [2/2]

◆ selectTest() [1/2]

◆ selectTest() [2/2]

◆ setColorScale() [1/2]

◆ setColorScale() [2/2]

◆ setData() [1/2]

◆ setData() [2/2]

◆ setDataRange() [1/2]

◆ setDataRange() [2/2]

◆ setDataScaleType() [1/2]

◆ setDataScaleType() [2/2]

◆ setGradient() [1/2]

◆ setGradient() [2/2]

◆ setInterpolate() [1/2]

◆ setInterpolate() [2/2]

◆ setTightBoundary() [1/2]

◆ setTightBoundary() [2/2]

◆ tightBoundary() [1/2]

◆ tightBoundary() [2/2]

◆ updateLegendIcon() [1/2]

◆ updateLegendIcon() [2/2]

◆ updateMapImage() [1/2]

◆ updateMapImage() [2/2]

Member Data Documentation

◆ mColorScale

◆ mDataRange

◆ mDataScaleType

◆ mGradient

◆ mInterpolate

◆ mLegendIcon

◆ mMapData

◆ mMapImage

◆ mMapImageInvalidated

◆ mTightBoundary

◆ mUndersampledMapImage