QGIS API Documentation  3.10.0-A Coruña (6c816b4204)
qgsgeometryrubberband.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsgeometryrubberband.h
3  -----------------------
4  begin : December 2014
5  copyright : (C) 2014 by Marco Hugentobler
6  email : marco at sourcepole dot ch
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSGEOMETRYRUBBERBAND_H
19 #define QGSGEOMETRYRUBBERBAND_H
20 
21 #include "qgsmapcanvasitem.h"
22 #include "qgswkbtypes.h"
23 #include <QBrush>
24 #include <QPen>
25 #include "qgis_gui.h"
26 
27 #ifdef SIP_RUN
28 % ModuleHeaderCode
29 // For ConvertToSubClassCode.
30 #include <qgsgeometryrubberband.h>
31 % End
32 #endif
33 
35 class QgsPoint;
36 struct QgsVertexId;
37 
41 class GUI_EXPORT QgsGeometryRubberBand: public QgsMapCanvasItem
42 {
43 
44 #ifdef SIP_RUN
46  if ( dynamic_cast<QgsGeometryRubberBand *>( sipCpp ) )
47  sipType = sipType_QgsGeometryRubberBand;
48  else
49  sipType = nullptr;
50  SIP_END
51 #endif
52 
53  public:
54  enum IconType
55  {
56 
61 
66 
71 
76 
81 
85  ICON_FULL_BOX
86  };
87 
89  ~QgsGeometryRubberBand() override;
90 
92  void setGeometry( QgsAbstractGeometry *geom SIP_TRANSFER );
94  const QgsAbstractGeometry *geometry() { return mGeometry; }
96  void moveVertex( QgsVertexId id, const QgsPoint &newPos );
98  void setFillColor( const QColor &c );
100  void setStrokeColor( const QColor &c );
102  void setStrokeWidth( int width );
104  void setLineStyle( Qt::PenStyle penStyle );
106  void setBrushStyle( Qt::BrushStyle brushStyle );
108  void setIconType( IconType iconType ) { mIconType = iconType; }
109 
110  protected:
111  void paint( QPainter *painter ) override;
112 
113  private:
114  QgsAbstractGeometry *mGeometry = nullptr;
115  QBrush mBrush;
116  QPen mPen;
117  int mIconSize;
118  IconType mIconType;
119  QgsWkbTypes::GeometryType mGeometryType;
120 
121  void drawVertex( QPainter *p, double x, double y );
122  QgsRectangle rubberBandRectangle() const;
123 };
124 
125 #endif // QGSGEOMETRYRUBBERBAND_H
A circle is used to highlight points (○)
void setIconType(IconType iconType)
Sets vertex marker icon type.
A rectangle specified with double values.
Definition: qgsrectangle.h:41
A cross is used to highlight points (+)
A box is used to highlight points (□)
An abstract class for items that can be placed on the map canvas.
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:75
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c
Utility class for identifying a unique vertex within a geometry.
#define SIP_TRANSFER
Definition: qgis_sip.h:36
#define SIP_END
Definition: qgis_sip.h:189
Abstract base class for all geometries.
const QgsAbstractGeometry * geometry()
Returns a pointer to the geometry.
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:37
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
A rubberband class for QgsAbstractGeometry (considering curved geometries)
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition: qgis_sip.h:172
A cross is used to highlight points (x)