QGIS API Documentation  3.23.0-Master (dd0cd13a00)
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 #include "qgscompoundcurve.h"
28 #include "qgscurvepolygon.h"
29 #include "qgscircularstring.h"
30 #include "qgslinestring.h"
31 #include "qgspoint.h"
32 
33 #ifdef SIP_RUN
34 % ModuleHeaderCode
35 // For ConvertToSubClassCode.
36 #include <qgsgeometryrubberband.h>
37 % End
38 #endif
39 
41 class QgsPoint;
42 struct QgsVertexId;
43 
48 class GUI_EXPORT QgsGeometryRubberBand: public QgsMapCanvasItem
49 {
50 
51 #ifdef SIP_RUN
53  if ( dynamic_cast<QgsGeometryRubberBand *>( sipCpp ) )
54  sipType = sipType_QgsGeometryRubberBand;
55  else
56  sipType = nullptr;
57  SIP_END
58 #endif
59 
60  public:
61  enum IconType
62  {
63 
68 
73 
78 
83 
88 
92  ICON_FULL_BOX
93  };
94 
96  ~QgsGeometryRubberBand() override;
97 
99  virtual void setGeometry( QgsAbstractGeometry *geom SIP_TRANSFER );
101  const QgsAbstractGeometry *geometry() { return mGeometry.get(); }
103  void moveVertex( QgsVertexId id, const QgsPoint &newPos );
105  void setFillColor( const QColor &c );
107  void setStrokeColor( const QColor &c );
109  void setStrokeWidth( int width );
111  void setLineStyle( Qt::PenStyle penStyle );
113  void setBrushStyle( Qt::BrushStyle brushStyle );
115  void setIconType( IconType iconType ) { mIconType = iconType; }
117  void setVertexDrawingEnabled( bool isVerticesDrawn );
118 
119  protected:
120  void paint( QPainter *painter ) override;
121 
123  QgsWkbTypes::GeometryType geometryType() const;
124 
126  void setGeometryType( const QgsWkbTypes::GeometryType &geometryType );
127 
128  private:
129  std::unique_ptr<QgsAbstractGeometry> mGeometry = nullptr;
130  QBrush mBrush;
131  QPen mPen;
132  int mIconSize;
133  IconType mIconType;
134  QgsWkbTypes::GeometryType mGeometryType;
135  bool mDrawVertices = true;
136 
137  void drawVertex( QPainter *p, double x, double y );
138  QgsRectangle rubberBandRectangle() const;
139 };
140 
141 
142 #endif // QGSGEOMETRYRUBBERBAND_H
Abstract base class for all geometries.
A rubberband class for QgsAbstractGeometry (considering curved geometries).
const QgsAbstractGeometry * geometry()
Returns a pointer to the geometry.
@ ICON_X
A cross is used to highlight points (x)
@ ICON_NONE
No icon is used.
@ ICON_CIRCLE
A circle is used to highlight points (○)
@ ICON_BOX
A box is used to highlight points (□)
@ ICON_CROSS
A cross is used to highlight points (+)
void setIconType(IconType iconType)
Sets vertex marker icon type.
An abstract class for items that can be placed on the map canvas.
virtual void paint(QPainter *painter)=0
function to be implemented by derived classes
Map canvas is a class for displaying all GIS data types on a canvas.
Definition: qgsmapcanvas.h:89
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:49
A rectangle specified with double values.
Definition: qgsrectangle.h:42
GeometryType
The geometry types are used to group QgsWkbTypes::Type in a coarse way.
Definition: qgswkbtypes.h:141
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
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition: qgis_sip.h:177
#define SIP_TRANSFER
Definition: qgis_sip.h:36
#define SIP_END
Definition: qgis_sip.h:194
Utility class for identifying a unique vertex within a geometry.
Definition: qgsvertexid.h:31