Vespucci  1.0.0
QCPItemStraightLine Class Reference

A straight line that spans infinitely in both directions. More...

#include <qcustomplot.h>

Inheritance diagram for QCPItemStraightLine:
QCPAbstractItem QCPLayerable

Public Member Functions

 QCPItemStraightLine (QCustomPlot *parentPlot)
virtual ~QCPItemStraightLine ()
QPen pen () const
QPen selectedPen () const
void setPen (const QPen &pen)
void setSelectedPen (const QPen &pen)
virtual double selectTest (const QPointF &pos, bool onlySelectable, QVariant *details=0) const
- Public Member Functions inherited from QCPAbstractItem
 QCPAbstractItem (QCustomPlot *parentPlot)
virtual ~QCPAbstractItem ()
bool clipToAxisRect () const
QCPAxisRectclipAxisRect () const
bool selectable () const
bool selected () const
void setClipToAxisRect (bool clip)
void setClipAxisRect (QCPAxisRect *rect)
Q_SLOT void setSelectable (bool selectable)
Q_SLOT void setSelected (bool selected)
QList< QCPItemPosition * > positions () const
QList< QCPItemAnchor * > anchors () const
QCPItemPositionposition (const QString &name) const
QCPItemAnchoranchor (const QString &name) const
bool hasAnchor (const QString &name) const
- Public Member Functions inherited from QCPLayerable
 QCPLayerable (QCustomPlot *plot, QString targetLayer=QString(), QCPLayerable *parentLayerable=0)
 ~QCPLayerable ()
bool visible () const
QCustomPlotparentPlot () const
QCPLayerableparentLayerable () const
QCPLayerlayer () const
bool antialiased () const
void setVisible (bool on)
Q_SLOT bool setLayer (QCPLayer *layer)
bool setLayer (const QString &layerName)
void setAntialiased (bool enabled)
bool realVisibility () const

Public Attributes

QCPItemPosition *const point1
QCPItemPosition *const point2

Protected Member Functions

virtual void draw (QCPPainter *painter)
double distToStraightLine (const QVector2D &point1, const QVector2D &vec, const QVector2D &point) const
QLineF getRectClippedStraightLine (const QVector2D &point1, const QVector2D &vec, 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
QCPItemPositioncreatePosition (const QString &name)
QCPItemAnchorcreateAnchor (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
- Protected Attributes inherited from QCPAbstractItem
bool mClipToAxisRect
QPointer< QCPAxisRectmClipAxisRect
QList< QCPItemPosition * > mPositions
QList< QCPItemAnchor * > mAnchors
bool mSelectable
bool mSelected
- Protected Attributes inherited from QCPLayerable
bool mVisible
QPointer< QCPLayerablemParentLayerable
bool mAntialiased

Additional Inherited Members

- Signals inherited from QCPAbstractItem
void selectionChanged (bool selected)
void selectableChanged (bool selectable)
- Signals inherited from QCPLayerable
void layerChanged (QCPLayer *newLayer)

Detailed Description

A straight line that spans infinitely in both directions.

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

It has two positions, point1 and point2, which define the straight line.

Definition at line 3287 of file qcustomplot.h.

Constructor & Destructor Documentation

QCPItemStraightLine::QCPItemStraightLine ( QCustomPlot parentPlot)

Creates a straight line item and sets default values.

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

Definition at line 21893 of file qcustomplot.cpp.

QCPItemStraightLine::~QCPItemStraightLine ( )

Definition at line 21905 of file qcustomplot.cpp.

Member Function Documentation

double QCPItemStraightLine::distToStraightLine ( const QVector2D &  point1,
const QVector2D &  vec,
const QVector2D &  point 
) const

Definition at line 21962 of file qcustomplot.cpp.

void QCPItemStraightLine::draw ( QCPPainter painter)

Implements QCPAbstractItem.

Definition at line 21940 of file qcustomplot.cpp.

QLineF QCPItemStraightLine::getRectClippedStraightLine ( const QVector2D &  point1,
const QVector2D &  vec,
const QRect &  rect 
) const

Definition at line 21974 of file qcustomplot.cpp.

QPen QCPItemStraightLine::mainPen ( ) const

Definition at line 22058 of file qcustomplot.cpp.

QPen QCPItemStraightLine::pen ( ) const

Definition at line 3299 of file qcustomplot.h.

QPen QCPItemStraightLine::selectedPen ( ) const

Definition at line 3300 of file qcustomplot.h.

double QCPItemStraightLine::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.

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 21930 of file qcustomplot.cpp.

void QCPItemStraightLine::setPen ( const QPen &  pen)

Sets the pen that will be used to draw the line

See also

Definition at line 21914 of file qcustomplot.cpp.

void QCPItemStraightLine::setSelectedPen ( const QPen &  pen)

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

See also
setPen, setSelected

Definition at line 21924 of file qcustomplot.cpp.

Member Data Documentation

QPen QCPItemStraightLine::mPen

Definition at line 3314 of file qcustomplot.h.

QPen QCPItemStraightLine::mSelectedPen

Definition at line 3314 of file qcustomplot.h.

QCPItemPosition* const QCPItemStraightLine::point1

Definition at line 3309 of file qcustomplot.h.

QCPItemPosition* const QCPItemStraightLine::point2

Definition at line 3310 of file qcustomplot.h.

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