A line from one point to another. More...

#include <qcustomplot.h>

Inheritance diagram for QCPItemLine:

Public Member Functions
QCPLineEnding	head () const

QPen	pen () const

	QCPItemLine (QCustomPlot *parentPlot)

QPen	selectedPen () const

virtual double	selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const Q_DECL_OVERRIDE

void	setHead (const QCPLineEnding &head)

void	setPen (const QPen &pen)

void	setSelectedPen (const QPen &pen)

void	setTail (const QCPLineEnding &tail)

QCPLineEnding	tail () const

virtual	~QCPItemLine ()

Public Member Functions inherited from QCPAbstractItem
QCPItemAnchor *	anchor (const QString &name) const

QList< QCPItemAnchor * >	anchors () const

QCPAxisRect *	clipAxisRect () const

bool	clipToAxisRect () const

bool	hasAnchor (const QString &name) const

QCPItemPosition *	position (const QString &name) const

QList< QCPItemPosition * >	positions () const

	QCPAbstractItem (QCustomPlot *parentPlot)

bool	selectable () const

bool	selected () const

void	setClipAxisRect (QCPAxisRect *rect)

void	setClipToAxisRect (bool clip)

Q_SLOT void	setSelectable (bool selectable)

Q_SLOT void	setSelected (bool selected)

virtual	~QCPAbstractItem ()

Public Member Functions inherited from QCPLayerable
bool	antialiased () const

QCPLayer *	layer () const

QCPLayerable *	parentLayerable () const

QCustomPlot *	parentPlot () const

	QCPLayerable (QCustomPlot plot, QString targetLayer=QString(), QCPLayerable parentLayerable=0)

bool	realVisibility () const

void	setAntialiased (bool enabled)

Q_SLOT bool	setLayer (QCPLayer *layer)

bool	setLayer (const QString &layerName)

void	setVisible (bool on)

bool	visible () const

virtual	~QCPLayerable ()

Public Attributes
QCPItemPosition *const	end

QCPItemPosition *const	start

Protected Member Functions
virtual void	draw (QCPPainter *painter) Q_DECL_OVERRIDE

QLineF	getRectClippedLine (const QCPVector2D &start, const QCPVector2D &end, const QRect &rect) const

QPen	mainPen () const

Protected Member Functions inherited from QCPAbstractItem
virtual QPointF	anchorPixelPosition (int anchorId) const

virtual void	applyDefaultAntialiasingHint (QCPPainter *painter) const Q_DECL_OVERRIDE

virtual QRect	clipRect () const Q_DECL_OVERRIDE

QCPItemAnchor *	createAnchor (const QString &name, int anchorId)

QCPItemPosition *	createPosition (const QString &name)

virtual void	deselectEvent (bool *selectionStateChanged) Q_DECL_OVERRIDE

double	rectDistance (const QRectF &rect, const QPointF &pos, bool filledRect) const

virtual void	selectEvent (QMouseEvent event, bool additive, const QVariant &details, bool selectionStateChanged) Q_DECL_OVERRIDE

virtual QCP::Interaction	selectionCategory () const Q_DECL_OVERRIDE

Protected Member Functions inherited from QCPLayerable
void	applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const

void	initializeParentPlot (QCustomPlot *parentPlot)

virtual void	mouseDoubleClickEvent (QMouseEvent *event, const QVariant &details)

virtual void	mouseMoveEvent (QMouseEvent *event, const QPointF &startPos)

virtual void	mousePressEvent (QMouseEvent *event, const QVariant &details)

virtual void	mouseReleaseEvent (QMouseEvent *event, const QPointF &startPos)

bool	moveToLayer (QCPLayer *layer, bool prepend)

virtual void	parentPlotInitialized (QCustomPlot *parentPlot)

void	setParentLayerable (QCPLayerable *parentLayerable)

virtual void	wheelEvent (QWheelEvent *event)

Protected Attributes
QCPLineEnding	mHead

QPen	mPen

QPen	mSelectedPen

QCPLineEnding	mTail

Protected Attributes inherited from QCPAbstractItem
QList< QCPItemAnchor * >	mAnchors

QPointer< QCPAxisRect >	mClipAxisRect

bool	mClipToAxisRect

QList< QCPItemPosition * >	mPositions

bool	mSelectable

bool	mSelected

Protected Attributes inherited from QCPLayerable
bool	mAntialiased

QCPLayer *	mLayer

QPointer< QCPLayerable >	mParentLayerable

QCustomPlot *	mParentPlot

bool	mVisible

Additional Inherited Members
Signals inherited from QCPAbstractItem
void	selectableChanged (bool selectable)

void	selectionChanged (bool selected)

Signals inherited from QCPLayerable
void	layerChanged (QCPLayer *newLayer)

Detailed Description

A line from one point to another.

Line example. Blue dotted circles are anchors, solid blue discs are positions.

It has two positions, start and end, which define the end points of the line.

With setHead and setTail you may set different line ending styles, e.g. to create an arrow.

Definition at line 6134 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPItemLine()

QCPItemLine::QCPItemLine ( QCustomPlot * parentPlot )

explicit

Creates a line item and sets default values.

The created item is automatically registered with parentPlot. This QCustomPlot instance takes ownership of the item, so do not delete it manually but use QCustomPlot::removeItem() instead.

Definition at line 28266 of file qcustomplot.cpp.

◆ ~QCPItemLine()

QCPItemLine::~QCPItemLine ( )

virtual

Definition at line 28278 of file qcustomplot.cpp.

Member Function Documentation

◆ draw()

void QCPItemLine::draw ( QCPPainter * painter )

protectedvirtual

Implements QCPAbstractItem.

Definition at line 28339 of file qcustomplot.cpp.

◆ getRectClippedLine()

QLineF QCPItemLine::getRectClippedLine	(	const QCPVector2D &	start,
		const QCPVector2D &	end,
		const QRect &	rect
	)		const

protected

Definition at line 28369 of file qcustomplot.cpp.

◆ head()

QCPLineEnding QCPItemLine::head ( ) const

inline

Definition at line 6150 of file qcustomplot.h.

◆ mainPen()

QPen QCPItemLine::mainPen ( ) const

protected

Definition at line 28467 of file qcustomplot.cpp.

◆ pen()

QPen QCPItemLine::pen ( ) const

inline

Definition at line 6148 of file qcustomplot.h.

◆ selectedPen()

QPen QCPItemLine::selectedPen ( ) const

inline

Definition at line 6149 of file qcustomplot.h.

◆ selectTest()

double QCPItemLine::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 object is represented not by single lines but by an area like a QCPItemText or the bars of a QCPBars plottable, a click inside the area should also be considered a hit. In these cases this function thus returns a constant value greater zero but still below the parent plot's selection tolerance. (typically the selectionTolerance multiplied by 0.99).

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.

In the case of 1D Plottables (QCPAbstractPlottable1D, like QCPGraph or QCPBars) details will be set to a QCPDataSelection, describing the closest data point to pos.

You may pass 0 as details to indicate that you are not interested in those selection details.

See also: selectEvent, deselectEvent, mousePressEvent, wheelEvent, QCustomPlot::setInteractions, QCPAbstractPlottable1D::selectTestRect

Implements QCPAbstractItem.

Definition at line 28329 of file qcustomplot.cpp.

◆ setHead()

void QCPItemLine::setHead ( const QCPLineEnding & head )

Sets the line ending style of the head. The head corresponds to the end position.

Note that due to the overloaded QCPLineEnding constructor, you may directly specify a QCPLineEnding::EndingStyle here, e.g.

setHead(QCPLineEnding::esSpikeArrow)

See also: setTail

Definition at line 28310 of file qcustomplot.cpp.

◆ setPen()

void QCPItemLine::setPen ( const QPen & pen )

Sets the pen that will be used to draw the line

See also: setSelectedPen

Definition at line 28287 of file qcustomplot.cpp.

◆ setSelectedPen()

void QCPItemLine::setSelectedPen ( const QPen & pen )

Sets the pen that will be used to draw the line when selected

See also: setPen, setSelected

Definition at line 28297 of file qcustomplot.cpp.

◆ setTail()

void QCPItemLine::setTail ( const QCPLineEnding & tail )

Sets the line ending style of the tail. The tail corresponds to the start position.

Note that due to the overloaded QCPLineEnding constructor, you may directly specify a QCPLineEnding::EndingStyle here, e.g.

setTail(QCPLineEnding::esSpikeArrow)

See also: setHead

Definition at line 28323 of file qcustomplot.cpp.

◆ tail()

QCPLineEnding QCPItemLine::tail ( ) const

inline

Definition at line 6151 of file qcustomplot.h.

Member Data Documentation

◆ end

QCPItemPosition* const QCPItemLine::end

Definition at line 6163 of file qcustomplot.h.

◆ mHead

QCPLineEnding QCPItemLine::mHead

protected

Definition at line 6168 of file qcustomplot.h.

◆ mPen

QPen QCPItemLine::mPen

protected

Definition at line 6167 of file qcustomplot.h.

◆ mSelectedPen

QPen QCPItemLine::mSelectedPen

protected

Definition at line 6167 of file qcustomplot.h.

◆ mTail

QCPLineEnding QCPItemLine::mTail

protected

Definition at line 6168 of file qcustomplot.h.

◆ start

QCPItemPosition* const QCPItemLine::start

Definition at line 6162 of file qcustomplot.h.

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

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QCPItemLine()

◆ ~QCPItemLine()

Member Function Documentation

◆ draw()

◆ getRectClippedLine()

◆ head()

◆ mainPen()

◆ pen()

◆ selectedPen()

◆ selectTest()

◆ setHead()

◆ setPen()

◆ setSelectedPen()

◆ setTail()

◆ tail()

Member Data Documentation

◆ end

◆ mHead

◆ mPen

◆ mSelectedPen

◆ mTail

◆ start