Aquila  2.0 prealpha
Cognitive Robotics Architecture
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
QCPItemRect Class Reference

A rectangle. More...

#include <plot2d.h>

Inheritance diagram for QCPItemRect:
QCPAbstractItem QCPLayerable

Public Member Functions

 QCPItemRect (QCustomPlot *parentPlot)
virtual ~QCPItemRect ()
QPen pen () const
QPen selectedPen () const
QBrush brush () const
QBrush selectedBrush () const
void setPen (const QPen &pen)
void setSelectedPen (const QPen &pen)
void setBrush (const QBrush &brush)
void setSelectedBrush (const QBrush &brush)
virtual double selectTest (const QPointF &pos) const
- Public Member Functions inherited from QCPAbstractItem
 QCPAbstractItem (QCustomPlot *parentPlot)
virtual ~QCPAbstractItem ()
bool clipToAxisRect () const
QCPAxisclipKeyAxis () const
QCPAxisclipValueAxis () const
bool selectable () const
bool selected () const
void setClipToAxisRect (bool clip)
void setClipAxes (QCPAxis *keyAxis, QCPAxis *valueAxis)
void setClipKeyAxis (QCPAxis *axis)
void setClipValueAxis (QCPAxis *axis)
void setSelectable (bool selectable)
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 *parentPlot)
 ~QCPLayerable ()
bool visible () const
QCustomPlotparentPlot () const
QCPLayerlayer () const
bool antialiased () const
void setVisible (bool on)
bool setLayer (QCPLayer *layer)
bool setLayer (const QString &layerName)
void setAntialiased (bool enabled)

Public Attributes

QCPItemPosition *const topLeft
QCPItemPosition *const bottomRight
QCPItemAnchor *const top
QCPItemAnchor *const topRight
QCPItemAnchor *const right
QCPItemAnchor *const bottom
QCPItemAnchor *const bottomLeft
QCPItemAnchor *const left

Protected Types

enum  AnchorIndex {
  aiTop, aiTopRight, aiRight, aiBottom,
  aiBottomLeft, aiLeft

Protected Member Functions

virtual void draw (QCPPainter *painter)
virtual QPointF anchorPixelPoint (int anchorId) const
QPen mainPen () const
QBrush mainBrush () const
- Protected Member Functions inherited from QCPAbstractItem
virtual QRect clipRect () const
virtual void applyDefaultAntialiasingHint (QCPPainter *painter) 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
bool moveToLayer (QCPLayer *layer, bool prepend)
void applyAntialiasingHint (QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const

Protected Attributes

QPen mPen
QPen mSelectedPen
QBrush mBrush
QBrush mSelectedBrush
- Protected Attributes inherited from QCPAbstractItem
bool mClipToAxisRect
bool mSelectable
bool mSelected
QList< QCPItemPosition * > mPositions
QList< QCPItemAnchor * > mAnchors
- Protected Attributes inherited from QCPLayerable
bool mVisible
bool mAntialiased

Additional Inherited Members

- Signals inherited from QCPAbstractItem
void selectionChanged (bool selected)

Detailed Description

A rectangle.

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

It has two positions, topLeft and bottomRight, which define the rectangle.

Member Enumeration Documentation

enum QCPItemRect::AnchorIndex

Constructor & Destructor Documentation

QCPItemRect::QCPItemRect ( QCustomPlot parentPlot)

Creates a rectangle item and sets default values.

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

QCPItemRect::~QCPItemRect ( )

Member Function Documentation

QPointF QCPItemRect::anchorPixelPoint ( int  anchorId) const

Reimplemented from QCPAbstractItem.

QBrush QCPItemRect::brush ( ) const
void QCPItemRect::draw ( QCPPainter painter)

Implements QCPAbstractItem.

QBrush QCPItemRect::mainBrush ( ) const
QPen QCPItemRect::mainPen ( ) const
QPen QCPItemRect::pen ( ) const
QBrush QCPItemRect::selectedBrush ( ) const
QPen QCPItemRect::selectedPen ( ) const
double QCPItemRect::selectTest ( const QPointF &  pos) const

This function is used to decide whether a click hits an item 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 item. If the item is either invisible or the distance couldn't be determined, -1.0 is returned. setSelectable has no influence on the return value of this function.

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 99% of the selectionTolerance of the parent QCustomPlot). 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.

See Also
setSelected, QCustomPlot::setInteractions

Implements QCPAbstractItem.

void QCPItemRect::setBrush ( const QBrush &  brush)

Sets the brush that will be used to fill the rectangle. To disable filling, set brush to Qt::NoBrush.

See Also
setSelectedBrush, setPen
void QCPItemRect::setPen ( const QPen &  pen)

Sets the pen that will be used to draw the line of the rectangle

See Also
setSelectedPen, setBrush
void QCPItemRect::setSelectedBrush ( const QBrush &  brush)

Sets the brush that will be used to fill the rectangle when selected. To disable filling, set brush to Qt::NoBrush.

See Also
void QCPItemRect::setSelectedPen ( const QPen &  pen)

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

See Also
setPen, setSelected

Member Data Documentation

QCPItemAnchor* const QCPItemRect::bottom
QCPItemAnchor* const QCPItemRect::bottomLeft
QCPItemPosition* const QCPItemRect::bottomRight
QCPItemAnchor* const QCPItemRect::left
QBrush QCPItemRect::mBrush
QPen QCPItemRect::mPen
QBrush QCPItemRect::mSelectedBrush
QPen QCPItemRect::mSelectedPen
QCPItemAnchor* const QCPItemRect::right
QCPItemAnchor* const QCPItemRect::top
QCPItemPosition* const QCPItemRect::topLeft
QCPItemAnchor* const QCPItemRect::topRight

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