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

#include <plot2d.h>

Inheritance diagram for QCPCurve:

Public Types
enum	LineStyle { lsNone, lsLine }

Public Member Functions
	QCPCurve (QCPAxis keyAxis, QCPAxis valueAxis)

virtual	~QCPCurve ()

const QCPCurveDataMap *	data () const

QCP::ScatterStyle	scatterStyle () const

double	scatterSize () const

QPixmap	scatterPixmap () 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 (QCP::ScatterStyle style)

void	setScatterSize (double size)

void	setScatterPixmap (const QPixmap &pixmap)

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

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

virtual	~QCPAbstractPlottable ()

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)

void	setSelectable (bool selectable)

void	setSelected (bool selected)

void	rescaleAxes (bool onlyEnlarge=false) const

void	rescaleKeyAxis (bool onlyEnlarge=false) const

void	rescaleValueAxis (bool onlyEnlarge=false) const

virtual bool	addToLegend ()

virtual bool	removeFromLegend () const

Public Member Functions inherited from QCPLayerable
	QCPLayerable (QCustomPlot *parentPlot)

	~QCPLayerable ()

bool	visible () const

QCustomPlot *	parentPlot () const

QCPLayer *	layer () const

bool	antialiased () const

void	setVisible (bool on)

bool	setLayer (QCPLayer *layer)

bool	setLayer (const QString &layerName)

void	setAntialiased (bool enabled)

Protected Member Functions
virtual void	draw (QCPPainter *painter)

virtual void	drawLegendIcon (QCPPainter *painter, const QRect &rect) 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) const

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

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

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

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	applyDefaultAntialiasingHint (QCPPainter *painter) 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
bool	moveToLayer (QCPLayer *layer, bool prepend)

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

Protected Attributes
QCPCurveDataMap *	mData

QCP::ScatterStyle	mScatterStyle

double	mScatterSize

QPixmap	mScatterPixmap

LineStyle	mLineStyle

Protected Attributes inherited from QCPAbstractPlottable
QString	mName

bool	mAntialiasedFill

bool	mAntialiasedScatters

bool	mAntialiasedErrorBars

QPen	mPen

QPen	mSelectedPen

QBrush	mBrush

QBrush	mSelectedBrush

QCPAxis *	mKeyAxis

QCPAxis *	mValueAxis

bool	mSelected

bool	mSelectable

Protected Attributes inherited from QCPLayerable
bool	mVisible

QCustomPlot *	mParentPlot

QCPLayer *	mLayer

bool	mAntialiased

Friends
class	QCustomPlot

class	QCPLegend

Additional Inherited Members
Signals inherited from QCPAbstractPlottable
void	selectionChanged (bool selected)

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

Detailed Description

A plottable representing a parametric curve in a plot.

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

enum QCPCurve::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.

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.

QCPCurve::~QCPCurve ( )

virtual

Member Function Documentation

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

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

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

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

void QCPCurve::clearData ( )

virtual

Removes all data points.

See Also: removeData, removeDataAfter, removeDataBefore

Implements QCPAbstractPlottable.

const QCPCurveDataMap* QCPCurve::data ( ) const

inline

void QCPCurve::draw ( QCPPainter * painter )

protectedvirtual

Implements QCPAbstractPlottable.

void QCPCurve::drawLegendIcon	(	QCPPainter *	painter,
		const QRect &	rect
	)		const

protectedvirtual

Implements QCPAbstractPlottable.

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

protectedvirtual

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

protected

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

protectedvirtual

Implements QCPAbstractPlottable.

QCPRange QCPCurve::getValueRange	(	bool &	validRange,
		SignDomain	inSignDomain = `sdBoth`
	)		const

protectedvirtual

Implements QCPAbstractPlottable.

LineStyle QCPCurve::lineStyle ( ) const

inline

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

protected

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

protected

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

void QCPCurve::removeDataAfter ( double t )

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

See Also: addData, clearData

void QCPCurve::removeDataBefore ( double t )

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

See Also: addData, clearData

QPixmap QCPCurve::scatterPixmap ( ) const

inline

double QCPCurve::scatterSize ( ) const

inline

QCP::ScatterStyle QCPCurve::scatterStyle ( ) const

inline

double QCPCurve::selectTest ( const QPointF & pos ) const

virtual

This function is used to decide whether a click hits a plottable 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 plottable (e.g. to the scatters/lines of a graph). If the plottable is either invisible, contains no data or the distance couldn't be determined, -1.0 is returned. setSelectable has no influence on the return value of this function.

If the plottable is represented not by single lines but by an area like QCPBars or QCPStatisticalBox, a click inside the area returns a constant value greater zero (typically 99% of the selectionTolerance of the parent QCustomPlot). 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.

See Also: setSelected, QCustomPlot::setInteractions

Implements QCPAbstractPlottable.

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 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.

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.

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::setScatterPixmap ( const QPixmap & pixmap )

If the scatter style (setScatterStyle) is set to ssPixmap, this function defines the QPixmap that will be drawn centered on the data point coordinate.

See Also: ScatterStyle

void QCPCurve::setScatterSize ( double size )

This defines how big (in pixels) single scatters are drawn, if scatter style (setScatterStyle) isn't QCP::ssNone, QCP::ssDot or QCP::ssPixmap. Floating point values are allowed for fine grained control over optical appearance with antialiased painting.

See Also: ScatterStyle

void QCPCurve::setScatterStyle ( QCP::ScatterStyle style )

Sets the visual appearance of single data points in the plot. If set to QCP::ssNone, no scatter points are drawn (e.g. for line-only-plots with appropriate line style).

See Also: ScatterStyle, setLineStyle

Friends And Related Function Documentation

friend class QCPLegend

friend

friend class QCustomPlot

friend

Member Data Documentation

QCPCurveDataMap* QCPCurve::mData

protected

LineStyle QCPCurve::mLineStyle

protected

QPixmap QCPCurve::mScatterPixmap

protected

double QCPCurve::mScatterSize

protected

QCP::ScatterStyle QCPCurve::mScatterStyle

protected

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

C:/Users/mpeniak/Dropbox/Aquila/trunk/aquila/include/plot2d.h
C:/Users/mpeniak/Dropbox/Aquila/trunk/aquila/src/plot2d.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Changing the appearance

Usage

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation