QCPItemLine
Public Attributes | |
QCPItemPosition *const | end |
QCPItemPosition *const | start |
Public Attributes inherited from QObject | |
typedef | QObjectList |
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 |
Detailed Description
A line from one point to another.
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 6407 of file qcustomplot.h.
Constructor & Destructor Documentation
◆ QCPItemLine()
|
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 29038 of file qcustomplot.cpp.
◆ ~QCPItemLine()
|
overridevirtual |
Definition at line 29050 of file qcustomplot.cpp.
Member Function Documentation
◆ draw()
|
overrideprotectedvirtual |
Draws this item with the provided painter.
The cliprect of the provided painter is set to the rect returned by clipRect before this function is called. The clipRect depends on the clipping settings defined by setClipToAxisRect and setClipAxisRect.
Implements QCPAbstractItem.
Definition at line 29111 of file qcustomplot.cpp.
◆ getRectClippedLine()
|
protected |
Returns the section of the line defined by start and end, that is visible in the specified rect.
This is a helper function for draw.
Definition at line 29141 of file qcustomplot.cpp.
◆ head()
|
inline |
Definition at line 6423 of file qcustomplot.h.
◆ mainPen()
|
protected |
Returns the pen that should be used for drawing lines. Returns mPen when the item is not selected and mSelectedPen when it is.
Definition at line 29239 of file qcustomplot.cpp.
◆ pen()
|
inline |
Definition at line 6421 of file qcustomplot.h.
◆ selectedPen()
|
inline |
Definition at line 6422 of file qcustomplot.h.
◆ selectTest()
|
overridevirtual |
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 nullptr
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 29101 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.
- See also
- setTail
Definition at line 29082 of file qcustomplot.cpp.
◆ setPen()
Sets the pen that will be used to draw the line
- See also
- setSelectedPen
Definition at line 29059 of file qcustomplot.cpp.
◆ setSelectedPen()
Sets the pen that will be used to draw the line when selected
- See also
- setPen, setSelected
Definition at line 29069 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.
- See also
- setHead
Definition at line 29095 of file qcustomplot.cpp.
◆ tail()
|
inline |
Definition at line 6424 of file qcustomplot.h.
Member Data Documentation
◆ end
QCPItemPosition* const QCPItemLine::end |
Definition at line 6436 of file qcustomplot.h.
◆ mHead
|
protected |
Definition at line 6441 of file qcustomplot.h.
◆ mPen
|
protected |
Definition at line 6440 of file qcustomplot.h.
◆ mSelectedPen
|
protected |
Definition at line 6440 of file qcustomplot.h.
◆ mTail
|
protected |
Definition at line 6441 of file qcustomplot.h.
◆ start
QCPItemPosition* const QCPItemLine::start |
Definition at line 6435 of file qcustomplot.h.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:19:05 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.