QwtPolarItem(3) | Qwt User's Guide | QwtPolarItem(3) |
NAME
QwtPolarItem - Base class for items on a polar plot.
SYNOPSIS
#include <qwt_polar_item.h>
Inherited by QwtPolarCurve, QwtPolarGrid, QwtPolarMarker, and QwtPolarSpectrogram.
Public Types
enum RttiValues { Rtti_PolarItem = 0,
Rtti_PolarGrid, Rtti_PolarMarker, Rtti_PolarCurve,
Rtti_PolarSpectrogram, Rtti_PolarUserItem = 1000 }
Runtime type information. enum ItemAttribute { Legend = 0x01,
AutoScale = 0x02 }
Plot Item Attributes. enum RenderHint { RenderAntialiased = 0x01
}
Render hints. typedef QFlags< ItemAttribute >
ItemAttributes
typedef QFlags< RenderHint > RenderHints
Public Member Functions
QwtPolarItem (const QwtText
&title=QwtText())
virtual ~QwtPolarItem ()
Destroy the QwtPolarItem. void attach (QwtPolarPlot
*plot)
Attach the item to a plot. void detach ()
This method detaches a QwtPolarItem from the QwtPolarPlot it has
been associated with. QwtPolarPlot * plot () const
void setTitle (const QString &title)
void setTitle (const QwtText &title)
const QwtText & title () const
virtual int rtti () const
void setItemAttribute (ItemAttribute, bool on=true)
bool testItemAttribute (ItemAttribute) const
void setRenderHint (RenderHint, bool on=true)
bool testRenderHint (RenderHint) const
void setRenderThreadCount (uint numThreads)
uint renderThreadCount () const
double z () const
void setZ (double z)
Set the z value. void show ()
Show the item. void hide ()
Hide the item. virtual void setVisible (bool)
bool isVisible () const
virtual void itemChanged ()
virtual void legendChanged ()
virtual void draw (QPainter *painter, const QwtScaleMap
&azimuthMap, const QwtScaleMap &radialMap, const QPointF
&pole, double radius, const QRectF &canvasRect) const =0
Draw the item. virtual QwtInterval boundingInterval (int
scaleId) const
virtual void updateScaleDiv (const QwtScaleDiv &, const
QwtScaleDiv &, const QwtInterval &)
Update the item to changes of the axes scale division. virtual int
marginHint () const
void setLegendIconSize (const QSize &)
QSize legendIconSize () const
virtual QList< QwtLegendData > legendData () const
Return all information, that is needed to represent the item on the legend.
virtual QwtGraphic legendIcon (int index, const QSizeF &)
const
Detailed Description
Base class for items on a polar plot.
A QwtPolarItem is 'something that can be painted on the canvas'. It is connected to the QwtPolar framework by a couple of virtual methods, that are individually implemented in derived item classes.
QwtPolar offers an implementation of the most common types of items, but deriving from QwtPolarItem makes it easy to implement additional types of items.
Definition at line 37 of file qwt_polar_item.h.
Member Typedef Documentation
typedef QFlags<ItemAttribute > QwtPolarItem::ItemAttributes
An ORed combination of ItemAttribute values.
Definition at line 86 of file qwt_polar_item.h.
typedef QFlags<RenderHint > QwtPolarItem::RenderHints
An ORed combination of RenderHint values.
Definition at line 98 of file qwt_polar_item.h.
Member Enumeration Documentation
enum QwtPolarItem::ItemAttribute
Plot Item Attributes.
See also
Enumerator
- Legend
- The item is represented on the legend.
- AutoScale
- The boundingRect() of the item is included in the autoscaling calculation.
Definition at line 74 of file qwt_polar_item.h.
enum QwtPolarItem::RenderHint
Render hints.
See also
Enumerator
- RenderAntialiased
- Enable antialiasing.
Definition at line 92 of file qwt_polar_item.h.
enum QwtPolarItem::RttiValues
Runtime type information. RttiValues is used to cast plot items, without having to enable runtime type information of the compiler.
Enumerator
- Rtti_PolarItem
- Unspecific value, that can be used, when it doesn't matter.
- Rtti_PolarGrid
- For QwtPolarGrid.
- Rtti_PolarMarker
- For QwtPolarMarker.
- Rtti_PolarCurve
- For QwtPolarCurve.
- Rtti_PolarSpectrogram
- For QwtPolarSpectrogram.
- Rtti_PolarUserItem
- Values >= Rtti_PolarUserItem are reserved for plot items not implemented in the QwtPolar library.
Definition at line 46 of file qwt_polar_item.h.
Constructor & Destructor Documentation
QwtPolarItem::QwtPolarItem (const QwtText & title = QwtText()) [explicit]
Constructor
Parameters
See also
Definition at line 48 of file qwt_polar_item.cpp.
Member Function Documentation
void QwtPolarItem::attach (QwtPolarPlot * plot)
Attach the item to a plot. This method will attach a QwtPolarItem to the QwtPolarPlot argument. It will first detach the QwtPolarItem from any plot from a previous call to attach (if necessary). If a NULL argument is passed, it will detach from any QwtPolarPlot it was attached to.
Parameters
See also
Definition at line 74 of file qwt_polar_item.cpp.
QwtInterval QwtPolarItem::boundingInterval (int scaleId) const [virtual]
Interval, that is necessary to display the item
This interval can be useful for operations like clipping or autoscaling For items ( like the grid ), where a bounding interval makes no sense an invalid interval is returned.
Parameters
Returns
Reimplemented in QwtPolarSpectrogram, QwtPolarMarker, and QwtPolarCurve.
Definition at line 381 of file qwt_polar_item.cpp.
void QwtPolarItem::detach ()
This method detaches a QwtPolarItem from the QwtPolarPlot it has been associated with. detach() is equivalent to calling attach( NULL )
See also
Definition at line 95 of file qwt_polar_item.cpp.
virtual void QwtPolarItem::draw (QPainter * painter, const QwtScaleMap & azimuthMap, const QwtScaleMap & radialMap, const QPointF & pole, double radius, const QRectF & canvasRect) const [pure virtual]
Draw the item.
Parameters
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
Implemented in QwtPolarSpectrogram, QwtPolarMarker, QwtPolarGrid, and QwtPolarCurve.
bool QwtPolarItem::isVisible () const
Returns
See also
Definition at line 344 of file qwt_polar_item.cpp.
void QwtPolarItem::itemChanged () [virtual]
Update the legend and call QwtPolarPlot::autoRefresh for the parent plot.
See also
Definition at line 355 of file qwt_polar_item.cpp.
void QwtPolarItem::legendChanged () [virtual]
Update the legend of the parent plot.
See also
Definition at line 365 of file qwt_polar_item.cpp.
QList< QwtLegendData > QwtPolarItem::legendData () const [virtual]
Return all information, that is needed to represent the item on the legend. Most items are represented by one entry on the legend showing an icon and a text.
QwtLegendData is basically a list of QVariants that makes it possible to overload and reimplement legendData() to return almost any type of information, that is understood by the receiver that acts as the legend.
The default implementation returns one entry with the title() of the item and the legendIcon().
See also
Definition at line 428 of file qwt_polar_item.cpp.
QwtGraphic QwtPolarItem::legendIcon (int index, const QSizeF & size) const [virtual]
Returns
The default implementation returns an invalid icon
Parameters
size Icon size
See also
Reimplemented in QwtPolarCurve.
Definition at line 462 of file qwt_polar_item.cpp.
QSize QwtPolarItem::legendIconSize () const
Returns
See also
Definition at line 308 of file qwt_polar_item.cpp.
int QwtPolarItem::marginHint () const [virtual]
Some items like to display something (f.e. the azimuth axis) outside of the area of the interval of the radial scale. The default implementation returns 0 pixels
Returns
Reimplemented in QwtPolarGrid.
Definition at line 478 of file qwt_polar_item.cpp.
QwtPolarPlot * QwtPolarItem::plot () const
Returns
Definition at line 118 of file qwt_polar_item.cpp.
uint QwtPolarItem::renderThreadCount () const
Returns
Definition at line 282 of file qwt_polar_item.cpp.
int QwtPolarItem::rtti () const [virtual]
Return rtti for the specific class represented. QwtPolarItem is simply a virtual interface class, and base classes will implement this method with specific rtti values so a user can differentiate them.
The rtti value is useful for environments, where the runtime type information is disabled and it is not possible to do a dynamic_cast<...>.
Returns
See also
Reimplemented in QwtPolarSpectrogram, QwtPolarMarker, QwtPolarGrid, and QwtPolarCurve.
Definition at line 112 of file qwt_polar_item.cpp.
void QwtPolarItem::setItemAttribute (ItemAttribute attribute, bool on = true)
Toggle an item attribute
Parameters
on true/false
See also
Definition at line 201 of file qwt_polar_item.cpp.
void QwtPolarItem::setLegendIconSize (const QSize & size)
Set the size of the legend icon
The default setting is 8x8 pixels
Parameters
See also
Definition at line 295 of file qwt_polar_item.cpp.
void QwtPolarItem::setRenderHint (RenderHint hint, bool on = true)
Toggle an render hint
Parameters
on true/false
See also
Definition at line 234 of file qwt_polar_item.cpp.
void QwtPolarItem::setRenderThreadCount (uint numThreads)
On multi core systems rendering of certain plot item ( f.e QwtPolarSpectrogram ) can be done in parallel in several threads.
The default setting is set to 1.
Parameters
The default thread count is 1 ( = no additional threads )
Definition at line 272 of file qwt_polar_item.cpp.
void QwtPolarItem::setTitle (const QString & title)
Set a new title
Parameters
See also
Definition at line 164 of file qwt_polar_item.cpp.
void QwtPolarItem::setTitle (const QwtText & title)
Set a new title
Parameters
See also
Definition at line 175 of file qwt_polar_item.cpp.
void QwtPolarItem::setVisible (bool on) [virtual]
Show/Hide the item
Parameters
See also
Definition at line 331 of file qwt_polar_item.cpp.
void QwtPolarItem::setZ (double z)
Set the z value. Plot items are painted in increasing z-order.
Parameters
See also
Definition at line 142 of file qwt_polar_item.cpp.
bool QwtPolarItem::testItemAttribute (ItemAttribute attribute) const
Test an item attribute
Parameters
Returns
See also
Definition at line 221 of file qwt_polar_item.cpp.
bool QwtPolarItem::testRenderHint (RenderHint hint) const
Test a render hint
Parameters
Returns
See also
Definition at line 254 of file qwt_polar_item.cpp.
const QwtText & QwtPolarItem::title () const
Returns
See also
Definition at line 188 of file qwt_polar_item.cpp.
void QwtPolarItem::updateScaleDiv (const QwtScaleDiv & azimuthScaleDiv, const QwtScaleDiv & radialScaleDiv, const QwtInterval & interval) [virtual]
Update the item to changes of the axes scale division. Update the item, when the axes of plot have changed. The default implementation does nothing, but items that depend on the scale division (like QwtPolarGrid()) have to reimplement updateScaleDiv()
Parameters
radialScaleDiv Scale division of the radius-axis
interval The interval of the radius-axis, that is visible on the canvas
See also
Reimplemented in QwtPolarGrid.
Definition at line 403 of file qwt_polar_item.cpp.
double QwtPolarItem::z () const
Plot items are painted in increasing z-order.
Returns
See also
Definition at line 129 of file qwt_polar_item.cpp.
Author
Generated automatically by Doxygen for Qwt User's Guide from the source code.
Sun Jul 18 2021 | Version 6.2.0 |