logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

QwtPlotShapeItem - A plot item, which displays any graphical shape, that can be defined by a

Author

       Generated automatically by Doxygen for Qwt User's Guide from the source code.

Version 6.1.4                                    Wed Jan 2 2019                              QwtPlotShapeItem(3)

Constructor & Destructor Documentation

QwtPlotShapeItem::QwtPlotShapeItem(constQString&title=QString())[explicit]
       Constructor. Sets the following item attributes:

       • QwtPlotItem::AutoScale: true

       • QwtPlotItem::Legend: false

       Parameters:title Title

   QwtPlotShapeItem::QwtPlotShapeItem(constQwtText&title)[explicit]
       Constructor. Sets the following item attributes:

       • QwtPlotItem::AutoScale: true

       • QwtPlotItem::Legend: false

       Parameters:title Title

Detailed Description

       A plot item, which displays any graphical shape, that can be defined by a QPainterPath.

       A QPainterPath is a shape composed from intersecting and uniting regions, rectangles, ellipses or
       irregular areas defined by lines, and curves. QwtPlotShapeItem displays a shape with a pen and brush.

       QwtPlotShapeItem offers a couple of optimizations like clipping or weeding. These algorithms need to
       convert the painter path into polygons that might be less performant for paths built from curves and
       ellipses.

       Seealso:
           QwtPlotZone

Member Enumeration Documentation

enumQwtPlotShapeItem::LegendMode
       Mode how to display the item on the legend.

       EnumeratorLegendShape
              Display a scaled down version of the shape.

       LegendColor
              Display a filled rectangle.

   enumQwtPlotShapeItem::PaintAttribute
       Attributes to modify the drawing algorithm. The default disables all attributes

       Seealso:setPaintAttribute(), testPaintAttribute()EnumeratorClipPolygons
              Clip  polygons  before painting them. In situations, where points are far outside the visible area
              (f.e when zooming deep) this might be a substantial improvement for the painting performance

       But polygon clipping will convert the painter path into polygons what might introduce a  negative  impact
       on the performance of paths composed from curves or ellipses.

Member Function Documentation

QBrushQwtPlotShapeItem::brush()constReturns:
           Brush used to fill the shape

       Seealso:setBrush(), pen()voidQwtPlotShapeItem::draw(QPainter*painter,constQwtScaleMap&xMap,constQwtScaleMap&yMap,constQRectF&canvasRect)const[virtual]
       Draw the shape item

       Parameters:painter Painter
           xMap X-Scale Map
           yMap Y-Scale Map
           canvasRect Contents rect of the plot canvas

       Implements QwtPlotItem.

   QwtGraphicQwtPlotShapeItem::legendIcon(intindex,constQSizeF&size)const[virtual]Returns:
           A rectangle filled with the color of the brush ( or the pen )

       Parameters:index Index of the legend entry ( usually there is only one )
           size Icon size

       Seealso:setLegendIconSize(), legendData()

       Reimplemented from QwtPlotItem.

   QwtPlotShapeItem::LegendModeQwtPlotShapeItem::legendMode()constReturns:
           Mode how to represent the item on the legend

       Seealso:legendMode()QPenQwtPlotShapeItem::pen()constReturns:
           Pen used to draw the outline of the shape

       Seealso:setPen(), brush()doubleQwtPlotShapeItem::renderTolerance()constReturns:
           Tolerance for the weeding optimization

       Seealso:setRenderTolerance()intQwtPlotShapeItem::rtti()const[virtual]Returns:QwtPlotItem::Rtti_PlotShape

       Reimplemented from QwtPlotItem.

   voidQwtPlotShapeItem::setBrush(constQBrush&brush)
       Assign a brush.

       The brush is used to fill the path

       Parameters:brush Brush

       Seealso:brush(), pen()voidQwtPlotShapeItem::setLegendMode(LegendModemode)
       Set the mode how to represent the item on the legend

       Parameters:mode Mode

       Seealso:legendMode()voidQwtPlotShapeItem::setPaintAttribute(PaintAttributeattribute,boolon=true)
       Specify an attribute how to draw the shape

       Parameters:attribute Paint attribute
           on On/Off

       Seealso:testPaintAttribute()voidQwtPlotShapeItem::setPen(constQColor&color,qrealwidth=0.0,Qt::PenStylestyle=Qt::SolidLine)
       Build and assign a pen

       In Qt5 the default pen width is 1.0 ( 0.0 in Qt4 ) what makes it non cosmetic ( see QPen::isCosmetic() ).
       This method has been introduced to hide this incompatibility.

       Parameters:color Pen color
           width Pen width
           style Pen style

       Seealso:pen(), brush()voidQwtPlotShapeItem::setPen(constQPen&pen)
       Assign a pen. The pen is used to draw the outline of the shape

       Parameters:pen Pen

       Seealso:pen(), brush()voidQwtPlotShapeItem::setPolygon(constQPolygonF&polygon)
       Set a path built from a polygon.

       Parameters:polygon Polygon

       Seealso:setShape(), setRect(), shape()voidQwtPlotShapeItem::setRect(constQRectF&rect)
       Set a path built from a rectangle.

       Parameters:rect Rectangle

       Seealso:setShape(), setPolygon(), shape()voidQwtPlotShapeItem::setRenderTolerance(doubletolerance)
       Set the tolerance for the weeding optimization. After translating the shape into target device coordinate
       ( usually widget geometries ) the painter path can be simplified by a point weeding algorithm (  Douglas-
       Peucker ).

       For  shapes built from curves and ellipses weeding might have the opposite effect because they have to be
       expanded to polygons.

       Parameters:tolerance Accepted error when reducing the number of points A value <= 0.0 disables weeding.

       Seealso:renderTolerance(), QwtWeedingCurveFittervoidQwtPlotShapeItem::setShape(constQPainterPath&shape)
       Set the shape to be displayed.

       Parameters:shape Shape

       Seealso:setShape(), shape()QPainterPathQwtPlotShapeItem::shape()constReturns:
           Shape to be displayed

       Seealso:setShape()boolQwtPlotShapeItem::testPaintAttribute(PaintAttributeattribute)constReturns:
           True, when attribute is enabled

       Seealso:setPaintAttribute()

Name

       QwtPlotShapeItem - A plot item, which displays any graphical shape, that can be defined by a
       QPainterPath.

Synopsis

       #include <qwt_plot_shapeitem.h>

       Inherits QwtPlotItem.

   PublicTypes
       enum PaintAttribute { ClipPolygons = 0x01 }
       enum LegendMode { LegendShape, LegendColor }
           Mode how to display the item on the legend.
       typedef QFlags< PaintAttribute > PaintAttributes
           Paint attributes.

   PublicMemberFunctionsQwtPlotShapeItem (const QString &title=QString())
           Constructor.
       QwtPlotShapeItem (const QwtText &title)
           Constructor.
       virtual ~QwtPlotShapeItem ()
           Destructor.
       void setPaintAttribute (PaintAttribute, bool on=true)
       bool testPaintAttribute (PaintAttribute) const
       void setLegendMode (LegendMode)
       LegendModelegendMode () const
       void setRect (const QRectF &)
           Set a path built from a rectangle.
       void setPolygon (const QPolygonF &)
           Set a path built from a polygon.
       void setShape (const QPainterPath &)
           Set the shape to be displayed.
       QPainterPath shape () const
       void setPen (const QColor &, qreal width=0.0, Qt::PenStyle=Qt::SolidLine)
       void setPen (const QPen &)
           Assign a pen.
       QPen pen () const
       void setBrush (const QBrush &)
       QBrush brush () const
       void setRenderTolerance (double)
           Set the tolerance for the weeding optimization.
       double renderTolerance () const
       virtual QRectF boundingRect () const
           Bounding rectangle of the shape.
       virtual void draw (QPainter *, const QwtScaleMap &xMap, const QwtScaleMap &yMap, const QRectF
           &canvasRect) const
       virtual QwtGraphiclegendIcon (int index, const QSizeF &) const
       virtual int rtti () const

   AdditionalInheritedMembers

See Also