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

A bracket for referencing/highlighting certain parts in the plot. More...

#include <plot2d.h>

Inheritance diagram for QCPItemBracket:
QCPAbstractItem QCPLayerable

Public Types

enum  BracketStyle { bsSquare, bsRound, bsCurly, bsCalligraphic }

Public Member Functions

 QCPItemBracket (QCustomPlot *parentPlot)
virtual ~QCPItemBracket ()
QPen pen () const
QPen selectedPen () const
double length () const
BracketStyle style () const
void setPen (const QPen &pen)
void setSelectedPen (const QPen &pen)
void setLength (double length)
void setStyle (BracketStyle style)
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 left
QCPItemPosition *const right
QCPItemAnchor *const center

Protected Types

enum  AnchorIndex { aiCenter }

Protected Member Functions

virtual void draw (QCPPainter *painter)
virtual QPointF anchorPixelPoint (int anchorId) const
QPen mainPen () 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
double mLength
BracketStyle mStyle
- 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 bracket for referencing/highlighting certain parts in the plot.

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

It has two positions, left and right, which define the span of the bracket. If left is actually farther to the left than right, the bracket is opened to the bottom, as shown in the example image.

The bracket supports multiple styles via setStyle. The length, i.e. how far the bracket stretches away from the embraced span, can be controlled with setLength.

Demonstrating the effect of different values for setLength, for styles bsCalligraphic and bsSquare. Anchors and positions are displayed for reference.

It provides an anchor center, to allow connection of other items, e.g. an arrow (QCPItemLine or QCPItemCurve) or a text label (QCPItemText), to the bracket.

Member Enumeration Documentation


A brace with angled edges.


A brace with round edges.


A curly brace.


A curly brace with varying stroke width giving a calligraphic impression.

Constructor & Destructor Documentation

QCPItemBracket::QCPItemBracket ( QCustomPlot parentPlot)

Creates a bracket item and sets default values.

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

QCPItemBracket::~QCPItemBracket ( )

Member Function Documentation

QPointF QCPItemBracket::anchorPixelPoint ( int  anchorId) const

Reimplemented from QCPAbstractItem.

void QCPItemBracket::draw ( QCPPainter painter)

Implements QCPAbstractItem.

double QCPItemBracket::length ( ) const
QPen QCPItemBracket::mainPen ( ) const
QPen QCPItemBracket::pen ( ) const
QPen QCPItemBracket::selectedPen ( ) const
double QCPItemBracket::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 QCPItemBracket::setLength ( double  length)

Sets the length in pixels how far the bracket extends in the direction towards the embraced span of the bracket (i.e. perpendicular to the left-right-direction)

Demonstrating the effect of different values for setLength, for styles bsCalligraphic and bsSquare. Anchors and positions are displayed for reference.
void QCPItemBracket::setPen ( const QPen &  pen)

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

Note that when the style is bsCalligraphic, only the color will be taken from the pen, the stroke and width are ignored. To change the apparent stroke width of a calligraphic bracket, use setLength, which has a similar effect.

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

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

See Also
setPen, setSelected
void QCPItemBracket::setStyle ( QCPItemBracket::BracketStyle  style)

Sets the style of the bracket, i.e. the shape/visual appearance.

See Also
BracketStyle QCPItemBracket::style ( ) const

Member Data Documentation

QCPItemAnchor* const QCPItemBracket::center
QCPItemPosition* const QCPItemBracket::left
double QCPItemBracket::mLength
QPen QCPItemBracket::mPen
QPen QCPItemBracket::mSelectedPen
BracketStyle QCPItemBracket::mStyle
QCPItemPosition* const QCPItemBracket::right

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