Vespucci  1.0.0
QCPAbstractPlottable Class Referenceabstract

The abstract base class for all data representing objects in a plot. More...

#include <qcustomplot.h>

Inheritance diagram for QCPAbstractPlottable:
QCPLayerable QCPBars QCPColorMap QCPCurve QCPFinancial QCPGraph QCPStatisticalBox

Signals

void selectionChanged (bool selected)
 
void selectableChanged (bool selectable)
 
- Signals inherited from QCPLayerable
void layerChanged (QCPLayer *newLayer)
 

Public Member Functions

 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
 
QCPAxiskeyAxis () const
 
QCPAxisvalueAxis () 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 void clearData ()=0
 
virtual double selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const =0
 
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)
 
 ~QCPLayerable ()
 
bool visible () const
 
QCustomPlotparentPlot () const
 
QCPLayerableparentLayerable () const
 
QCPLayerlayer () 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 Types

enum  SignDomain { sdNegative, sdBoth, sdPositive }
 

Protected Member Functions

virtual QRect clipRect () const
 
virtual void draw (QCPPainter *painter)=0
 
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)
 
virtual void drawLegendIcon (QCPPainter *painter, const QRectF &rect) const =0
 
virtual QCPRange getKeyRange (bool &foundRange, SignDomain inSignDomain=sdBoth) const =0
 
virtual QCPRange getValueRange (bool &foundRange, SignDomain inSignDomain=sdBoth) const =0
 
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)
 
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

QString mName
 
bool mAntialiasedFill
 
bool mAntialiasedScatters
 
bool mAntialiasedErrorBars
 
QPen mPen
 
QPen mSelectedPen
 
QBrush mBrush
 
QBrush mSelectedBrush
 
QPointer< QCPAxismKeyAxis
 
QPointer< QCPAxismValueAxis
 
bool mSelectable
 
bool mSelected
 
- Protected Attributes inherited from QCPLayerable
bool mVisible
 
QCustomPlotmParentPlot
 
QPointer< QCPLayerablemParentLayerable
 
QCPLayermLayer
 
bool mAntialiased
 

Friends

class QCustomPlot
 
class QCPAxis
 
class QCPPlottableLegendItem
 

Detailed Description

The abstract base class for all data representing objects in a plot.

It defines a very basic interface like name, pen, brush, visibility etc. Since this class is abstract, it can't be instantiated. Use one of the subclasses or create a subclass yourself to create new ways of displaying data (see "Creating own plottables" below).

All further specifics are in the subclasses, for example:

Creating own plottables

To create an own plottable, you implement a subclass of QCPAbstractPlottable. These are the pure virtual functions, you must implement:

See the documentation of those functions for what they need to do.

For drawing your plot, you can use the coordsToPixels functions to translate a point in plot coordinates to pixel coordinates. This function is quite convenient, because it takes the orientation of the key and value axes into account for you (x and y are swapped when the key axis is vertical and the value axis horizontal). If you are worried about performance (i.e. you need to translate many points in a loop like QCPGraph), you can directly use QCPAxis::coordToPixel. However, you must then take care about the orientation of the axis yourself.

Here are some important members you inherit from QCPAbstractPlottable:

QCustomPlot *mParentPlot A pointer to the parent QCustomPlot instance. The parent plot is inferred from the axes that are passed in the constructor.
QString mName The name of the plottable.
QPen mPen The generic pen of the plottable. You should use this pen for the most prominent data representing lines in the plottable (e.g QCPGraph uses this pen for its graph lines and scatters)
QPen mSelectedPen The generic pen that should be used when the plottable is selected (hint: mainPen gives you the right pen, depending on selection state).
QBrush mBrush The generic brush of the plottable. You should use this brush for the most prominent fillable structures in the plottable (e.g. QCPGraph uses this brush to control filling under the graph)
QBrush mSelectedBrush The generic brush that should be used when the plottable is selected (hint: mainBrush gives you the right brush, depending on selection state).
QPointer<QCPAxis>mKeyAxis, mValueAxis The key and value axes this plottable is attached to. Call their QCPAxis::coordToPixel functions to translate coordinates to pixels in either the key or value dimension. Make sure to check whether the pointer is null before using it. If one of the axes is null, don't draw the plottable.
bool mSelected indicates whether the plottable is selected or not.

Definition at line 1393 of file qcustomplot.h.

Member Enumeration Documentation

Represents negative and positive sign domain for passing to getKeyRange and getValueRange.

Enumerator
sdNegative 

The negative sign domain, i.e. numbers smaller than zero.

sdBoth 

Both sign domains, including zero, i.e. all (rational) numbers.

sdPositive 

The positive sign domain, i.e. numbers greater than zero.

Definition at line 1460 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPAbstractPlottable::QCPAbstractPlottable ( QCPAxis keyAxis,
QCPAxis valueAxis 
)

Constructs an abstract plottable which uses keyAxis as its key axis ("x") and valueAxis as its value axis ("y"). keyAxis and valueAxis must reside in the same QCustomPlot instance and have perpendicular orientations. If either of these restrictions is violated, a corresponding message is printed to the debug output (qDebug), the construction is not aborted, though.

Since QCPAbstractPlottable is an abstract class that defines the basic interface to plottables, it can't be directly instantiated.

You probably want one of the subclasses like QCPGraph or QCPCurve instead.

Definition at line 6845 of file qcustomplot.cpp.

Member Function Documentation

bool QCPAbstractPlottable::addToLegend ( )
virtual

Adds this plottable to the legend of the parent QCustomPlot (QCustomPlot::legend).

Normally, a QCPPlottableLegendItem is created and inserted into the legend. If the plottable needs a more specialized representation in the legend, this function will take this into account and instead create the specialized subclass of QCPAbstractLegendItem.

Returns true on success, i.e. when the legend exists and a legend item associated with this plottable isn't already in the legend.

See also
removeFromLegend, QCPLegend::addItem

Definition at line 7140 of file qcustomplot.cpp.

bool QCPAbstractPlottable::antialiasedErrorBars ( ) const
inline

Definition at line 1417 of file qcustomplot.h.

bool QCPAbstractPlottable::antialiasedFill ( ) const
inline

Definition at line 1415 of file qcustomplot.h.

bool QCPAbstractPlottable::antialiasedScatters ( ) const
inline

Definition at line 1416 of file qcustomplot.h.

void QCPAbstractPlottable::applyDefaultAntialiasingHint ( QCPPainter painter) const
protectedvirtual

Implements QCPLayerable.

Definition at line 7303 of file qcustomplot.cpp.

void QCPAbstractPlottable::applyErrorBarsAntialiasingHint ( QCPPainter painter) const
protected

Definition at line 7351 of file qcustomplot.cpp.

void QCPAbstractPlottable::applyFillAntialiasingHint ( QCPPainter painter) const
protected

Definition at line 7319 of file qcustomplot.cpp.

void QCPAbstractPlottable::applyScattersAntialiasingHint ( QCPPainter painter) const
protected

Definition at line 7335 of file qcustomplot.cpp.

QBrush QCPAbstractPlottable::brush ( ) const
inline

Definition at line 1420 of file qcustomplot.h.

void QCPAbstractPlottable::clearData ( )
pure virtual

Clears all data in the plottable.

Implemented in QCPFinancial, QCPColorMap, QCPStatisticalBox, QCPBars, QCPCurve, and QCPGraph.

QRect QCPAbstractPlottable::clipRect ( ) const
protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 7175 of file qcustomplot.cpp.

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

Definition at line 7199 of file qcustomplot.cpp.

const QPointF QCPAbstractPlottable::coordsToPixels ( double  key,
double  value 
) const
protected

Definition at line 7221 of file qcustomplot.cpp.

void QCPAbstractPlottable::deselectEvent ( bool *  selectionStateChanged)
protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 7402 of file qcustomplot.cpp.

double QCPAbstractPlottable::distSqrToLine ( const QPointF &  start,
const QPointF &  end,
const QPointF &  point 
) const
protected

Definition at line 7366 of file qcustomplot.cpp.

virtual void QCPAbstractPlottable::draw ( QCPPainter painter)
protectedpure virtual
void QCPAbstractPlottable::drawLegendIcon ( QCPPainter painter,
const QRectF &  rect 
) const
protectedpure virtual
QCPRange QCPAbstractPlottable::getKeyRange ( bool &  foundRange,
SignDomain  inSignDomain = sdBoth 
) const
protectedpure virtual
QCPRange QCPAbstractPlottable::getValueRange ( bool &  foundRange,
SignDomain  inSignDomain = sdBoth 
) const
protectedpure virtual
QCPAxis* QCPAbstractPlottable::keyAxis ( ) const
inline

Definition at line 1422 of file qcustomplot.h.

QBrush QCPAbstractPlottable::mainBrush ( ) const
protected

Definition at line 7285 of file qcustomplot.cpp.

QPen QCPAbstractPlottable::mainPen ( ) const
protected

Definition at line 7275 of file qcustomplot.cpp.

QString QCPAbstractPlottable::name ( ) const
inline

Definition at line 1414 of file qcustomplot.h.

QPen QCPAbstractPlottable::pen ( ) const
inline

Definition at line 1418 of file qcustomplot.h.

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

Definition at line 7243 of file qcustomplot.cpp.

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

Definition at line 7265 of file qcustomplot.cpp.

bool QCPAbstractPlottable::removeFromLegend ( ) const
virtual

Removes the plottable from the legend of the parent QCustomPlot. This means the QCPAbstractLegendItem (usually a QCPPlottableLegendItem) that is associated with this plottable is removed.

Returns true on success, i.e. if the legend exists and a legend item associated with this plottable was found and removed.

See also
addToLegend, QCPLegend::removeItem

Definition at line 7163 of file qcustomplot.cpp.

void QCPAbstractPlottable::rescaleAxes ( bool  onlyEnlarge = false) const

Rescales the key and value axes associated with this plottable to contain all displayed data, so the whole plottable is visible. If the scaling of an axis is logarithmic, rescaleAxes will make sure not to rescale to an illegal range i.e. a range containing different signs and/or zero. Instead it will stay in the current sign domain and ignore all parts of the plottable that lie outside of that domain.

onlyEnlarge makes sure the ranges are only expanded, never reduced. So it's possible to show multiple plottables in their entirety by multiple calls to rescaleAxes where the first call has onlyEnlarge set to false (the default), and all subsequent set to true.

See also
rescaleKeyAxis, rescaleValueAxis, QCustomPlot::rescaleAxes, QCPAxis::rescale

Definition at line 7045 of file qcustomplot.cpp.

void QCPAbstractPlottable::rescaleKeyAxis ( bool  onlyEnlarge = false) const

Rescales the key axis of the plottable so the whole plottable is visible.

See rescaleAxes for detailed behaviour.

Definition at line 7056 of file qcustomplot.cpp.

void QCPAbstractPlottable::rescaleValueAxis ( bool  onlyEnlarge = false) const

Rescales the value axis of the plottable so the whole plottable is visible.

Returns true if the axis was actually scaled. This might not be the case if this plottable has an invalid range, e.g. because it has no data points.

See rescaleAxes for detailed behaviour.

Definition at line 7096 of file qcustomplot.cpp.

bool QCPAbstractPlottable::selectable ( ) const
inline

Definition at line 1424 of file qcustomplot.h.

void QCPAbstractPlottable::selectableChanged ( bool  selectable)
signal

This signal is emitted when the selectability of this plottable has changed.

See also
setSelectable
bool QCPAbstractPlottable::selected ( ) const
inline

Definition at line 1425 of file qcustomplot.h.

QBrush QCPAbstractPlottable::selectedBrush ( ) const
inline

Definition at line 1421 of file qcustomplot.h.

QPen QCPAbstractPlottable::selectedPen ( ) const
inline

Definition at line 1419 of file qcustomplot.h.

void QCPAbstractPlottable::selectEvent ( QMouseEvent *  event,
bool  additive,
const QVariant &  details,
bool *  selectionStateChanged 
)
protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 7388 of file qcustomplot.cpp.

QCP::Interaction QCPAbstractPlottable::selectionCategory ( ) const
protectedvirtual

Reimplemented from QCPLayerable.

Definition at line 7184 of file qcustomplot.cpp.

void QCPAbstractPlottable::selectionChanged ( bool  selected)
signal

This signal is emitted when the selection state of this plottable has changed, either by user interaction or by a direct call to setSelected.

virtual double QCPAbstractPlottable::selectTest ( const QPointF &  pos,
bool  onlySelectable,
QVariant *  details = 0 
) const
pure 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 item is represented not by single lines but by an area like QCPItemRect or QCPItemText, a click inside the area returns a constant value greater zero (typically the selectionTolerance of the parent QCustomPlot multiplied by 0.99). If the click lies outside the area, this function returns -1.0.

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

Reimplemented from QCPLayerable.

Implemented in QCPFinancial, QCPColorMap, QCPStatisticalBox, QCPBars, QCPCurve, and QCPGraph.

void QCPAbstractPlottable::setAntialiasedErrorBars ( bool  enabled)

Sets whether the error bars of this plottable are drawn antialiased or not.

Note that this setting may be overridden by QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.

Definition at line 6903 of file qcustomplot.cpp.

void QCPAbstractPlottable::setAntialiasedFill ( bool  enabled)

Sets whether fills of this plottable is drawn antialiased or not.

Note that this setting may be overridden by QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.

Definition at line 6881 of file qcustomplot.cpp.

void QCPAbstractPlottable::setAntialiasedScatters ( bool  enabled)

Sets whether the scatter symbols of this plottable are drawn antialiased or not.

Note that this setting may be overridden by QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.

Definition at line 6892 of file qcustomplot.cpp.

void QCPAbstractPlottable::setBrush ( const QBrush &  brush)

The brush is used to draw basic fills of the plottable representation in the plot. The Fill can be a color, gradient or texture, see the usage of QBrush.

For example, the QCPGraph subclass draws the fill under the graph with this brush, when it's not set to Qt::NoBrush.

See also
setPen

Definition at line 6943 of file qcustomplot.cpp.

void QCPAbstractPlottable::setKeyAxis ( QCPAxis axis)

The key axis of a plottable can be set to any axis of a QCustomPlot, as long as it is orthogonal to the plottable's value axis. This function performs no checks to make sure this is the case. The typical mathematical choice is to use the x-axis (QCustomPlot::xAxis) as key axis and the y-axis (QCustomPlot::yAxis) as value axis.

Normally, the key and value axes are set in the constructor of the plottable (or QCustomPlot::addGraph when working with QCPGraphs through the dedicated graph interface).

See also
setValueAxis

Definition at line 6970 of file qcustomplot.cpp.

void QCPAbstractPlottable::setName ( const QString &  name)

The name is the textual representation of this plottable as it is displayed in the legend (QCPLegend). It may contain any UTF-8 characters, including newlines.

Definition at line 6870 of file qcustomplot.cpp.

void QCPAbstractPlottable::setPen ( const QPen &  pen)

The pen is used to draw basic lines that make up the plottable representation in the plot.

For example, the QCPGraph subclass draws its graph lines and scatter points with this pen.

See also
setBrush

Definition at line 6918 of file qcustomplot.cpp.

void QCPAbstractPlottable::setSelectable ( bool  selectable)

Sets whether the user can (de-)select this plottable by clicking on the QCustomPlot surface. (When QCustomPlot::setInteractions contains iSelectPlottables.)

However, even when selectable was set to false, it is possible to set the selection manually, by calling setSelected directly.

See also
setSelected

Definition at line 7000 of file qcustomplot.cpp.

void QCPAbstractPlottable::setSelected ( bool  selected)

Sets whether this plottable is selected or not. When selected, it uses a different pen and brush to draw its lines and fills, see setSelectedPen and setSelectedBrush.

The entire selection mechanism for plottables is handled automatically when QCustomPlot::setInteractions contains iSelectPlottables. You only need to call this function when you wish to change the selection state manually.

This function can change the selection state even when setSelectable was set to false.

emits the selectionChanged signal when selected is different from the previous selection state.

See also
setSelectable, selectTest

Definition at line 7023 of file qcustomplot.cpp.

void QCPAbstractPlottable::setSelectedBrush ( const QBrush &  brush)

When the plottable is selected, this brush is used to draw fills instead of the normal brush set via setBrush.

See also
setSelected, setSelectable, setSelectedPen, selectTest

Definition at line 6954 of file qcustomplot.cpp.

void QCPAbstractPlottable::setSelectedPen ( const QPen &  pen)

When the plottable is selected, this pen is used to draw basic lines instead of the normal pen set via setPen.

See also
setSelected, setSelectable, setSelectedBrush, selectTest

Definition at line 6929 of file qcustomplot.cpp.

void QCPAbstractPlottable::setValueAxis ( QCPAxis axis)

The value axis of a plottable can be set to any axis of a QCustomPlot, as long as it is orthogonal to the plottable's key axis. This function performs no checks to make sure this is the case. The typical mathematical choice is to use the x-axis (QCustomPlot::xAxis) as key axis and the y-axis (QCustomPlot::yAxis) as value axis.

Normally, the key and value axes are set in the constructor of the plottable (or QCustomPlot::addGraph when working with QCPGraphs through the dedicated graph interface).

See also
setKeyAxis

Definition at line 6986 of file qcustomplot.cpp.

QCPAxis* QCPAbstractPlottable::valueAxis ( ) const
inline

Definition at line 1423 of file qcustomplot.h.

Friends And Related Function Documentation

friend class QCPAxis
friend

Definition at line 1503 of file qcustomplot.h.

friend class QCPPlottableLegendItem
friend

Definition at line 1504 of file qcustomplot.h.

friend class QCustomPlot
friend

Definition at line 1502 of file qcustomplot.h.

Member Data Documentation

bool QCPAbstractPlottable::mAntialiasedErrorBars
protected

Definition at line 1467 of file qcustomplot.h.

bool QCPAbstractPlottable::mAntialiasedFill
protected

Definition at line 1467 of file qcustomplot.h.

bool QCPAbstractPlottable::mAntialiasedScatters
protected

Definition at line 1467 of file qcustomplot.h.

QBrush QCPAbstractPlottable::mBrush
protected

Definition at line 1469 of file qcustomplot.h.

QPointer<QCPAxis> QCPAbstractPlottable::mKeyAxis
protected

Definition at line 1470 of file qcustomplot.h.

QString QCPAbstractPlottable::mName
protected

Definition at line 1466 of file qcustomplot.h.

QPen QCPAbstractPlottable::mPen
protected

Definition at line 1468 of file qcustomplot.h.

bool QCPAbstractPlottable::mSelectable
protected

Definition at line 1471 of file qcustomplot.h.

bool QCPAbstractPlottable::mSelected
protected

Definition at line 1471 of file qcustomplot.h.

QBrush QCPAbstractPlottable::mSelectedBrush
protected

Definition at line 1469 of file qcustomplot.h.

QPen QCPAbstractPlottable::mSelectedPen
protected

Definition at line 1468 of file qcustomplot.h.

QPointer<QCPAxis> QCPAbstractPlottable::mValueAxis
protected

Definition at line 1470 of file qcustomplot.h.


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