iCub-main
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
QCPItemStraightLine Class Reference

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

#include <qcustomplot.h>

+ Inheritance diagram for QCPItemStraightLine:

Public Member Functions

 QCPItemStraightLine (QCustomPlot *parentPlot)
 Creates a straight line item and sets default values. More...
 
virtual ~QCPItemStraightLine ()
 
QPen pen () const
 
QPen selectedPen () const
 
void setPen (const QPen &pen)
 Sets the pen that will be used to draw the line. More...
 
void setSelectedPen (const QPen &pen)
 Sets the pen that will be used to draw the line when selected. More...
 
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. More...
 
- Public Member Functions inherited from QCPAbstractItem
 QCPAbstractItem (QCustomPlot *parentPlot)
 Base class constructor which initializes base class members. More...
 
virtual ~QCPAbstractItem ()
 
bool clipToAxisRect () const
 
QCPAxisRectclipAxisRect () 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. More...
 
void setClipAxisRect (QCPAxisRect *rect)
 Sets the clip axis rect. More...
 
Q_SLOT void setSelectable (bool selectable)
 Sets whether the user can (de-)select this item by clicking on the QCustomPlot surface. More...
 
Q_SLOT void setSelected (bool selected)
 Sets whether this item is selected or not. More...
 
QList< QCPItemPosition * > positions () const
 Returns all positions of the item in a list. More...
 
QList< QCPItemAnchor * > anchors () const
 Returns all anchors of the item in a list. More...
 
QCPItemPositionposition (const QString &name) const
 Returns the QCPItemPosition with the specified name. More...
 
QCPItemAnchoranchor (const QString &name) const
 Returns the QCPItemAnchor with the specified name. More...
 
bool hasAnchor (const QString &name) const
 Returns whether this item has an anchor with the specified name. More...
 
- Public Member Functions inherited from QCPLayerable
 QCPLayerable (QCustomPlot *plot, QString targetLayer="", QCPLayerable *parentLayerable=0)
 Creates a new QCPLayerable instance. More...
 
 ~QCPLayerable ()
 
bool visible () const
 
QCustomPlotparentPlot () const
 
QCPLayerableparentLayerable () const
 Returns the parent layerable of this layerable. More...
 
QCPLayerlayer () const
 
bool antialiased () const
 
void setVisible (bool on)
 Sets the visibility of this layerable object. More...
 
Q_SLOT bool setLayer (QCPLayer *layer)
 Sets the layer of this layerable object. More...
 
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. More...
 
void setAntialiased (bool enabled)
 Sets whether this object will be drawn antialiased or not. More...
 
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. More...
 

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
 
QCustomPlotmParentPlot
 
QPointer< QCPLayerablemParentLayerable
 
QCPLayermLayer
 
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. More...
 
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. More...
 

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

Constructor & Destructor Documentation

◆ QCPItemStraightLine()

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

◆ ~QCPItemStraightLine()

QCPItemStraightLine::~QCPItemStraightLine ( )
virtual

Definition at line 19326 of file qcustomplot.cpp.

Member Function Documentation

◆ distToStraightLine()

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

Definition at line 19383 of file qcustomplot.cpp.

◆ draw()

void QCPItemStraightLine::draw ( QCPPainter painter)
protectedvirtual

Implements QCPAbstractItem.

Definition at line 19361 of file qcustomplot.cpp.

◆ getRectClippedStraightLine()

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

Definition at line 19395 of file qcustomplot.cpp.

◆ mainPen()

QPen QCPItemStraightLine::mainPen ( ) const
protected

Definition at line 19479 of file qcustomplot.cpp.

◆ pen()

QPen QCPItemStraightLine::pen ( ) const
inline

Definition at line 3014 of file qcustomplot.h.

◆ selectedPen()

QPen QCPItemStraightLine::selectedPen ( ) const
inline

Definition at line 3015 of file qcustomplot.h.

◆ selectTest()

double QCPItemStraightLine::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 19351 of file qcustomplot.cpp.

◆ setPen()

void QCPItemStraightLine::setPen ( const QPen &  pen)

Sets the pen that will be used to draw the line.

See also
setSelectedPen

Definition at line 19335 of file qcustomplot.cpp.

◆ setSelectedPen()

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

Member Data Documentation

◆ mPen

QPen QCPItemStraightLine::mPen
protected

Definition at line 3029 of file qcustomplot.h.

◆ mSelectedPen

QPen QCPItemStraightLine::mSelectedPen
protected

Definition at line 3029 of file qcustomplot.h.

◆ point1

QCPItemPosition* const QCPItemStraightLine::point1

Definition at line 3024 of file qcustomplot.h.

◆ point2

QCPItemPosition* const QCPItemStraightLine::point2

Definition at line 3025 of file qcustomplot.h.


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