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

#include <qcustomplot.h>

Inheritance diagram for QCPItemLine:

Public Member Functions
	QCPItemLine (QCustomPlot *parentPlot)
	Creates a line item and sets default values.

virtual	~QCPItemLine ()

QPen	pen () const

QPen	selectedPen () const

QCPLineEnding	head () const

QCPLineEnding	tail () const

void	setPen (const QPen &pen)
	Sets the pen that will be used to draw the line.

void	setSelectedPen (const QPen &pen)
	Sets the pen that will be used to draw the line when selected.

void	setHead (const QCPLineEnding &head)
	Sets the line ending style of the head.

void	setTail (const QCPLineEnding &tail)
	Sets the line ending style of the tail.

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.

Public Member Functions inherited from QCPAbstractItem
	QCPAbstractItem (QCustomPlot *parentPlot)
	Base class constructor which initializes base class members.

virtual	~QCPAbstractItem ()

bool	clipToAxisRect () const

QCPAxisRect *	clipAxisRect () const

bool	selectable () const

bool	selected () const

void	setClipToAxisRect (bool clip)
	Sets whether the item shall be clipped to an axis rect or whether it shall be visible on the entire QCustomPlot.

void	setClipAxisRect (QCPAxisRect *rect)
	Sets the clip axis rect.

Q_SLOT void	setSelectable (bool selectable)
	Sets whether the user can (de-)select this item by clicking on the QCustomPlot surface.

Q_SLOT void	setSelected (bool selected)
	Sets whether this item is selected or not.

QList< QCPItemPosition * >	positions () const
	Returns all positions of the item in a list.

QList< QCPItemAnchor * >	anchors () const
	Returns all anchors of the item in a list.

QCPItemPosition *	position (const QString &name) const
	Returns the QCPItemPosition with the specified name.

QCPItemAnchor *	anchor (const QString &name) const
	Returns the QCPItemAnchor with the specified name.

bool	hasAnchor (const QString &name) const
	Returns whether this item has an anchor with the specified name.

Public Member Functions inherited from QCPLayerable
	QCPLayerable (QCustomPlot plot, QString targetLayer="", QCPLayerable parentLayerable=0)
	Creates a new QCPLayerable instance.

	~QCPLayerable ()

bool	visible () const

QCustomPlot *	parentPlot () const

QCPLayerable *	parentLayerable () const
	Returns the parent layerable of this layerable.

QCPLayer *	layer () const

bool	antialiased () const

void	setVisible (bool on)
	Sets the visibility of this layerable object.

Q_SLOT bool	setLayer (QCPLayer *layer)
	Sets the layer of this layerable object.

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.

void	setAntialiased (bool enabled)
	Sets whether this object will be drawn antialiased or not.

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.

Public Attributes
QCPItemPosition *const	start

QCPItemPosition *const	end

Protected Member Functions
virtual void	draw (QCPPainter *painter)

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

QPen	mainPen () const

Protected Member Functions inherited from QCPAbstractItem
virtual QCP::Interaction	selectionCategory () const

virtual QRect	clipRect () const

virtual void	applyDefaultAntialiasingHint (QCPPainter *painter) const

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

virtual void	deselectEvent (bool *selectionStateChanged)

virtual QPointF	anchorPixelPoint (int anchorId) const

double	distSqrToLine (const QPointF &start, const QPointF &end, const QPointF &point) const

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

QCPItemPosition *	createPosition (const QString &name)

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

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

QPen	mSelectedPen

QCPLineEnding	mHead

QCPLineEnding	mTail

Protected Attributes inherited from QCPAbstractItem
bool	mClipToAxisRect

QPointer< QCPAxisRect >	mClipAxisRect

QList< QCPItemPosition * >	mPositions

QList< QCPItemAnchor * >	mAnchors

bool	mSelectable

bool	mSelected

Protected Attributes inherited from QCPLayerable
bool	mVisible

QCustomPlot *	mParentPlot

QPointer< QCPLayerable >	mParentLayerable

QCPLayer *	mLayer

bool	mAntialiased

Additional Inherited Members
Signals inherited from QCPAbstractItem
void	selectionChanged (bool selected)
	This signal is emitted when the selection state of this item has changed, either by user interaction or by a direct call to setSelected.

void	selectableChanged (bool selectable)

Signals inherited from QCPLayerable
void	layerChanged (QCPLayer *newLayer)
	This signal is emitted when the layer of this layerable changes, i.e.

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 3041 of file qcustomplot.h.

Constructor & Destructor Documentation

◆ QCPItemLine()

QCPItemLine::QCPItemLine ( QCustomPlot * parentPlot )

Creates a line item and sets default values.

The constructed item can be added to the plot with QCustomPlot::addItem.

Definition at line 19504 of file qcustomplot.cpp.

◆ ~QCPItemLine()

QCPItemLine::~QCPItemLine ( )

virtual

Definition at line 19516 of file qcustomplot.cpp.

Member Function Documentation

◆ draw()

void QCPItemLine::draw ( QCPPainter * painter )

protectedvirtual

Implements QCPAbstractItem.

Definition at line 19577 of file qcustomplot.cpp.

◆ getRectClippedLine()

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

protected

Definition at line 19607 of file qcustomplot.cpp.

◆ head()

QCPLineEnding QCPItemLine::head ( ) const

inline

Definition at line 3057 of file qcustomplot.h.

◆ mainPen()

QPen QCPItemLine::mainPen ( ) const

protected

Definition at line 19705 of file qcustomplot.cpp.

◆ pen()

QPen QCPItemLine::pen ( ) const

inline

Definition at line 3055 of file qcustomplot.h.

◆ selectedPen()

QPen QCPItemLine::selectedPen ( ) const

inline

Definition at line 3056 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 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 QCPAbstractItem.

Definition at line 19567 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)

QCPItemLine::setHead

void setHead(const QCPLineEnding &head)

Sets the line ending style of the head.

Definition qcustomplot.cpp:19548

QCPLineEnding::esSpikeArrow

@ esSpikeArrow

A filled arrow head with an indented back.

Definition qcustomplot.h:889

See also: setTail

Definition at line 19548 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 19525 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 19535 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)

QCPItemLine::setTail

void setTail(const QCPLineEnding &tail)

Sets the line ending style of the tail.

Definition qcustomplot.cpp:19561

See also: setHead

Definition at line 19561 of file qcustomplot.cpp.

◆ tail()

QCPLineEnding QCPItemLine::tail ( ) const

inline

Definition at line 3058 of file qcustomplot.h.

Member Data Documentation

◆ end

QCPItemPosition* const QCPItemLine::end

Definition at line 3070 of file qcustomplot.h.

◆ mHead

QCPLineEnding QCPItemLine::mHead

protected

Definition at line 3075 of file qcustomplot.h.

◆ mPen

QPen QCPItemLine::mPen

protected

Definition at line 3074 of file qcustomplot.h.

◆ mSelectedPen

QPen QCPItemLine::mSelectedPen

protected

Definition at line 3074 of file qcustomplot.h.

◆ mTail

QCPLineEnding QCPItemLine::mTail

protected

Definition at line 3075 of file qcustomplot.h.

◆ start

QCPItemPosition* const QCPItemLine::start

Definition at line 3069 of file qcustomplot.h.

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

icub-main/src/tools/skinManagerGui/qcustomplot.h
icub-main/src/tools/skinManagerGui/qcustomplot.cpp

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