iCub-main
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
QCPCurve Class Reference

A plottable representing a parametric curve in a plot. More...

#include <qcustomplot.h>

+ Inheritance diagram for QCPCurve:

Public Types

enum  LineStyle {
  lsNone ,
  lsLine
}
 Defines how the curve's line is represented visually in the plot. More...
 

Public Member Functions

 QCPCurve (QCPAxis *keyAxis, QCPAxis *valueAxis)
 Constructs a curve which uses keyAxis as its key axis ("x") and valueAxis as its value axis ("y"). More...
 
virtual ~QCPCurve ()
 
QCPCurveDataMapdata () const
 
QCPScatterStyle scatterStyle () const
 
LineStyle lineStyle () const
 
void setData (QCPCurveDataMap *data, bool copy=false)
 Replaces the current data with the provided data. More...
 
void setData (const QVector< double > &t, const QVector< double > &key, const QVector< double > &value)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Replaces the current data with the provided points in t, key and value tuples. More...
 
void setData (const QVector< double > &key, const QVector< double > &value)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Replaces the current data with the provided key and value pairs. More...
 
void setScatterStyle (const QCPScatterStyle &style)
 Sets the visual appearance of single data points in the plot. More...
 
void setLineStyle (LineStyle style)
 Sets how the single data points are connected in the plot or how they are represented visually apart from the scatter symbol. More...
 
void addData (const QCPCurveDataMap &dataMap)
 Adds the provided data points in dataMap to the current data. More...
 
void addData (const QCPCurveData &data)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Adds the provided single data point in data to the current data. More...
 
void addData (double t, double key, double value)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Adds the provided single data point as t, key and value tuple to the current data. More...
 
void addData (double key, double value)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Adds the provided single data point as key and value pair to the current data The t parameter of the data point is set to the t of the last data point plus 1. More...
 
void addData (const QVector< double > &ts, const QVector< double > &keys, const QVector< double > &values)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Adds the provided data points as t, key and value tuples to the current data. More...
 
void removeDataBefore (double t)
 Removes all data points with curve parameter t smaller than t. More...
 
void removeDataAfter (double t)
 Removes all data points with curve parameter t greater than t. More...
 
void removeData (double fromt, double tot)
 Removes all data points with curve parameter t between fromt and tot. More...
 
void removeData (double t)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Removes a single data point at curve parameter t. More...
 
virtual void clearData ()
 Removes all data points. More...
 
virtual double selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const
 This function is used to decide whether a click hits a layerable object or not. More...
 
- Public Member Functions inherited from 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"). More...
 
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)
 The name is the textual representation of this plottable as it is displayed in the legend (QCPLegend). More...
 
void setAntialiasedFill (bool enabled)
 Sets whether fills of this plottable is drawn antialiased or not. More...
 
void setAntialiasedScatters (bool enabled)
 Sets whether the scatter symbols of this plottable are drawn antialiased or not. More...
 
void setAntialiasedErrorBars (bool enabled)
 Sets whether the error bars of this plottable are drawn antialiased or not. More...
 
void setPen (const QPen &pen)
 The pen is used to draw basic lines that make up the plottable representation in the plot. More...
 
void 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. More...
 
void setBrush (const QBrush &brush)
 The brush is used to draw basic fills of the plottable representation in the plot. More...
 
void setSelectedBrush (const QBrush &brush)
 When the plottable is selected, this brush is used to draw fills instead of the normal brush set via setBrush. More...
 
void 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. More...
 
void 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. More...
 
Q_SLOT void setSelectable (bool selectable)
 Sets whether the user can (de-)select this plottable by clicking on the QCustomPlot surface. More...
 
Q_SLOT void setSelected (bool selected)
 Sets whether this plottable is selected or not. More...
 
virtual bool addToLegend ()
 Adds this plottable to the legend of the parent QCustomPlot (QCustomPlot::legend). More...
 
virtual bool removeFromLegend () const
 Removes the plottable from the legend of the parent QCustomPlot. More...
 
void 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. More...
 
void rescaleKeyAxis (bool onlyEnlarge=false) const
 Rescales the key axis of the plottable so the whole plottable is visible. More...
 
void rescaleValueAxis (bool onlyEnlarge=false) const
 Rescales the value axis of the plottable so the whole plottable is visible. More...
 
- Public Member Functions inherited from QCPLayerable
 QCPLayerable (QCustomPlot *plot, QString targetLayer="", QCPLayerable *parentLayerable=0)
 Creates a new QCPLayerable instance. More...
 
 ~QCPLayerable ()
 
bool visible () const
 
QCustomPlotparentPlot () const
 
QCPLayerableparentLayerable () const
 Returns the parent layerable of this layerable. More...
 
QCPLayerlayer () const
 
bool antialiased () const
 
void setVisible (bool on)
 Sets the visibility of this layerable object. More...
 
Q_SLOT bool setLayer (QCPLayer *layer)
 Sets the layer of this layerable object. More...
 
bool setLayer (const QString &layerName)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Sets the layer of this layerable object by name. More...
 
void setAntialiased (bool enabled)
 Sets whether this object will be drawn antialiased or not. More...
 
bool realVisibility () const
 Returns whether this layerable is visible, taking the visibility of the layerable parent and the visibility of the layer this layerable is on into account. More...
 

Protected Member Functions

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
 
virtual void drawScatterPlot (QCPPainter *painter, const QVector< QPointF > *pointData) const
 
void getCurveData (QVector< QPointF > *lineData) const
 
double pointDistance (const QPointF &pixelPoint) const
 
QPointF outsideCoordsToPixels (double key, double value, int region, QRect axisRect) 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 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

QCPCurveDataMapmData
 
QCPScatterStyle mScatterStyle
 
LineStyle mLineStyle
 
- Protected Attributes inherited from QCPAbstractPlottable
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 QCPLegend
 

Additional Inherited Members

- Signals inherited from QCPAbstractPlottable
void selectionChanged (bool selected)
 This signal is emitted when the selection state of this plottable has changed, either by user interaction or by a direct call to setSelected. More...
 
void selectableChanged (bool selectable)
 This signal is emitted when the selectability of this plottable has changed. More...
 
- Signals inherited from QCPLayerable
void layerChanged (QCPLayer *newLayer)
 This signal is emitted when the layer of this layerable changes, i.e. More...
 
- Protected Types inherited from QCPAbstractPlottable
enum  SignDomain {
  sdNegative ,
  sdBoth ,
  sdPositive
}
 Represents negative and positive sign domain for passing to getKeyRange and getValueRange. More...
 

Detailed Description

A plottable representing a parametric curve in a plot.

Unlike QCPGraph, plottables of this type may have multiple points with the same key coordinate, so their visual representation can have loops. This is realized by introducing a third coordinate t, which defines the order of the points described by the other two coordinates x and y.

To plot data, assign it with the setData or addData functions.

Changing the appearance

The appearance of the curve is determined by the pen and the brush (setPen, setBrush).

Usage

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

Usually, you first create an instance:

QCPCurve *newCurve = new QCPCurve(customPlot->xAxis, customPlot->yAxis);
A plottable representing a parametric curve in a plot.
Definition: qcustomplot.h:2637
QCPCurve(QCPAxis *keyAxis, QCPAxis *valueAxis)
Constructs a curve which uses keyAxis as its key axis ("x") and valueAxis as its value axis ("y").

add it to the customPlot with QCustomPlot::addPlottable:

customPlot->addPlottable(newCurve);

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

newCurve->setName("Fermat's Spiral");
newCurve->setData(tData, xData, yData);
void setName(const QString &name)
The name is the textual representation of this plottable as it is displayed in the legend (QCPLegend)...
void setData(QCPCurveDataMap *data, bool copy=false)
Replaces the current data with the provided data.

Definition at line 2636 of file qcustomplot.h.

Member Enumeration Documentation

◆ LineStyle

Defines how the curve's line is represented visually in the plot.

The line is drawn with the current pen of the curve (setPen).

See also
setLineStyle
Enumerator
lsNone 

No line is drawn between data points (e.g. only scatters)

lsLine 

Data points are connected with a straight line.

Definition at line 2649 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPCurve()

QCPCurve::QCPCurve ( QCPAxis keyAxis,
QCPAxis valueAxis 
)
explicit

Constructs a curve 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 not have the same orientation. If either of these restrictions is violated, a corresponding message is printed to the debug output (qDebug), the construction is not aborted, though.

The constructed QCPCurve can be added to the plot with QCustomPlot::addPlottable, QCustomPlot then takes ownership of the graph.

Definition at line 16774 of file qcustomplot.cpp.

◆ ~QCPCurve()

QCPCurve::~QCPCurve ( )
virtual

Definition at line 16791 of file qcustomplot.cpp.

Member Function Documentation

◆ addData() [1/5]

void QCPCurve::addData ( const QCPCurveData data)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Adds the provided single data point in data to the current data.

See also
removeData

Definition at line 16894 of file qcustomplot.cpp.

◆ addData() [2/5]

void QCPCurve::addData ( const QCPCurveDataMap dataMap)

Adds the provided data points in dataMap to the current data.

See also
removeData

Definition at line 16885 of file qcustomplot.cpp.

◆ addData() [3/5]

void QCPCurve::addData ( const QVector< double > &  ts,
const QVector< double > &  keys,
const QVector< double > &  values 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Adds the provided data points as t, key and value tuples to the current data.

See also
removeData

Definition at line 16936 of file qcustomplot.cpp.

◆ addData() [4/5]

void QCPCurve::addData ( double  key,
double  value 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Adds the provided single data point as key and value pair to the current data The t parameter of the data point is set to the t of the last data point plus 1.

If there is no last data point, t will be set to 0.

See also
removeData

Definition at line 16920 of file qcustomplot.cpp.

◆ addData() [5/5]

void QCPCurve::addData ( double  t,
double  key,
double  value 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Adds the provided single data point as t, key and value tuple to the current data.

See also
removeData

Definition at line 16903 of file qcustomplot.cpp.

◆ clearData()

void QCPCurve::clearData ( )
virtual

Removes all data points.

See also
removeData, removeDataAfter, removeDataBefore

Implements QCPAbstractPlottable.

Definition at line 17008 of file qcustomplot.cpp.

◆ data()

QCPCurveDataMap* QCPCurve::data ( ) const
inline

Definition at line 2656 of file qcustomplot.h.

◆ draw()

void QCPCurve::draw ( QCPPainter painter)
protectedvirtual

Implements QCPAbstractPlottable.

Definition at line 17028 of file qcustomplot.cpp.

◆ drawLegendIcon()

void QCPCurve::drawLegendIcon ( QCPPainter painter,
const QRectF &  rect 
) const
protectedvirtual

Implements QCPAbstractPlottable.

Definition at line 17087 of file qcustomplot.cpp.

◆ drawScatterPlot()

void QCPCurve::drawScatterPlot ( QCPPainter painter,
const QVector< QPointF > *  pointData 
) const
protectedvirtual

Definition at line 17126 of file qcustomplot.cpp.

◆ getCurveData()

void QCPCurve::getCurveData ( QVector< QPointF > *  lineData) const
protected

Definition at line 17141 of file qcustomplot.cpp.

◆ getKeyRange()

QCPRange QCPCurve::getKeyRange ( bool &  foundRange,
SignDomain  inSignDomain = sdBoth 
) const
protectedvirtual

Implements QCPAbstractPlottable.

Definition at line 17322 of file qcustomplot.cpp.

◆ getValueRange()

QCPRange QCPCurve::getValueRange ( bool &  foundRange,
SignDomain  inSignDomain = sdBoth 
) const
protectedvirtual

Implements QCPAbstractPlottable.

Definition at line 17355 of file qcustomplot.cpp.

◆ lineStyle()

LineStyle QCPCurve::lineStyle ( ) const
inline

Definition at line 2658 of file qcustomplot.h.

◆ outsideCoordsToPixels()

QPointF QCPCurve::outsideCoordsToPixels ( double  key,
double  value,
int  region,
QRect  axisRect 
) const
protected

Definition at line 17299 of file qcustomplot.cpp.

◆ pointDistance()

double QCPCurve::pointDistance ( const QPointF &  pixelPoint) const
protected

Definition at line 17261 of file qcustomplot.cpp.

◆ removeData() [1/2]

void QCPCurve::removeData ( double  fromt,
double  tot 
)

Removes all data points with curve parameter t between fromt and tot.

if fromt is greater or equal to tot, the function does nothing. To remove a single data point with known t, use removeData(double t).

See also
addData, clearData

Definition at line 16981 of file qcustomplot.cpp.

◆ removeData() [2/2]

void QCPCurve::removeData ( double  t)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Removes a single data point at curve parameter t.

If the position is not known with absolute precision, consider using removeData(double fromt, double tot) with a small fuzziness interval around the suspected position, depeding on the precision with which the curve parameter is known.

See also
addData, clearData

Definition at line 16999 of file qcustomplot.cpp.

◆ removeDataAfter()

void QCPCurve::removeDataAfter ( double  t)

Removes all data points with curve parameter t greater than t.

See also
addData, clearData

Definition at line 16966 of file qcustomplot.cpp.

◆ removeDataBefore()

void QCPCurve::removeDataBefore ( double  t)

Removes all data points with curve parameter t smaller than t.

See also
addData, clearData

Definition at line 16955 of file qcustomplot.cpp.

◆ scatterStyle()

QCPScatterStyle QCPCurve::scatterStyle ( ) const
inline

Definition at line 2657 of file qcustomplot.h.

◆ selectTest()

double QCPCurve::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 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

Implements QCPAbstractPlottable.

Definition at line 17014 of file qcustomplot.cpp.

◆ setData() [1/3]

void QCPCurve::setData ( const QVector< double > &  key,
const QVector< double > &  value 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Replaces the current data with the provided key and value pairs.

The t parameter of each data point will be set to the integer index of the respective key/value pair.

Definition at line 16842 of file qcustomplot.cpp.

◆ setData() [2/3]

void QCPCurve::setData ( const QVector< double > &  t,
const QVector< double > &  key,
const QVector< double > &  value 
)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Replaces the current data with the provided points in t, key and value tuples.

The provided vectors should have equal length. Else, the number of added points will be the size of the smallest vector.

Definition at line 16821 of file qcustomplot.cpp.

◆ setData() [3/3]

void QCPCurve::setData ( QCPCurveDataMap data,
bool  copy = false 
)

Replaces the current data with the provided data.

If copy is set to true, data points in data will only be copied. if false, the plottable 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 16803 of file qcustomplot.cpp.

◆ setLineStyle()

void QCPCurve::setLineStyle ( QCPCurve::LineStyle  style)

Sets how the single data points are connected in the plot or how they are represented visually apart from the scatter symbol.

For scatter-only plots, set style to lsNone and setScatterStyle to the desired scatter style.

See also
setScatterStyle

Definition at line 16876 of file qcustomplot.cpp.

◆ setScatterStyle()

void QCPCurve::setScatterStyle ( const QCPScatterStyle style)

Sets the visual appearance of single data points in the plot.

If set to QCPScatterStyle::ssNone, no scatter points are drawn (e.g. for line-only plots with appropriate line style).

See also
QCPScatterStyle, setLineStyle

Definition at line 16864 of file qcustomplot.cpp.

Friends And Related Function Documentation

◆ QCPLegend

friend class QCPLegend
friend

Definition at line 2703 of file qcustomplot.h.

◆ QCustomPlot

friend class QCustomPlot
friend

Definition at line 2702 of file qcustomplot.h.

Member Data Documentation

◆ mData

QCPCurveDataMap* QCPCurve::mData
protected

Definition at line 2684 of file qcustomplot.h.

◆ mLineStyle

LineStyle QCPCurve::mLineStyle
protected

Definition at line 2686 of file qcustomplot.h.

◆ mScatterStyle

QCPScatterStyle QCPCurve::mScatterStyle
protected

Definition at line 2685 of file qcustomplot.h.


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