Qwt Polar User's Guide 1.0.0
|
A plotting widget, displaying a polar coordinate system. More...
#include <qwt_polar_plot.h>
Public Types | |
enum | LegendPosition { LeftLegend, RightLegend, BottomLegend, TopLegend, ExternalLegend } |
Public Slots | |
virtual void | replot () |
void | autoRefresh () |
void | setAzimuthOrigin (double) |
Signals | |
void | legendClicked (QwtPolarItem *plotItem) |
void | legendChecked (QwtPolarItem *plotItem, bool on) |
void | layoutChanged () |
Public Member Functions | |
QwtPolarPlot (QWidget *parent=NULL) | |
QwtPolarPlot (const QwtText &title, QWidget *parent=NULL) | |
virtual | ~QwtPolarPlot () |
void | setTitle (const QString &) |
void | setTitle (const QwtText &) |
QwtText | title () const |
QwtTextLabel * | titleLabel () |
const QwtTextLabel * | titleLabel () const |
void | setAutoReplot (bool tf=true) |
bool | autoReplot () const |
void | setAutoScale (int scaleId) |
bool | hasAutoScale (int scaleId) const |
void | setScaleMaxMinor (int scaleId, int maxMinor) |
int | scaleMaxMinor (int scaleId) const |
int | scaleMaxMajor (int scaleId) const |
void | setScaleMaxMajor (int scaleId, int maxMajor) |
QwtScaleEngine * | scaleEngine (int scaleId) |
const QwtScaleEngine * | scaleEngine (int scaleId) const |
void | setScaleEngine (int scaleId, QwtScaleEngine *) |
void | setScale (int scaleId, double min, double max, double step=0) |
void | setScaleDiv (int scaleId, const QwtScaleDiv &) |
const QwtScaleDiv * | scaleDiv (int scaleId) const |
QwtScaleDiv * | scaleDiv (int scaleId) |
QwtScaleMap | scaleMap (int scaleId, double radius) const |
QwtScaleMap | scaleMap (int scaleId) const |
void | updateScale (int scaleId) |
double | azimuthOrigin () const |
void | zoom (const QwtPointPolar &, double factor) |
void | unzoom () |
QwtPointPolar | zoomPos () const |
double | zoomFactor () const |
QwtPolarCanvas * | canvas () |
const QwtPolarCanvas * | canvas () const |
void | setPlotBackground (const QBrush &c) |
const QBrush & | plotBackground () const |
virtual void | drawCanvas (QPainter *, const QRectF &) const |
void | insertLegend (QwtLegend *, LegendPosition=RightLegend, double ratio=-1.0) |
QwtLegend * | legend () |
const QwtLegend * | legend () const |
QwtPolarLayout * | plotLayout () |
const QwtPolarLayout * | plotLayout () const |
QwtInterval | visibleInterval () const |
QRectF | plotRect () const |
QRectF | plotRect (const QRectF &) const |
int | plotMarginHint () const |
Protected Slots | |
virtual void | legendItemClicked () |
virtual void | legendItemChecked (bool) |
Protected Member Functions | |
virtual bool | event (QEvent *) |
virtual void | resizeEvent (QResizeEvent *) |
virtual void | updateLayout () |
virtual void | drawItems (QPainter *painter, const QwtScaleMap &radialMap, const QwtScaleMap &azimuthMap, const QPointF &pole, double radius, const QRectF &canvasRect) const |
A plotting widget, displaying a polar coordinate system.
An unlimited number of plot items can be displayed on its canvas. Plot items might be curves (QwtPolarCurve), markers (QwtPolarMarker), the grid (QwtPolarGrid), or anything else derived from QwtPolarItem.
The coordinate system is defined by a radial and a azimuth scale. The scales at the axes can be explicitely set (QwtScaleDiv), or are calculated from the plot items, using algorithms (QwtScaleEngine) which can be configured separately for each axis. Autoscaling is supported for the radial scale.
In opposite to QwtPlot the scales might be different from the view, that is displayed on the canvas. The view can be changed by zooming - f.e. by using QwtPolarPanner or QwtPolarMaginfier.
Position of the legend, relative to the canvas.
LeftLegend |
The legend will be left from the canvas. |
RightLegend |
The legend will be right from the canvas. |
BottomLegend |
The legend will be below the canvas. |
TopLegend |
The legend will be between canvas and title. |
ExternalLegend |
External means that only the content of the legend will be handled by QwtPlot, but not its geometry. This might be interesting if an application wants to have a legend in an external window ( or on the canvas ).
|
QwtPolarPlot::QwtPolarPlot | ( | QWidget * | parent = NULL | ) | [explicit] |
Constructor
parent | Parent widget |
QwtPolarPlot::QwtPolarPlot | ( | const QwtText & | title, |
QWidget * | parent = NULL |
||
) |
Constructor
title | Title text |
parent | Parent widget |
QwtPolarPlot::~QwtPolarPlot | ( | ) | [virtual] |
Destructor.
void QwtPolarPlot::autoRefresh | ( | ) | [slot] |
Replots the plot if QwtPlot::autoReplot() is true
.
bool QwtPolarPlot::autoReplot | ( | ) | const |
double QwtPolarPlot::azimuthOrigin | ( | ) | const |
The azimuth origin is the angle where the azimuth scale shows the value 0.0.
QwtPolarCanvas * QwtPolarPlot::canvas | ( | ) |
const QwtPolarCanvas * QwtPolarPlot::canvas | ( | ) | const |
void QwtPolarPlot::drawCanvas | ( | QPainter * | painter, |
const QRectF & | canvasRect | ||
) | const [virtual] |
Redraw the canvas.
painter | Painter used for drawing |
canvasRect | Contents rect of the canvas |
void QwtPolarPlot::drawItems | ( | QPainter * | painter, |
const QwtScaleMap & | azimuthMap, | ||
const QwtScaleMap & | radialMap, | ||
const QPointF & | pole, | ||
double | radius, | ||
const QRectF & | canvasRect | ||
) | const [protected, virtual] |
Redraw the canvas items.
painter | Painter used for drawing |
azimuthMap | Maps azimuth values to values related to 0.0, M_2PI |
radialMap | Maps radius values into painter coordinates. |
pole | Position of the pole in painter coordinates |
radius | Radius of the complete plot area in painter coordinates |
canvasRect | Contents rect of the canvas in painter coordinates |
bool QwtPolarPlot::event | ( | QEvent * | e | ) | [protected, virtual] |
Qt event handler.
Handles QEvent::LayoutRequest and QEvent::PolishRequest
e | Qt Event |
bool QwtPolarPlot::hasAutoScale | ( | int | scaleId | ) | const |
void QwtPolarPlot::insertLegend | ( | QwtLegend * | legend, |
QwtPolarPlot::LegendPosition | pos = RightLegend , |
||
double | ratio = -1.0 |
||
) |
Insert a legend.
If the position legend is QwtPolarPlot::LeftLegend
or QwtPolarPlot::RightLegend
the legend will be organized in one column from top to down. Otherwise the legend items will be placed in a table with a best fit number of columns from left to right.
If pos != QwtPolarPlot::ExternalLegend the plot widget will become parent of the legend. It will be deleted when the plot is deleted, or another legend is set with insertLegend().
legend | Legend |
pos | The legend's position. For top/left position the number of colums will be limited to 1, otherwise it will be set to unlimited. |
ratio | Ratio between legend and the bounding rect of title, canvas and axes. The legend will be shrinked if it would need more space than the given ratio. The ratio is limited to ]0.0 .. 1.0]. In case of <= 0.0 it will be reset to the default ratio. The default vertical/horizontal ratio is 0.33/0.5. |
void QwtPolarPlot::layoutChanged | ( | ) | [signal] |
A signal that is emitted, whenever the layout of the plot has been recalculated.
QwtLegend * QwtPolarPlot::legend | ( | ) |
const QwtLegend * QwtPolarPlot::legend | ( | ) | const |
void QwtPolarPlot::legendChecked | ( | QwtPolarItem * | plotItem, |
bool | on | ||
) | [signal] |
A signal which is emitted when the user has clicked on a legend item, which is in QwtLegend::CheckableItem mode
plotItem | Corresponding plot item of the selected legend item |
on | True when the legen item is checked |
void QwtPolarPlot::legendClicked | ( | QwtPolarItem * | plotItem | ) | [signal] |
A signal which is emitted when the user has clicked on a legend item, which is in QwtLegend::ClickableItem mode.
plotItem | Corresponding plot item of the selected legend item |
void QwtPolarPlot::legendItemChecked | ( | bool | on | ) | [protected, virtual, slot] |
Called internally when the legend has been checked Emits a legendClicked() signal.
void QwtPolarPlot::legendItemClicked | ( | ) | [protected, virtual, slot] |
Called internally when the legend has been clicked on. Emits a legendClicked() signal.
const QBrush & QwtPolarPlot::plotBackground | ( | ) | const |
QwtPolarLayout * QwtPolarPlot::plotLayout | ( | ) |
const QwtPolarLayout * QwtPolarPlot::plotLayout | ( | ) | const |
int QwtPolarPlot::plotMarginHint | ( | ) | const |
QRectF QwtPolarPlot::plotRect | ( | ) | const |
The plot area depends on the size of the canvas and the zoom parameters.
QRectF QwtPolarPlot::plotRect | ( | const QRectF & | canvasRect | ) | const |
Calculate the bounding rect of the plot area.
The plot area depends on the zoom parameters.
canvasRect | Rectangle of the canvas |
void QwtPolarPlot::replot | ( | ) | [virtual, slot] |
Redraw the plot.
If the autoReplot option is not set (which is the default) or if any curves are attached to raw data, the plot has to be refreshed explicitly in order to make changes visible.
void QwtPolarPlot::resizeEvent | ( | QResizeEvent * | e | ) | [protected, virtual] |
Resize and update internal layout.
const QwtScaleDiv * QwtPolarPlot::scaleDiv | ( | int | scaleId | ) | const |
Return the scale division of a specified scale.
scaleDiv(scaleId)->lBound(), scaleDiv(scaleId)->hBound() are the current limits of the scale.
scaleId | Scale index |
QwtScaleDiv * QwtPolarPlot::scaleDiv | ( | int | scaleId | ) |
Return the scale division of a specified scale.
scaleDiv(scaleId)->lBound(), scaleDiv(scaleId)->hBound() are the current limits of the scale.
scaleId | Scale index |
QwtScaleEngine * QwtPolarPlot::scaleEngine | ( | int | scaleId | ) |
const QwtScaleEngine * QwtPolarPlot::scaleEngine | ( | int | scaleId | ) | const |
QwtScaleMap QwtPolarPlot::scaleMap | ( | int | scaleId, |
double | radius | ||
) | const |
Build a scale map
The azimuth map translates between the scale values and angles from [0.0, 2 * PI[. The radial map translates scale values into the distance from the pole.
scaleId | Scale index |
radius | Radius of the plot are in pixels |
QwtScaleMap QwtPolarPlot::scaleMap | ( | int | scaleId | ) | const |
Build a scale map
The azimuth map translates between the scale values and angles from [0.0, 2 * PI[. The radial map translates scale values into the distance from the pole. The radial map is calculated from the current geometry of the canvas.
scaleId | Scale index |
int QwtPolarPlot::scaleMaxMajor | ( | int | scaleId | ) | const |
scaleId | Scale index |
int QwtPolarPlot::scaleMaxMinor | ( | int | scaleId | ) | const |
scaleId | Scale index |
void QwtPolarPlot::setAutoReplot | ( | bool | enable = true | ) |
Set or reset the autoReplot option.
If the autoReplot option is set, the plot will be updated implicitly by manipulating member functions. Since this may be time-consuming, it is recommended to leave this option switched off and call replot() explicitly if necessary.
The autoReplot option is set to false by default, which means that the user has to call replot() in order to make changes visible.
enable | true or false . Defaults to true . |
void QwtPolarPlot::setAutoScale | ( | int | scaleId | ) |
Enable autoscaling.
This member function is used to switch back to autoscaling mode after a fixed scale has been set. Autoscaling calculates a useful scale division from the bounding interval of all plot items with the QwtPolarItem::AutoScale attribute.
Autoscaling is only supported for the radial scale and enabled as default.
scaleId | Scale index |
void QwtPolarPlot::setAzimuthOrigin | ( | double | origin | ) | [slot] |
Change the origin of the azimuth scale.
The azimuth origin is the angle where the azimuth scale shows the value 0.0. The default origin is 0.0.
origin | New origin |
void QwtPolarPlot::setPlotBackground | ( | const QBrush & | brush | ) |
Set the background of the plot area.
The plot area is the circle around the pole. It's radius is defined by the radial scale.
brush | Background Brush |
void QwtPolarPlot::setScale | ( | int | scaleId, |
double | min, | ||
double | max, | ||
double | stepSize = 0 |
||
) |
Disable autoscaling and specify a fixed scale for a selected scale.
scaleId | Scale index |
min | |
max | minimum and maximum of the scale |
stepSize | Major step size. If step == 0 , the step size is calculated automatically using the maxMajor setting. |
void QwtPolarPlot::setScaleDiv | ( | int | scaleId, |
const QwtScaleDiv & | scaleDiv | ||
) |
Disable autoscaling and specify a fixed scale for a selected scale.
scaleId | Scale index |
scaleDiv | Scale division |
void QwtPolarPlot::setScaleEngine | ( | int | scaleId, |
QwtScaleEngine * | scaleEngine | ||
) |
Change the scale engine for an axis
scaleId | Scale index |
scaleEngine | Scale engine |
void QwtPolarPlot::setScaleMaxMajor | ( | int | scaleId, |
int | maxMajor | ||
) |
Set the maximum number of major scale intervals for a specified scale
scaleId | Scale index |
maxMajor | maximum number of major steps |
void QwtPolarPlot::setScaleMaxMinor | ( | int | scaleId, |
int | maxMinor | ||
) |
Set the maximum number of major scale intervals for a specified scale
scaleId | Scale index |
maxMinor | maximum number of minor steps |
void QwtPolarPlot::setTitle | ( | const QwtText & | title | ) |
Change the plot's title
title | New title |
void QwtPolarPlot::setTitle | ( | const QString & | title | ) |
Change the plot's title
title | New title |
QwtText QwtPolarPlot::title | ( | ) | const |
QwtTextLabel * QwtPolarPlot::titleLabel | ( | ) |
const QwtTextLabel * QwtPolarPlot::titleLabel | ( | ) | const |
void QwtPolarPlot::unzoom | ( | ) |
Unzoom the plot
void QwtPolarPlot::updateLayout | ( | ) | [protected, virtual] |
Rebuild the layout.
void QwtPolarPlot::updateScale | ( | int | scaleId | ) |
Rebuild the scale
scaleId | Scale index |
QwtInterval QwtPolarPlot::visibleInterval | ( | ) | const |
void QwtPolarPlot::zoom | ( | const QwtPointPolar & | zoomPos, |
double | zoomFactor | ||
) |
Translate and in/decrease the zoom factor.
In zoom mode the zoom position is in the center of the canvas. The radius of the circle depends on the size of the plot canvas, that is devided by the zoom factor. Thus a factor < 1.0 zoom in.
Setting an invalid zoom position disables zooming.
zoomPos | Center of the translation |
zoomFactor | Zoom factor |
QwtPointPolar QwtPolarPlot::zoomPos | ( | ) | const |