QGIS API Documentation
3.0.2-Girona (307d082)
|
A class for drawing transient features (e.g. More...
#include <qgsrubberband.h>
Public Types | |
enum | IconType { ICON_NONE, ICON_CROSS, ICON_X, ICON_BOX, ICON_CIRCLE, ICON_FULL_BOX, ICON_DIAMOND, ICON_FULL_DIAMOND } |
Icons. More... | |
Public Member Functions | |
QgsRubberBand (QgsMapCanvas *mapCanvas, QgsWkbTypes::GeometryType geometryType=QgsWkbTypes::LineGeometry) | |
Creates a new RubberBand. More... | |
void | addGeometry (const QgsGeometry &geometry, QgsVectorLayer *layer) |
Adds the geometry of an existing feature to a rubberband This is useful for multi feature highlighting. More... | |
void | addGeometry (const QgsGeometry &geometry, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem()) |
Adds a geometry to the rubberband. More... | |
void | addPoint (const QgsPointXY &p, bool doUpdate=true, int geometryIndex=0) |
Adds a vertex to the rubberband and update canvas. More... | |
QgsGeometry | asGeometry () const |
Returns the rubberband as a Geometry. More... | |
void | closePoints (bool doUpdate=true, int geometryIndex=0) |
Ensures that a polygon geometry is closed and that the last vertex equals the first vertex. More... | |
QColor | fillColor () const |
Returns the current fill color. More... | |
const QgsPointXY * | getPoint (int i, int j=0) const |
Returns a vertex. More... | |
IconType | icon () const |
Returns the current icon type to highlight point geometries. More... | |
int | iconSize () const |
Returns the current icon size of the point icons. More... | |
void | movePoint (const QgsPointXY &p, int geometryIndex=0) |
Moves the rubber band point specified by index. More... | |
void | movePoint (int index, const QgsPointXY &p, int geometryIndex=0) |
Moves the rubber band point specified by index. More... | |
int | numberOfVertices () const |
Returns count of vertices in all lists of mPoint. More... | |
int | partSize (int geometryIndex) const |
Returns number of vertices in feature part. More... | |
void | removeLastPoint (int geometryIndex=0, bool doUpdate=true) |
Removes the last point. More... | |
void | removePoint (int index=0, bool doUpdate=true, int geometryIndex=0) |
Removes a vertex from the rubberband and (optionally) updates canvas. More... | |
void | reset (QgsWkbTypes::GeometryType geometryType=QgsWkbTypes::LineGeometry) |
Clears all the geometries in this rubberband. More... | |
QColor | secondaryStrokeColor () const |
Returns the current secondary stroke color. More... | |
void | setBrushStyle (Qt::BrushStyle brushStyle) |
Sets the style of the brush. More... | |
void | setColor (const QColor &color) |
Sets the color for the rubberband. More... | |
void | setFillColor (const QColor &color) |
Sets the fill color for the rubberband. More... | |
void | setIcon (IconType icon) |
Sets the icon type to highlight point geometries. More... | |
void | setIconSize (int iconSize) |
Sets the size of the point icons. More... | |
void | setLineStyle (Qt::PenStyle penStyle) |
Sets the style of the line. More... | |
void | setSecondaryStrokeColor (const QColor &color) |
Sets a secondary stroke color for the rubberband which will be drawn under the main stroke color. More... | |
void | setStrokeColor (const QColor &color) |
Sets the stroke color for the rubberband. More... | |
void | setToCanvasRectangle (QRect rect) |
Sets this rubber band to a map canvas rectangle. More... | |
void | setToGeometry (const QgsGeometry &geom, QgsVectorLayer *layer) |
Sets this rubber band to the geometry of an existing feature. More... | |
void | setTranslationOffset (double dx, double dy) |
Adds translation to original coordinates (all in map coordinates) More... | |
void | setWidth (int width) |
Sets the width of the line. More... | |
int | size () const |
Returns number of geometries. More... | |
QColor | strokeColor () const |
Returns the current stroke color. More... | |
void | updatePosition () override |
called on changed extent or resize event to update position of the item More... | |
int | width () const |
Returns the current width of the line or stroke width for polygon. More... | |
Public Member Functions inherited from QgsMapCanvasItem | |
QRectF | boundingRect () const override |
QgsRectangle | rect () const |
returns canvas item rectangle in map units More... | |
void | setRect (const QgsRectangle &r, bool resetRotation=true) |
sets canvas item rectangle in map units More... | |
QPointF | toCanvasCoordinates (const QgsPointXY &point) const |
transformation from map coordinates to screen coordinates More... | |
QgsPointXY | toMapCoordinates (QPoint point) const |
transformation from screen coordinates to map coordinates More... | |
Protected Member Functions | |
void | drawShape (QPainter *p, const QVector< QPointF > &pts) |
Draws shape of the rubber band. More... | |
void | paint (QPainter *p) override |
Paints the rubber band in response to an update event. More... | |
void | updateRect () |
Recalculates needed rectangle. More... | |
Protected Member Functions inherited from QgsMapCanvasItem | |
QgsMapCanvasItem (QgsMapCanvas *mapCanvas) | |
protected constructor: cannot be constructed directly More... | |
~QgsMapCanvasItem () override | |
void | paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget=nullptr) override |
bool | setRenderContextVariables (QPainter *p, QgsRenderContext &context) const |
Sets render context parameters. More... | |
void | updateCanvas () |
schedules map canvas for repaint More... | |
Additional Inherited Members | |
Protected Attributes inherited from QgsMapCanvasItem | |
QSizeF | mItemSize |
cached size of the item (to return in boundingRect()) More... | |
QgsMapCanvas * | mMapCanvas = nullptr |
pointer to map canvas More... | |
QgsRectangle | mRect |
cached canvas item rectangle in map coordinates encodes position (xmin,ymax) and size (width/height) used to re-position and re-size the item on zoom/pan while waiting for the renderer to complete. More... | |
double | mRectRotation |
A class for drawing transient features (e.g.
digitizing lines) on the map.
The QgsRubberBand class provides a transparent overlay widget for tracking the mouse while drawing polylines or polygons.
Definition at line 37 of file qgsrubberband.h.
Icons.
Definition at line 42 of file qgsrubberband.h.
QgsRubberBand::QgsRubberBand | ( | QgsMapCanvas * | mapCanvas, |
QgsWkbTypes::GeometryType | geometryType = QgsWkbTypes::LineGeometry |
||
) |
Creates a new RubberBand.
mapCanvas | The map canvas to draw onto. It's CRS will be used map points onto screen coordinates. |
geometryType | Defines how the data should be drawn onto the screen. (Use Qgis::Line, Qgis::Polygon or Qgis::Point) |
Definition at line 25 of file qgsrubberband.cpp.
void QgsRubberBand::addGeometry | ( | const QgsGeometry & | geometry, |
QgsVectorLayer * | layer | ||
) |
Adds the geometry of an existing feature to a rubberband This is useful for multi feature highlighting.
As of 2.0, this method does not change the GeometryType any more. You need to set the GeometryType of the rubberband explicitly by calling reset() or setToGeometry() with appropriate arguments. setToGeometry() is also to be preferred for backwards-compatibility.
geometry | the geometry object. Will be treated as a collection of vertices. |
layer | the layer containing the feature, used for coord transformation to map crs. In case of 0 pointer, the coordinates are not going to be transformed. |
Definition at line 234 of file qgsrubberband.cpp.
void QgsRubberBand::addGeometry | ( | const QgsGeometry & | geometry, |
const QgsCoordinateReferenceSystem & | crs = QgsCoordinateReferenceSystem() |
||
) |
Adds a geometry to the rubberband.
If crs is specified, the geometry will be automatically reprojected from crs to the canvas CRS.
Definition at line 246 of file qgsrubberband.cpp.
void QgsRubberBand::addPoint | ( | const QgsPointXY & | p, |
bool | doUpdate = true , |
||
int | geometryIndex = 0 |
||
) |
Adds a vertex to the rubberband and update canvas.
The rendering of the vertex depends on the current GeometryType and icon. If adding more points consider using update=false for better performance
p | The vertex/point to add |
doUpdate | Should the map canvas be updated immediately? |
geometryIndex | The index of the feature part (in case of multipart geometries) |
Definition at line 98 of file qgsrubberband.cpp.
QgsGeometry QgsRubberBand::asGeometry | ( | ) | const |
Returns the rubberband as a Geometry.
Definition at line 577 of file qgsrubberband.cpp.
void QgsRubberBand::closePoints | ( | bool | doUpdate = true , |
int | geometryIndex = 0 |
||
) |
Ensures that a polygon geometry is closed and that the last vertex equals the first vertex.
doUpdate | set to true to update the map canvas immediately |
geometryIndex | index of the feature part (in case of multipart geometries) |
Definition at line 134 of file qgsrubberband.cpp.
|
protected |
Draws shape of the rubber band.
p | The QPainter object |
pts | A list of points used to draw the shape |
Definition at line 403 of file qgsrubberband.cpp.
|
inline |
Returns the current fill color.
Definition at line 111 of file qgsrubberband.h.
const QgsPointXY * QgsRubberBand::getPoint | ( | int | i, |
int | j = 0 |
||
) | const |
Returns a vertex.
i | The geometry index |
j | The vertex index within geometry i |
Definition at line 569 of file qgsrubberband.cpp.
|
inline |
Returns the current icon type to highlight point geometries.
Definition at line 159 of file qgsrubberband.h.
|
inline |
Returns the current icon size of the point icons.
Definition at line 169 of file qgsrubberband.h.
void QgsRubberBand::movePoint | ( | const QgsPointXY & | p, |
int | geometryIndex = 0 |
||
) |
Moves the rubber band point specified by index.
Note that if the rubber band is not used to track the last mouse position, the first point of the rubber band has two vertices
Definition at line 186 of file qgsrubberband.cpp.
void QgsRubberBand::movePoint | ( | int | index, |
const QgsPointXY & | p, | ||
int | geometryIndex = 0 |
||
) |
Moves the rubber band point specified by index.
Note that if the rubber band is not used to track the last mouse position, the first point of the rubber band has two vertices
Definition at line 204 of file qgsrubberband.cpp.
int QgsRubberBand::numberOfVertices | ( | ) | const |
Returns count of vertices in all lists of mPoint.
Definition at line 554 of file qgsrubberband.cpp.
|
overrideprotectedvirtual |
Paints the rubber band in response to an update event.
p | The QPainter object |
Implements QgsMapCanvasItem.
Definition at line 361 of file qgsrubberband.cpp.
int QgsRubberBand::partSize | ( | int | geometryIndex | ) | const |
Returns number of vertices in feature part.
geometryIndex | The index of the feature part (in case of multipart geometries) |
Definition at line 548 of file qgsrubberband.cpp.
void QgsRubberBand::removeLastPoint | ( | int | geometryIndex = 0 , |
bool | doUpdate = true |
||
) |
Removes the last point.
Most useful in connection with undo operations
Definition at line 181 of file qgsrubberband.cpp.
void QgsRubberBand::removePoint | ( | int | index = 0 , |
bool | doUpdate = true , |
||
int | geometryIndex = 0 |
||
) |
Removes a vertex from the rubberband and (optionally) updates canvas.
index | The index of the vertex/point to remove, negative indexes start at end |
doUpdate | Should the map canvas be updated immediately? |
geometryIndex | The index of the feature part (in case of multipart geometries) |
Definition at line 155 of file qgsrubberband.cpp.
void QgsRubberBand::reset | ( | QgsWkbTypes::GeometryType | geometryType = QgsWkbTypes::LineGeometry | ) |
Clears all the geometries in this rubberband.
Sets the representation type according to geometryType.
geometryType | Defines how the data should be drawn onto the screen. (Use Qgis::Line, Qgis::Polygon or Qgis::Point) |
Definition at line 90 of file qgsrubberband.cpp.
|
inline |
Returns the current secondary stroke color.
Definition at line 136 of file qgsrubberband.h.
void QgsRubberBand::setBrushStyle | ( | Qt::BrushStyle | brushStyle | ) |
Sets the style of the brush.
Definition at line 85 of file qgsrubberband.cpp.
void QgsRubberBand::setColor | ( | const QColor & | color | ) |
Sets the color for the rubberband.
color | The color used to render this rubberband |
Definition at line 44 of file qgsrubberband.cpp.
void QgsRubberBand::setFillColor | ( | const QColor & | color | ) |
Sets the fill color for the rubberband.
color | The color used to render this rubberband |
Definition at line 50 of file qgsrubberband.cpp.
void QgsRubberBand::setIcon | ( | IconType | icon | ) |
Sets the icon type to highlight point geometries.
icon | The icon to visualize point geometries |
Definition at line 70 of file qgsrubberband.cpp.
void QgsRubberBand::setIconSize | ( | int | iconSize | ) |
Sets the size of the point icons.
Definition at line 75 of file qgsrubberband.cpp.
void QgsRubberBand::setLineStyle | ( | Qt::PenStyle | penStyle | ) |
Sets the style of the line.
Definition at line 80 of file qgsrubberband.cpp.
void QgsRubberBand::setSecondaryStrokeColor | ( | const QColor & | color | ) |
Sets a secondary stroke color for the rubberband which will be drawn under the main stroke color.
Set to an invalid color to avoid drawing the secondary stroke.
color | The color used to render a secondary stroke color to this rubberband |
Definition at line 60 of file qgsrubberband.cpp.
void QgsRubberBand::setStrokeColor | ( | const QColor & | color | ) |
Sets the stroke color for the rubberband.
color | The color used to render this rubberband |
Definition at line 55 of file qgsrubberband.cpp.
void QgsRubberBand::setToCanvasRectangle | ( | QRect | rect | ) |
Sets this rubber band to a map canvas rectangle.
rect | rectangle in canvas coordinates |
Definition at line 341 of file qgsrubberband.cpp.
void QgsRubberBand::setToGeometry | ( | const QgsGeometry & | geom, |
QgsVectorLayer * | layer | ||
) |
Sets this rubber band to the geometry of an existing feature.
This is useful for feature highlighting. In contrast to addGeometry(), this method does also change the geometry type of the rubberband.
geom | the geometry object |
layer | the layer containing the feature, used for coord transformation to map crs. In case of 0 pointer, the coordinates are not going to be transformed. |
Definition at line 222 of file qgsrubberband.cpp.
void QgsRubberBand::setTranslationOffset | ( | double | dx, |
double | dy | ||
) |
Adds translation to original coordinates (all in map coordinates)
dx | x translation |
dy | y translation |
Definition at line 536 of file qgsrubberband.cpp.
void QgsRubberBand::setWidth | ( | int | width | ) |
Sets the width of the line.
Stroke width for polygon.
width | The width for any lines painted for this rubberband |
Definition at line 65 of file qgsrubberband.cpp.
int QgsRubberBand::size | ( | ) | const |
Returns number of geometries.
Definition at line 543 of file qgsrubberband.cpp.
|
inline |
Returns the current stroke color.
Definition at line 123 of file qgsrubberband.h.
|
overridevirtual |
called on changed extent or resize event to update position of the item
Reimplemented from QgsMapCanvasItem.
Definition at line 526 of file qgsrubberband.cpp.
|
protected |
Recalculates needed rectangle.
Definition at line 481 of file qgsrubberband.cpp.
|
inline |
Returns the current width of the line or stroke width for polygon.
Definition at line 147 of file qgsrubberband.h.