QGIS API Documentation  3.9.0-Master (224899f119)
qgsrubberband.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsrubberband.h - Rubberband widget for drawing multilines and polygons
3  --------------------------------------
4  Date : 07-Jan-2006
5  Copyright : (C) 2006 by Tom Elwertowski
6  Email : telwertowski at users dot sourceforge dot net
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 #ifndef QGSRUBBERBAND_H
16 #define QGSRUBBERBAND_H
17 
18 #include "qgsmapcanvasitem.h"
19 #include "qgis_sip.h"
20 #include "qgsgeometry.h"
21 
22 #include <QBrush>
23 #include <QList>
24 #include <QPen>
25 #include <QPolygon>
26 #include <QObject>
27 #include <QSvgRenderer>
28 
29 #include "qgis_gui.h"
30 
31 class QgsVectorLayer;
32 class QPaintEvent;
33 
41 class GUI_EXPORT QgsRubberBand : public QObject, public QgsMapCanvasItem
42 {
43  Q_OBJECT
44  public:
45 
46  Q_PROPERTY( QColor fillColor READ fillColor WRITE setFillColor )
47  Q_PROPERTY( QColor strokeColor READ strokeColor WRITE setStrokeColor )
48  Q_PROPERTY( int iconSize READ iconSize WRITE setIconSize )
49  Q_PROPERTY( QColor secondaryStrokeColor READ secondaryStrokeColor WRITE setSecondaryStrokeColor )
50  Q_PROPERTY( int width READ width WRITE setWidth )
51 
53  enum IconType
54  {
55 
60 
65 
70 
75 
80 
85 
91 
97 
102  ICON_SVG
103  };
104 
114 
120  void setColor( const QColor &color );
121 
127  void setFillColor( const QColor &color );
128 
132  QColor fillColor() const { return mBrush.color(); }
133 
139  void setStrokeColor( const QColor &color );
140 
144  QColor strokeColor() const { return mPen.color(); }
145 
152  void setSecondaryStrokeColor( const QColor &color );
153 
157  QColor secondaryStrokeColor() const { return mSecondaryPen.color(); }
158 
163  void setWidth( int width );
164 
168  int width() const { return mPen.width(); }
169 
174  void setIcon( IconType icon );
175 
183  void setSvgIcon( const QString &path, QPoint drawOffset );
184 
185 
189  IconType icon() const { return mIconType; }
190 
194  void setIconSize( int iconSize );
195 
199  int iconSize() const { return mIconSize; }
200 
204  void setLineStyle( Qt::PenStyle penStyle );
205 
209  void setBrushStyle( Qt::BrushStyle brushStyle );
210 
216  void reset( QgsWkbTypes::GeometryType geometryType = QgsWkbTypes::LineGeometry );
217 
226  void addPoint( const QgsPointXY &p, bool doUpdate = true, int geometryIndex = 0 );
227 
235  void closePoints( bool doUpdate = true, int geometryIndex = 0 );
236 
243  void removePoint( int index = 0, bool doUpdate = true, int geometryIndex = 0 );
244 
248  void removeLastPoint( int geometryIndex = 0, bool doUpdate = true );
249 
254  void movePoint( const QgsPointXY &p, int geometryIndex = 0 );
255 
260  void movePoint( int index, const QgsPointXY &p, int geometryIndex = 0 );
261 
267  int partSize( int geometryIndex ) const;
268 
277  void setToGeometry( const QgsGeometry &geom, QgsVectorLayer *layer );
278 
288  void setToGeometry( const QgsGeometry &geometry, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
289 
294  void setToCanvasRectangle( QRect rect );
295 
307  void addGeometry( const QgsGeometry &geometry, QgsVectorLayer *layer );
308 
317  void addGeometry( const QgsGeometry &geometry, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
318 
324  void setTranslationOffset( double dx, double dy );
325 
330  int size() const;
331 
336  int numberOfVertices() const;
337 
343  const QgsPointXY *getPoint( int i, int j = 0 ) const;
344 
349  QgsGeometry asGeometry() const;
350 
351  void updatePosition() override;
352 
353  protected:
354 
359  void paint( QPainter *p ) override;
360 
366  void drawShape( QPainter *p, const QVector<QPointF> &pts );
367 
369  void updateRect();
370 
371  private:
372  QBrush mBrush;
373  QPen mPen;
374  QPen mSecondaryPen;
375 
377  int mIconSize = 5;
378 
380  IconType mIconType = ICON_CIRCLE;
381  std::unique_ptr<QSvgRenderer> mSvgRenderer;
382  QPoint mSvgOffset;
383 
387  QList< QList <QgsPointXY> > mPoints;
389  double mTranslationOffsetX = 0.0;
390  double mTranslationOffsetY = 0.0;
391 
392  QgsRubberBand();
393 
394  static QgsPolylineXY getPolyline( const QList<QgsPointXY> &points );
395 
396 };
397 
398 #endif
A cross is used to highlight points (x)
Definition: qgsrubberband.h:69
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53
IconType icon() const
Returns the current icon type to highlight point geometries.
A class to represent a 2D point.
Definition: qgspointxy.h:43
An abstract class for items that can be placed on the map canvas.
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:121
A diamond is used to highlight points (◇)
Definition: qgsrubberband.h:90
const QgsCoordinateReferenceSystem & crs
A cross is used to highlight points (+)
Definition: qgsrubberband.h:64
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:73
int width() const
Returns the current width of the line or stroke width for polygon.
A circle is used to highlight points (○)
Definition: qgsrubberband.h:79
A class for drawing transient features (e.g.
Definition: qgsrubberband.h:41
QColor fillColor() const
Returns the current fill color.
QSize iconSize(bool dockableToolbar)
Returns the user-preferred size of a window&#39;s toolbar icons.
virtual void paint(QPainter *painter)=0
function to be implemented by derived classes
GeometryType
The geometry types are used to group QgsWkbTypes::Type in a coarse way.
Definition: qgswkbtypes.h:139
QColor secondaryStrokeColor() const
Returns the current secondary stroke color.
A box is used to highlight points (□)
Definition: qgsrubberband.h:74
QVector< QgsPointXY > QgsPolylineXY
Polyline as represented as a vector of two-dimensional points.
Definition: qgsgeometry.h:49
int iconSize() const
Returns the current icon size of the point icons.
This class represents a coordinate reference system (CRS).
A diamond is used to highlight points (◆)
Definition: qgsrubberband.h:96
No icon is used.
Definition: qgsrubberband.h:59
QColor strokeColor() const
Returns the current stroke color.
Represents a vector layer which manages a vector based data sets.
virtual void updatePosition()
called on changed extent or resize event to update position of the item
A full box is used to highlight points (■)
Definition: qgsrubberband.h:84