Represents the visual appearance of scatter points. More...

#include <qcustomplot.h>

Public Types
enum	ScatterShape { ssNone, ssDot, ssCross, ssPlus, ssCircle, ssDisc, ssSquare, ssDiamond, ssStar, ssTriangle, ssTriangleInverted, ssCrossSquare, ssPlusSquare, ssCrossCircle, ssPlusCircle, ssPeace, ssPixmap, ssCustom }

Public Member Functions
	QCPScatterStyle ()

	QCPScatterStyle (ScatterShape shape, double size=6)

	QCPScatterStyle (ScatterShape shape, const QColor &color, double size)

	QCPScatterStyle (ScatterShape shape, const QColor &color, const QColor &fill, double size)

	QCPScatterStyle (ScatterShape shape, const QPen &pen, const QBrush &brush, double size)

	QCPScatterStyle (const QPixmap &pixmap)

	QCPScatterStyle (const QPainterPath &customPath, const QPen &pen, const QBrush &brush=Qt::NoBrush, double size=6)

double	size () const

ScatterShape	shape () const

QPen	pen () const

QBrush	brush () const

QPixmap	pixmap () const

QPainterPath	customPath () const

void	setSize (double size)

void	setShape (ScatterShape shape)

void	setPen (const QPen &pen)

void	setBrush (const QBrush &brush)

void	setPixmap (const QPixmap &pixmap)

void	setCustomPath (const QPainterPath &customPath)

bool	isNone () const

bool	isPenDefined () const

void	applyTo (QCPPainter *painter, const QPen &defaultPen) const

void	drawShape (QCPPainter *painter, QPointF pos) const

void	drawShape (QCPPainter *painter, double x, double y) const

Protected Attributes
double	mSize

ScatterShape	mShape

QPen	mPen

QBrush	mBrush

QPixmap	mPixmap

QPainterPath	mCustomPath

bool	mPenDefined

Detailed Description

Represents the visual appearance of scatter points.

This class holds information about shape, color and size of scatter points. In plottables like QCPGraph it is used to store how scatter points shall be drawn. For example, QCPGraph::setScatterStyle takes a QCPScatterStyle instance.

A scatter style consists of a shape (setShape), a line color (setPen) and possibly a fill (setBrush), if the shape provides a fillable area. Further, the size of the shape can be controlled with setSize.

Specifying a scatter style

You can set all these configurations either by calling the respective functions on an instance:

QCPScatterStyle myScatter;
myScatter.setShape(QCPScatterStyle::ssCircle);
myScatter.setPen(Qt::blue);
myScatter.setBrush(Qt::white);
myScatter.setSize(5);
customPlot->graph(0)->setScatterStyle(myScatter);

Or you can use one of the various constructors that take different parameter combinations, making it easy to specify a scatter style in a single call, like so:

customPlot->graph(0)->setScatterStyle(QCPScatterStyle(QCPScatterStyle::ssCircle, Qt::blue, Qt::white, 5));

Leaving the color/pen up to the plottable

There are two constructors which leave the pen undefined: QCPScatterStyle() and QCPScatterStyle(ScatterShape shape, double size). If those constructors are used, a call to isPenDefined will return false. It leads to scatter points that inherit the pen from the plottable that uses the scatter style. Thus, if such a scatter style is passed to QCPGraph, the line color of the graph (QCPGraph::setPen) will be used by the scatter points. This makes it very convenient to set up typical scatter settings:

customPlot->graph(0)->setScatterStyle(QCPScatterStyle::ssPlus);

Notice that it wasn't even necessary to explicitly call a QCPScatterStyle constructor. This works because QCPScatterStyle provides a constructor that can transform a ScatterShape directly into a QCPScatterStyle instance (that's the QCPScatterStyle(ScatterShape shape, double size) constructor with a default for size). In those cases, C++ allows directly supplying a ScatterShape, where actually a QCPScatterStyle is expected.

Custom shapes and pixmaps

QCPScatterStyle supports drawing custom shapes and arbitrary pixmaps as scatter points.

For custom shapes, you can provide a QPainterPath with the desired shape to the setCustomPath function or call the constructor that takes a painter path. The scatter shape will automatically be set to ssCustom.

For pixmaps, you call setPixmap with the desired QPixmap. Alternatively you can use the constructor that takes a QPixmap. The scatter shape will automatically be set to ssPixmap. Note that setSize does not influence the appearance of the pixmap.

Definition at line 239 of file qcustomplot.h.

Member Enumeration Documentation

enum QCPScatterStyle::ScatterShape

Defines the shape used for scatter points.

On plottables/items that draw scatters, the sizes of these visualizations (with exception of ssDot and ssPixmap) can be controlled with the setSize function. Scatters are drawn with the pen and brush specified with setPen and setBrush.

Enumerator
ssNone	no scatter symbols are drawn (e.g. in QCPGraph, data only represented with lines)
ssDot	{ssDot.png} a single pixel (use ssDisc or ssCircle if you want a round shape with a certain radius)
ssCross	{ssCross.png} a cross
ssPlus	{ssPlus.png} a plus
ssCircle	{ssCircle.png} a circle
ssDisc	{ssDisc.png} a circle which is filled with the pen's color (not the brush as with ssCircle)
ssSquare	{ssSquare.png} a square
ssDiamond	{ssDiamond.png} a diamond
ssStar	{ssStar.png} a star with eight arms, i.e. a combination of cross and plus
ssTriangle	{ssTriangle.png} an equilateral triangle, standing on baseline
ssTriangleInverted	{ssTriangleInverted.png} an equilateral triangle, standing on corner
ssCrossSquare	{ssCrossSquare.png} a square with a cross inside
ssPlusSquare	{ssPlusSquare.png} a square with a plus inside
ssCrossCircle	{ssCrossCircle.png} a circle with a cross inside
ssPlusCircle	{ssPlusCircle.png} a circle with a plus inside
ssPeace	{ssPeace.png} a circle, with one vertical and two downward diagonal lines
ssPixmap	a custom pixmap specified by setPixmap, centered on the data point coordinates
ssCustom	custom painter operations are performed per scatter (As QPainterPath, see setCustomPath)

Definition at line 251 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPScatterStyle::QCPScatterStyle ( )

Creates a new QCPScatterStyle instance with size set to 6. No shape, pen or brush is defined.

Since the pen is undefined (isPenDefined returns false), the scatter color will be inherited from the plottable that uses this scatter style.

Definition at line 347 of file qcustomplot.cpp.

QCPScatterStyle::QCPScatterStyle	(	ScatterShape	shape,
		double	size = `6`
	)

Creates a new QCPScatterStyle instance with shape set to shape and size to size. No pen or brush is defined.

Since the pen is undefined (isPenDefined returns false), the scatter color will be inherited from the plottable that uses this scatter style.

Definition at line 363 of file qcustomplot.cpp.

QCPScatterStyle::QCPScatterStyle	(	ScatterShape	shape,
		const QColor &	color,
		double	size
	)

Creates a new QCPScatterStyle instance with shape set to shape, the pen color set to color, and size to size. No brush is defined, i.e. the scatter point will not be filled.

Definition at line 376 of file qcustomplot.cpp.

QCPScatterStyle::QCPScatterStyle	(	ScatterShape	shape,
		const QColor &	color,
		const QColor &	fill,
		double	size
	)

Creates a new QCPScatterStyle instance with shape set to shape, the pen color set to color, the brush color to fill (with a solid pattern), and size to size.

Definition at line 389 of file qcustomplot.cpp.

QCPScatterStyle::QCPScatterStyle	(	ScatterShape	shape,
		const QPen &	pen,
		const QBrush &	brush,
		double	size
	)

Creates a new QCPScatterStyle instance with shape set to shape, the pen set to pen, the brush to brush, and size to size.

Warning: In some cases it might be tempting to directly use a pen style like Qt::NoPen as pen and a color like Qt::blue as brush. Notice however, that the corresponding call
QCPScatterStyle(QCPScatterShape::ssCircle, Qt::NoPen, Qt::blue, 5)
doesn't necessarily lead C++ to use this constructor in some cases, but might mistake Qt::NoPen for a QColor and use the QCPScatterStyle(ScatterShape shape, const QColor &color, const QColor &fill, double size) constructor instead (which will lead to an unexpected look of the scatter points). To prevent this, be more explicit with the parameter types. For example, use QBrush(Qt::blue) instead of just Qt::blue, to clearly point out to the compiler that this constructor is wanted.

Definition at line 413 of file qcustomplot.cpp.

QCPScatterStyle::QCPScatterStyle ( const QPixmap & pixmap )

Creates a new QCPScatterStyle instance which will show the specified pixmap. The scatter shape is set to ssPixmap.

Definition at line 426 of file qcustomplot.cpp.

QCPScatterStyle::QCPScatterStyle	(	const QPainterPath &	customPath,
		const QPen &	pen,
		const QBrush &	brush = `Qt::NoBrush`,
		double	size = `6`
	)

Creates a new QCPScatterStyle instance with a custom shape that is defined via customPath. The scatter shape is set to ssCustom.

The custom shape line will be drawn with pen and filled with brush. The size has a slightly different meaning than for built-in scatter points: The custom path will be drawn scaled by a factor of size/6.0. Since the default size is 6, the custom path will appear at a its natural size by default. To double the size of the path for example, set size to 12.

Definition at line 445 of file qcustomplot.cpp.

Member Function Documentation

void QCPScatterStyle::applyTo	(	QCPPainter *	painter,
		const QPen &	defaultPen
	)		const

Applies the pen and the brush of this scatter style to painter. If this scatter style has an undefined pen (isPenDefined), sets the pen of painter to defaultPen instead.

This function is used by plottables (or any class that wants to draw scatters) just before a number of scatters with this style shall be drawn with the painter.

See also: drawShape

Definition at line 536 of file qcustomplot.cpp.

QBrush QCPScatterStyle::brush ( ) const

inline

Definition at line 283 of file qcustomplot.h.

QPainterPath QCPScatterStyle::customPath ( ) const

inline

Definition at line 285 of file qcustomplot.h.

void QCPScatterStyle::drawShape	(	QCPPainter *	painter,
		QPointF	pos
	)		const

Draws the scatter shape with painter at position pos.

This function does not modify the pen or the brush on the painter, as applyTo is meant to be called before scatter points are drawn with drawShape.

See also: applyTo

Definition at line 550 of file qcustomplot.cpp.

void QCPScatterStyle::drawShape	(	QCPPainter *	painter,
		double	x,
		double	y
	)		const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Draws the scatter shape with painter at position x and y.

Definition at line 558 of file qcustomplot.cpp.

bool QCPScatterStyle::isNone ( ) const

inline

Returns whether the scatter shape is ssNone.

See also: setShape

Definition at line 296 of file qcustomplot.h.

bool QCPScatterStyle::isPenDefined ( ) const

inline

Returns whether a pen has been defined for this scatter style.

The pen is undefined if a constructor is called that does not carry pen as parameter. Those are QCPScatterStyle() and QCPScatterStyle(ScatterShape shape, double size). If the pen is left undefined, the scatter color will be inherited from the plottable that uses this scatter style.

See also: setPen

Definition at line 297 of file qcustomplot.h.

QPen QCPScatterStyle::pen ( ) const

inline

Definition at line 282 of file qcustomplot.h.

QPixmap QCPScatterStyle::pixmap ( ) const

inline

Definition at line 284 of file qcustomplot.h.

void QCPScatterStyle::setBrush ( const QBrush & brush )

Sets the brush that will be used to fill scatter points to brush. Note that not all scatter shapes have fillable areas. For example, ssPlus does not while ssCircle does.

See also: setPen

Definition at line 498 of file qcustomplot.cpp.

void QCPScatterStyle::setCustomPath ( const QPainterPath & customPath )

Sets the custom shape that will be drawn as scatter point to customPath.

The scatter shape is automatically set to ssCustom.

Definition at line 521 of file qcustomplot.cpp.

void QCPScatterStyle::setPen ( const QPen & pen )

Sets the pen that will be used to draw scatter points to pen.

If the pen was previously undefined (see isPenDefined), the pen is considered defined after a call to this function, even if pen is Qt::NoPen.

See also: setBrush

Definition at line 486 of file qcustomplot.cpp.

void QCPScatterStyle::setPixmap ( const QPixmap & pixmap )

Sets the pixmap that will be drawn as scatter point to pixmap.

Note that setSize does not influence the appearance of the pixmap.

The scatter shape is automatically set to ssPixmap.

Definition at line 510 of file qcustomplot.cpp.

void QCPScatterStyle::setShape ( QCPScatterStyle::ScatterShape shape )

Sets the shape to shape.

Note that the calls setPixmap and setCustomPath automatically set the shape to ssPixmap and ssCustom, respectively.

See also: setSize

Definition at line 473 of file qcustomplot.cpp.

void QCPScatterStyle::setSize ( double size )

Sets the size (pixel diameter) of the drawn scatter points to size.

See also: setShape

Definition at line 460 of file qcustomplot.cpp.

ScatterShape QCPScatterStyle::shape ( ) const

inline

Definition at line 281 of file qcustomplot.h.

double QCPScatterStyle::size ( ) const

inline

Definition at line 280 of file qcustomplot.h.

Member Data Documentation

QBrush QCPScatterStyle::mBrush

protected

Definition at line 307 of file qcustomplot.h.

QPainterPath QCPScatterStyle::mCustomPath

protected

Definition at line 309 of file qcustomplot.h.

QPen QCPScatterStyle::mPen

protected

Definition at line 306 of file qcustomplot.h.

bool QCPScatterStyle::mPenDefined

protected

Definition at line 312 of file qcustomplot.h.

QPixmap QCPScatterStyle::mPixmap

protected

Definition at line 308 of file qcustomplot.h.

ScatterShape QCPScatterStyle::mShape

protected

Definition at line 305 of file qcustomplot.h.

double QCPScatterStyle::mSize

protected

Definition at line 304 of file qcustomplot.h.

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

Projects/VespucciProject/Vespucci/Vespucci/qcustomplot.h
Projects/VespucciProject/Vespucci/Vespucci/qcustomplot.cpp

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Specifying a scatter style

Leaving the color/pen up to the plottable

Custom shapes and pixmaps

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation