Main Page · Class Overview · Hierarchy · All Classes
Public Types | Public Functions | Signals | Protected Types | Protected Functions
QCPCurve Class Reference

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

Inheritance diagram for QCPCurve:
Inheritance graph

Public Types

enum  LineStyle

Public Functions

 QCPCurve (QCPAxis *keyAxis, QCPAxis *valueAxis)
QCPCurveDataMapdata () const
QCPScatterStyle scatterStyle () const
LineStyle lineStyle () const
void setData (QCPCurveDataMap *data, bool copy=false)
void setData (const QVector< double > &t, const QVector< double > &key, const QVector< double > &value)
void setData (const QVector< double > &key, const QVector< double > &value)
void setScatterStyle (const QCPScatterStyle &style)
void setLineStyle (LineStyle style)
void addData (const QCPCurveDataMap &dataMap)
void addData (const QCPCurveData &data)
void addData (double t, double key, double value)
void addData (double key, double value)
void addData (const QVector< double > &ts, const QVector< double > &keys, const QVector< double > &values)
void removeDataBefore (double t)
void removeDataAfter (double t)
void removeData (double fromt, double tot)
void removeData (double t)
virtual void clearData ()
virtual double selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const
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 bool addToLegend ()
virtual bool removeFromLegend () const
void rescaleAxes (bool onlyEnlarge=false) const
void rescaleKeyAxis (bool onlyEnlarge=false) const
void rescaleValueAxis (bool onlyEnlarge=false) const
bool visible () const
QCustomPlotparentPlot () const
QCPLayerableparentLayerable () const
QCPLayerlayer () const
bool antialiased () const
void setVisible (bool on)
bool setLayer (QCPLayer *layer)
bool setLayer (const QString &layerName)
void setAntialiased (bool enabled)
bool realVisibility () const

Signals

void selectionChanged (bool selected)

Protected Types

enum  SignDomain

Protected Functions

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

Detailed Description

A plottable representing a parametric curve in a plot.

QCPCurve.png

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);

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);

Member Enumeration Documentation

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.

enum QCPAbstractPlottable::SignDomain
protectedinherited

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.

Constructor & Destructor Documentation

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.

Member Function Documentation

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.

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

This is an overloaded function.

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.

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

This is an overloaded function.

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.

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
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
void QCPCurve::addData ( const QCPCurveDataMap dataMap)

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

See Also
removeData
void QCPCurve::addData ( const QCPCurveData data)

This is an overloaded function.

Adds the provided single data point in data to the current data.

See Also
removeData
void QCPCurve::addData ( double  t,
double  key,
double  value 
)

This is an overloaded function.

Adds the provided single data point as t, key and value tuple to the current data

See Also
removeData
void QCPCurve::addData ( double  key,
double  value 
)

This is an overloaded function.

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
void QCPCurve::addData ( const QVector< double > &  ts,
const QVector< double > &  keys,
const QVector< double > &  values 
)

This is an overloaded function.

Adds the provided data points as t, key and value tuples to the current data.

See Also
removeData
void QCPCurve::removeDataBefore ( double  t)

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

See Also
addData, clearData
void QCPCurve::removeDataAfter ( double  t)

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

See Also
addData, clearData
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
void QCPCurve::removeData ( double  t)

This is an overloaded function.

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
void QCPCurve::clearData ( )
virtual

Removes all data points.

See Also
removeData, removeDataAfter, removeDataBefore

Implements QCPAbstractPlottable.

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.

void QCPCurve::draw ( QCPPainter painter)
protectedvirtual

This function draws the layerable with the specified painter. It is only called by QCustomPlot, if the layerable is visible (setVisible).

Before this function is called, the painter's antialiasing state is set via applyDefaultAntialiasingHint, see the documentation there. Further, the clipping rectangle was set to clipRect.

Implements QCPAbstractPlottable.

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

called by QCPLegend::draw (via QCPPlottableLegendItem::draw) to create a graphical representation of this plottable inside rect, next to the plottable name.

Implements QCPAbstractPlottable.

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

called by rescaleAxes functions to get the full data key 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). validRange is an output parameter that indicates whether a proper range could be found or not. If this is false, you shouldn't use the returned range (e.g. no points in data).

See Also
rescaleAxes, getValueRange

Implements QCPAbstractPlottable.

QCPRange QCPCurve::getValueRange ( bool &  validRange,
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). validRange is an output parameter that indicates whether a proper range could be found or not. If this is false, you shouldn't use the returned range (e.g. no points in data).

See Also
rescaleAxes, getKeyRange

Implements QCPAbstractPlottable.

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

Draws scatter symbols at every data point passed in pointData. scatter symbols are independent of the line style and are always drawn if scatter shape is not QCPScatterStyle::ssNone.

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

called by QCPCurve::draw to generate a point vector (pixels) which represents the line of the curve. Line segments that aren't visible in the current axis rect are handled in an optimized way.

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

Calculates the (minimum) distance (in pixels) the curve's representation has from the given pixelPoint in pixels. This is used to determine whether the curve was clicked or not, e.g. in selectTest.

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

This is a specialized coordsToPixels function for points that are outside the visible axisRect and just crossing a boundary (since getCurveData reduces non-visible curve segments to those line segments that cross region boundaries, see documentation there). It only uses the coordinate parallel to the region boundary of the axisRect. The other coordinate is picked just outside the axisRect (how far is determined by the scatter size and the line width). Together with the optimization in getCurveData this improves performance for large curves (or zoomed in ones) significantly while keeping the illusion the whole curve and its filling is still being drawn for the viewer.

void QCPAbstractPlottable::setName ( const QString &  name)
inherited

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.

void QCPAbstractPlottable::setAntialiasedFill ( bool  enabled)
inherited

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

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

void QCPAbstractPlottable::setAntialiasedScatters ( bool  enabled)
inherited

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.

void QCPAbstractPlottable::setAntialiasedErrorBars ( bool  enabled)
inherited

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.

void QCPAbstractPlottable::setPen ( const QPen &  pen)
inherited

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
void QCPAbstractPlottable::setSelectedPen ( const QPen &  pen)
inherited

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
void QCPAbstractPlottable::setBrush ( const QBrush &  brush)
inherited

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
void QCPAbstractPlottable::setSelectedBrush ( const QBrush &  brush)
inherited

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
void QCPAbstractPlottable::setKeyAxis ( QCPAxis axis)
inherited

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
void QCPAbstractPlottable::setValueAxis ( QCPAxis axis)
inherited

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
void QCPAbstractPlottable::setSelectable ( bool  selectable)
inherited

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
void QCPAbstractPlottable::setSelected ( bool  selected)
inherited

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
bool QCPAbstractPlottable::addToLegend ( )
virtualinherited

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
bool QCPAbstractPlottable::removeFromLegend ( ) const
virtualinherited

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
void QCPAbstractPlottable::rescaleAxes ( bool  onlyEnlarge = false) const
inherited

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
void QCPAbstractPlottable::rescaleKeyAxis ( bool  onlyEnlarge = false) const
inherited

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

See rescaleAxes for detailed behaviour.

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

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.

void QCPAbstractPlottable::selectionChanged ( bool  selected)
signalinherited

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

QRect QCPAbstractPlottable::clipRect ( ) const
protectedvirtualinherited

Returns the clipping rectangle of this layerable object. By default, this is the viewport of the parent QCustomPlot. Specific subclasses may reimplement this function to provide different clipping rects.

The returned clipping rect is set on the painter before the draw function of the respective object is called.

Reimplemented from QCPLayerable.

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

Returns the selection category this layerable shall belong to. The selection category is used in conjunction with QCustomPlot::setInteractions to control which objects are selectable and which aren't.

Subclasses that don't fit any of the normal QCP::Interaction values can use QCP::iSelectOther. This is what the default implementation returns.

See Also
QCustomPlot::setInteractions

Reimplemented from QCPLayerable.

void QCPAbstractPlottable::applyDefaultAntialiasingHint ( QCPPainter painter) const
protectedvirtualinherited

A convenience function to easily set the QPainter::Antialiased hint on the provided painter before drawing plottable lines.

This is the antialiasing state the painter passed to the draw method is in by default.

This function takes into account the local setting of the antialiasing flag as well as the overrides set with QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.

See Also
setAntialiased, applyFillAntialiasingHint, applyScattersAntialiasingHint, applyErrorBarsAntialiasingHint

Implements QCPLayerable.

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

This event is called when the layerable shall be selected, as a consequence of a click by the user. Subclasses should react to it by setting their selection state appropriately. The default implementation does nothing.

event is the mouse event that caused the selection. additive indicates, whether the user was holding the multi-select-modifier while performing the selection (see QCustomPlot::setMultiSelectModifier). if additive is true, the selection state must be toggled (i.e. become selected when unselected and unselected when selected).

Every selectEvent is preceded by a call to selectTest, which has returned positively (i.e. returned a value greater than 0 and less than the selection tolerance of the parent QCustomPlot). The details data you output from selectTest is feeded back via details here. You may use it to transport any kind of information from the selectTest to the possibly subsequent selectEvent. Usually details is used to transfer which part was clicked, if it is a layerable that has multiple individually selectable parts (like QCPAxis). This way selectEvent doesn't need to do the calculation again to find out which part was actually clicked.

selectionStateChanged is an output parameter. If the pointer is non-null, this function must set the value either to true or false, depending on whether the selection state of this layerable was actually changed. For layerables that only are selectable as a whole and not in parts, this is simple: if additive is true, selectionStateChanged must also be set to true, because the selection toggles. If additive is false, selectionStateChanged is only set to true, if the layerable was previously unselected and now is switched to the selected state.

See Also
selectTest, deselectEvent

Reimplemented from QCPLayerable.

void QCPAbstractPlottable::deselectEvent ( bool *  selectionStateChanged)
protectedvirtualinherited

This event is called when the layerable shall be deselected, either as consequence of a user interaction or a call to QCustomPlot::deselectAll. Subclasses should react to it by unsetting their selection appropriately.

just as in selectEvent, the output parameter selectionStateChanged (if non-null), must return true or false when the selection state of this layerable has changed or not changed, respectively.

See Also
selectTest, selectEvent

Reimplemented from QCPLayerable.

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

Convenience function for transforming a key/value pair to pixels on the QCustomPlot surface, taking the orientations of the axes associated with this plottable into account (e.g. whether key represents x or y).

key and value are transformed to the coodinates in pixels and are written to x and y.

See Also
pixelsToCoords, QCPAxis::coordToPixel
const QPointF QCPAbstractPlottable::coordsToPixels ( double  key,
double  value 
) const
protectedinherited

This is an overloaded function.

Returns the input as pixel coordinates in a QPointF.

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

Convenience function for transforming a x/y pixel pair on the QCustomPlot surface to plot coordinates, taking the orientations of the axes associated with this plottable into account (e.g. whether key represents x or y).

x and y are transformed to the plot coodinates and are written to key and value.

See Also
coordsToPixels, QCPAxis::coordToPixel
void QCPAbstractPlottable::pixelsToCoords ( const QPointF &  pixelPos,
double &  key,
double &  value 
) const
protectedinherited

This is an overloaded function.

Returns the pixel input pixelPos as plot coordinates key and value.

QPen QCPAbstractPlottable::mainPen ( ) const
protectedinherited

Returns the pen that should be used for drawing lines of the plottable. Returns mPen when the graph is not selected and mSelectedPen when it is.

QBrush QCPAbstractPlottable::mainBrush ( ) const
protectedinherited

Returns the brush that should be used for drawing fills of the plottable. Returns mBrush when the graph is not selected and mSelectedBrush when it is.

void QCPAbstractPlottable::applyFillAntialiasingHint ( QCPPainter painter) const
protectedinherited

A convenience function to easily set the QPainter::Antialiased hint on the provided painter before drawing plottable fills.

This function takes into account the local setting of the antialiasing flag as well as the overrides set with QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.

See Also
setAntialiased, applyDefaultAntialiasingHint, applyScattersAntialiasingHint, applyErrorBarsAntialiasingHint
void QCPAbstractPlottable::applyScattersAntialiasingHint ( QCPPainter painter) const
protectedinherited

A convenience function to easily set the QPainter::Antialiased hint on the provided painter before drawing plottable scatter points.

This function takes into account the local setting of the antialiasing flag as well as the overrides set with QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.

See Also
setAntialiased, applyFillAntialiasingHint, applyDefaultAntialiasingHint, applyErrorBarsAntialiasingHint
void QCPAbstractPlottable::applyErrorBarsAntialiasingHint ( QCPPainter painter) const
protectedinherited

A convenience function to easily set the QPainter::Antialiased hint on the provided painter before drawing plottable error bars.

This function takes into account the local setting of the antialiasing flag as well as the overrides set with QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.

See Also
setAntialiased, applyFillAntialiasingHint, applyScattersAntialiasingHint, applyDefaultAntialiasingHint
double QCPAbstractPlottable::distSqrToLine ( const QPointF &  start,
const QPointF &  end,
const QPointF &  point 
) const
protectedinherited

Finds the shortest squared distance of point to the line segment defined by start and end.

This function may be used to help with the implementation of the selectTest function for specific plottables.

Note
This function is identical to QCPAbstractItem::distSqrToLine
QCPLayerable * QCPLayerable::parentLayerable ( ) const
inlineinherited

Returns the parent layerable of this layerable. The parent layerable is used to provide visibility hierarchies in conjunction with the method realVisibility. This way, layerables only get drawn if their parent layerables are visible, too.

Note that a parent layerable is not necessarily also the QObject parent for memory management. Further, a layerable doesn't always have a parent layerable, so this function may return 0.

A parent layerable is set implicitly with when placed inside layout elements and doesn't need to be set manually by the user.

void QCPLayerable::setVisible ( bool  on)
inherited

Sets the visibility of this layerable object. If an object is not visible, it will not be drawn on the QCustomPlot surface, and user interaction with it (e.g. click and selection) is not possible.

bool QCPLayerable::setLayer ( QCPLayer layer)
inherited

Sets the layer of this layerable object. The object will be placed on top of the other objects already on layer.

Returns true on success, i.e. if layer is a valid layer.

bool QCPLayerable::setLayer ( const QString &  layerName)
inherited

This is an overloaded function.

Sets the layer of this layerable object by name

Returns true on success, i.e. if layerName is a valid layer name.

void QCPLayerable::setAntialiased ( bool  enabled)
inherited

Sets whether this object will be drawn antialiased or not.

Note that antialiasing settings may be overridden by QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements.

bool QCPLayerable::realVisibility ( ) const
inherited

Returns whether this layerable is visible, taking possible direct layerable parent visibility into account. This is the method that is consulted to decide whether a layerable shall be drawn or not.

If this layerable has a direct layerable parent (usually set via hierarchies implemented in subclasses, like in the case of QCPLayoutElement), this function returns true only if this layerable has its visibility set to true and the parent layerable's realVisibility returns true.

If this layerable doesn't have a direct layerable parent, returns the state of this layerable's visibility.

void QCPLayerable::parentPlotInitialized ( QCustomPlot parentPlot)
protectedvirtualinherited

This function is called by initializeParentPlot, to allow subclasses to react on the setting of a parent plot. This is the case when 0 was passed as parent plot in the constructor, and the parent plot is set at a later time.

For example, QCPLayoutElement/QCPLayout hierarchies may be created independently of any QCustomPlot at first. When they are then added to a layout inside the QCustomPlot, the top level element of the hierarchy gets its parent plot initialized with initializeParentPlot. To propagate the parent plot to all the children of the hierarchy, the top level element then uses this function to pass the parent plot on to its child elements.

The default implementation does nothing.

See Also
initializeParentPlot

Reimplemented in QCPLegend, and QCPLayoutElement.

void QCPLayerable::initializeParentPlot ( QCustomPlot parentPlot)
protectedinherited

Sets the parent plot of this layerable. Use this function once to set the parent plot if you have passed 0 in the constructor. It can not be used to move a layerable from one QCustomPlot to another one.

Note that, unlike when passing a non-null parent plot in the constructor, this function does not make parentPlot the QObject-parent of this layerable. If you want this, call QObject::setParent(parentPlot) in addition to this function.

Further, you will probably want to set a layer (setLayer) after calling this function, to make the layerable appear on the QCustomPlot.

The parent plot change will be propagated to subclasses via a call to parentPlotInitialized so they can react accordingly (e.g. also initialize the parent plot of child layerables, like QCPLayout does).

void QCPLayerable::setParentLayerable ( QCPLayerable parentLayerable)
protectedinherited

Sets the parent layerable of this layerable to parentLayerable. Note that parentLayerable does not become the QObject-parent (for memory management) of this layerable.

The parent layerable has influence on the return value of the realVisibility method. Only layerables with a fully visible parent tree will return true for realVisibility, and thus be drawn.

See Also
realVisibility
bool QCPLayerable::moveToLayer ( QCPLayer layer,
bool  prepend 
)
protectedinherited

Moves this layerable object to layer. If prepend is true, this object will be prepended to the new layer's list, i.e. it will be drawn below the objects already on the layer. If it is false, the object will be appended.

Returns true on success, i.e. if layer is a valid layer.

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

Sets the QCPainter::setAntialiasing state on the provided painter, depending on the localAntialiased value as well as the overrides QCustomPlot::setAntialiasedElements and QCustomPlot::setNotAntialiasedElements. Which override enum this function takes into account is controlled via overrideElement.


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