QGIS API Documentation  3.13.0-Master (788156190c)
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 
34 #ifdef SIP_RUN
35 % ModuleHeaderCode
36 // For ConvertToSubClassCode.
37 #include <qgsrubberband.h>
38 % End
39 #endif
40 
48 #ifndef SIP_RUN
49 class GUI_EXPORT QgsRubberBand : public QObject, public QgsMapCanvasItem
50 {
51 #else
52 class GUI_EXPORT QgsRubberBand : public QgsMapCanvasItem
53 {
54 #endif
55  Q_OBJECT
56 
57 #ifdef SIP_RUN
59  if ( dynamic_cast<QgsRubberBand *>( sipCpp ) )
60  sipType = sipType_QgsRubberBand;
61  else
62  sipType = nullptr;
63  SIP_END
64 #endif
65  public:
66 
67  Q_PROPERTY( QColor fillColor READ fillColor WRITE setFillColor )
68  Q_PROPERTY( QColor strokeColor READ strokeColor WRITE setStrokeColor )
69  Q_PROPERTY( int iconSize READ iconSize WRITE setIconSize )
70  Q_PROPERTY( QColor secondaryStrokeColor READ secondaryStrokeColor WRITE setSecondaryStrokeColor )
71  Q_PROPERTY( int width READ width WRITE setWidth )
72 
74  enum IconType
75  {
76 
81 
86 
91 
96 
101 
106 
112 
118 
123  ICON_SVG
124  };
125 
135 
141  void setColor( const QColor &color );
142 
148  void setFillColor( const QColor &color );
149 
153  QColor fillColor() const { return mBrush.color(); }
154 
160  void setStrokeColor( const QColor &color );
161 
165  QColor strokeColor() const { return mPen.color(); }
166 
173  void setSecondaryStrokeColor( const QColor &color );
174 
178  QColor secondaryStrokeColor() const { return mSecondaryPen.color(); }
179 
184  void setWidth( int width );
185 
189  int width() const { return mPen.width(); }
190 
195  void setIcon( IconType icon );
196 
204  void setSvgIcon( const QString &path, QPoint drawOffset );
205 
206 
210  IconType icon() const { return mIconType; }
211 
215  void setIconSize( int iconSize );
216 
220  int iconSize() const { return mIconSize; }
221 
225  void setLineStyle( Qt::PenStyle penStyle );
226 
230  void setBrushStyle( Qt::BrushStyle brushStyle );
231 
237  void reset( QgsWkbTypes::GeometryType geometryType = QgsWkbTypes::LineGeometry );
238 
247  void addPoint( const QgsPointXY &p, bool doUpdate = true, int geometryIndex = 0 );
248 
256  void closePoints( bool doUpdate = true, int geometryIndex = 0 );
257 
264  void removePoint( int index = 0, bool doUpdate = true, int geometryIndex = 0 );
265 
269  void removeLastPoint( int geometryIndex = 0, bool doUpdate = true );
270 
275  void movePoint( const QgsPointXY &p, int geometryIndex = 0 );
276 
281  void movePoint( int index, const QgsPointXY &p, int geometryIndex = 0 );
282 
288  int partSize( int geometryIndex ) const;
289 
298  void setToGeometry( const QgsGeometry &geom, QgsVectorLayer *layer );
299 
309  void setToGeometry( const QgsGeometry &geometry, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
310 
315  void setToCanvasRectangle( QRect rect );
316 
328  void addGeometry( const QgsGeometry &geometry, QgsVectorLayer *layer );
329 
338  void addGeometry( const QgsGeometry &geometry, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );
339 
345  void setTranslationOffset( double dx, double dy );
346 
351  int size() const;
352 
357  int numberOfVertices() const;
358 
364  const QgsPointXY *getPoint( int i, int j = 0 ) const;
365 
370  QgsGeometry asGeometry() const;
371 
372  void updatePosition() override;
373 
374  protected:
375 
380  void paint( QPainter *p ) override;
381 
387  void drawShape( QPainter *p, const QVector<QPointF> &pts );
388 
390  void updateRect();
391 
392  private:
393  QBrush mBrush;
394  QPen mPen;
395  QPen mSecondaryPen;
396 
398  int mIconSize = 5;
399 
401  IconType mIconType = ICON_CIRCLE;
402  std::unique_ptr<QSvgRenderer> mSvgRenderer;
403  QPoint mSvgOffset;
404 
408  QList< QList <QgsPointXY> > mPoints;
410  double mTranslationOffsetX = 0.0;
411  double mTranslationOffsetY = 0.0;
412 
413  QgsRubberBand();
414 
415  static QgsPolylineXY getPolyline( const QList<QgsPointXY> &points );
416 
417 };
418 
419 #endif
QgsRubberBand::width
int width() const
Returns the current width of the line or stroke width for polygon.
Definition: qgsrubberband.h:189
QgsRubberBand::iconSize
int iconSize() const
Returns the current icon size of the point icons.
Definition: qgsrubberband.h:220
QgsRubberBand::ICON_CIRCLE
@ ICON_CIRCLE
A circle is used to highlight points (○)
Definition: qgsrubberband.h:100
QgsRubberBand
Definition: qgsrubberband.h:49
crs
const QgsCoordinateReferenceSystem & crs
Definition: qgswfsgetfeature.cpp:105
QgsPolylineXY
QVector< QgsPointXY > QgsPolylineXY
Polyline as represented as a vector of two-dimensional points.
Definition: qgsgeometry.h:50
QgsMapCanvas
Definition: qgsmapcanvas.h:78
QgsRubberBand::ICON_BOX
@ ICON_BOX
A box is used to highlight points (□)
Definition: qgsrubberband.h:95
QgsRubberBand::IconType
IconType
Icons.
Definition: qgsrubberband.h:74
QgsRubberBand::ICON_NONE
@ ICON_NONE
No icon is used.
Definition: qgsrubberband.h:80
QgsWkbTypes::PolygonGeometry
@ PolygonGeometry
Definition: qgswkbtypes.h:143
QgsGuiUtils::iconSize
QSize iconSize(bool dockableToolbar)
Returns the user-preferred size of a window's toolbar icons.
Definition: qgsguiutils.cpp:264
qgsrubberband.h
QgsRubberBand::ICON_FULL_DIAMOND
@ ICON_FULL_DIAMOND
A diamond is used to highlight points (◆)
Definition: qgsrubberband.h:117
QgsMapCanvasItem::updatePosition
virtual void updatePosition()
called on changed extent or resize event to update position of the item
Definition: qgsmapcanvasitem.cpp:135
SIP_CONVERT_TO_SUBCLASS_CODE
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition: qgis_sip.h:172
QgsMapCanvasItem::paint
virtual void paint(QPainter *painter)=0
function to be implemented by derived classes
qgsmapcanvasitem.h
QgsMapCanvasItem
Definition: qgsmapcanvasitem.h:33
QgsRubberBand::fillColor
QColor fillColor() const
Returns the current fill color.
Definition: qgsrubberband.h:153
qgis_sip.h
QgsRubberBand::ICON_X
@ ICON_X
A cross is used to highlight points (x)
Definition: qgsrubberband.h:90
QgsCoordinateReferenceSystem
Definition: qgscoordinatereferencesystem.h:209
QgsRubberBand::ICON_FULL_BOX
@ ICON_FULL_BOX
A full box is used to highlight points (■)
Definition: qgsrubberband.h:105
QgsPointXY
Definition: qgspointxy.h:43
QgsWkbTypes::LineGeometry
@ LineGeometry
Definition: qgswkbtypes.h:142
qgsgeometry.h
QgsWkbTypes::GeometryType
GeometryType
The geometry types are used to group QgsWkbTypes::Type in a coarse way.
Definition: qgswkbtypes.h:139
QgsGeometry
Definition: qgsgeometry.h:122
QgsRubberBand::ICON_CROSS
@ ICON_CROSS
A cross is used to highlight points (+)
Definition: qgsrubberband.h:85
QgsVectorLayer
Definition: qgsvectorlayer.h:386
QgsRubberBand::icon
IconType icon() const
Returns the current icon type to highlight point geometries.
Definition: qgsrubberband.h:210
QgsRubberBand::secondaryStrokeColor
QColor secondaryStrokeColor() const
Returns the current secondary stroke color.
Definition: qgsrubberband.h:178
QgsRubberBand::ICON_DIAMOND
@ ICON_DIAMOND
A diamond is used to highlight points (◇)
Definition: qgsrubberband.h:111
SIP_END
#define SIP_END
Definition: qgis_sip.h:189
SIP_TRANSFERTHIS
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:53
QgsRubberBand::strokeColor
QColor strokeColor() const
Returns the current stroke color.
Definition: qgsrubberband.h:165