A class for drawing transient features (e.g. More...

#include <qgsrubberband.h>

Inheritance diagram for QgsRubberBand:

Collaboration diagram for QgsRubberBand:

Public Types
enum	IconType { ICON_NONE, ICON_CROSS, ICON_X, ICON_BOX, ICON_CIRCLE, ICON_FULL_BOX }
	Icons Added in 1.9. More...

Public Member Functions
	QgsRubberBand (QgsMapCanvas *mapCanvas, QGis::GeometryType geometryType=QGis::Line)
	Creates a new RubberBand.
	QgsRubberBand (QgsMapCanvas *mapCanvas, bool isPolygon)
	Creates a new RubberBand.
	~QgsRubberBand ()
void	setColor (const QColor &color)
	Set the color for the rubberband.
void	setWidth (int width)
	Set the width of the line.
void	setIcon (IconType icon)
	Set the icon type to highlight point geometries.
void	setIconSize (int iconSize)
	Set the size of the point icons.
void	setLineStyle (Qt::PenStyle penStyle)
	Set the style of the line.
void	setBrushStyle (Qt::BrushStyle brushStyle)
	Set the style of the brush.
void	reset (QGis::GeometryType geometryType=QGis::Line)
	Clears all the geometries in this rubberband.
void	reset (bool isPolygon)
void	addPoint (const QgsPoint &p, bool doUpdate=true, int geometryIndex=0)
	Add a vertex to the rubberband and update canvas.
void	removePoint (int index=0, bool doUpdate=true, int geometryIndex=0)
	Remove a vertex from the rubberband and (optionally) update canvas.
void	removeLastPoint (int geometryIndex=0, bool doUpdate=true)
	Removes the last point.
void	movePoint (const QgsPoint &p, int geometryIndex=0)
	Moves the rubber band point specified by index.
void	movePoint (int index, const QgsPoint &p, int geometryIndex=0)
	Moves the rubber band point specified by index.
int	partSize (int geometryIndex) const
	Returns number of vertices in feature part.
void	setToGeometry (QgsGeometry geom, QgsVectorLayer layer)
	Sets this rubber band to the geometry of an existing feature.
void	setToCanvasRectangle (const QRect &rect)
	Sets this rubber band to a map canvas rectangle.
void	addGeometry (QgsGeometry geom, QgsVectorLayer layer)
	Add the geometry of an existing feature to a rubberband This is useful for multi feature highlighting.
void	setTranslationOffset (double dx, double dy)
	Adds translation to original coordinates (all in map coordinates)
int	size () const
	Returns number of geometries.
int	numberOfVertices () const
	Returns count of vertices in all lists of mPoint.
const QgsPoint *	getPoint (int i, int j=0) const
	Return vertex.
QgsGeometry *	asGeometry ()
	Returns the rubberband as a Geometry.
Public Member Functions inherited from QgsMapCanvasItem
virtual void	updatePosition ()
	called on changed extent or resize event to update position of the item
virtual QRectF	boundingRect () const
	default implementation for canvas items
void	setPanningOffset (const QPoint &point)
	sets current offset, to be called from QgsMapCanvas
QgsRectangle	rect () const
	returns canvas item rectangle
void	setRect (const QgsRectangle &r)
	sets canvas item rectangle
QgsPoint	toMapCoordinates (const QPoint &point)
	transformation from screen coordinates to map coordinates
QPointF	toCanvasCoordinates (const QgsPoint &point)
	transformation from map coordinates to screen coordinates

Protected Member Functions
virtual void	paint (QPainter *p)
void	updateRect ()
	recalculates needed rectangle
Protected Member Functions inherited from QgsMapCanvasItem
	QgsMapCanvasItem (QgsMapCanvas *mapCanvas)
	protected constructor: cannot be constructed directly
virtual	~QgsMapCanvasItem ()
virtual void	paint (QPainter painter, const QStyleOptionGraphicsItem option, QWidget *widget=0)
	paint function called by map canvas
void	updateCanvas ()
	schedules map canvas for repaint
bool	setRenderContextVariables (QPainter *p, QgsRenderContext &context) const
	Sets render context parameters.

Private Member Functions
	QgsRubberBand ()

Static Private Member Functions
static QgsPolyline	getPolyline (const QList< QgsPoint > &points)

Private Attributes
QBrush	mBrush
QPen	mPen
int	mIconSize
	The size of the icon for points.
IconType	mIconType
	Icon to be shown.
QList< QList< QgsPoint > >	mPoints
	Nested lists used for multitypes.
QGis::GeometryType	mGeometryType
double	mTranslationOffsetX
double	mTranslationOffsetY

Additional Inherited Members
Protected Attributes inherited from QgsMapCanvasItem
QgsMapCanvas *	mMapCanvas
	pointer to map canvas
QgsRectangle	mRect
	canvas item rectangle (in map coordinates)
QPoint	mPanningOffset
	offset from normal position due current panning operation, used when converting map coordinates to move map canvas items
QSizeF	mItemSize
	cached size of the item (to return in boundingRect())

Detailed Description

A class for drawing transient features (e.g.

The QgsRubberBand class provides a transparent overlay widget for tracking the mouse while drawing polylines or polygons.

digitising lines) on the map. It may be used

Definition at line 32 of file qgsrubberband.h.

Member Enumeration Documentation

enum QgsRubberBand::IconType

Icons Added in 1.9.

Enumerator:

ICON_NONE	No icon is used.
ICON_CROSS	A cross is used to highlight points (+)
ICON_X	A cross is used to highlight points (x)
ICON_BOX	A box is used to highlight points (□)
ICON_CIRCLE	A circle is used to highlight points (○)
ICON_FULL_BOX	A full box is used to highlight points (■)

Definition at line 38 of file qgsrubberband.h.

Constructor & Destructor Documentation

QgsRubberBand::QgsRubberBand	(	QgsMapCanvas *	mapCanvas,
		QGis::GeometryType	geometryType = `QGis::Line`
	)

Creates a new RubberBand.

Parameters

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)

Note: Added in 1.9.

Definition at line 30 of file qgsrubberband.cpp.

References reset(), setBrushStyle(), setColor(), setLineStyle(), and setWidth().

QgsRubberBand::QgsRubberBand	(	QgsMapCanvas *	mapCanvas,
		bool	isPolygon
	)

Creates a new RubberBand.

Deprecated:: Use the constructor which takes QGis::GeometryType as second argument instead

Parameters

mapCanvas	The map canvas to draw onto. It's CRS will be used map points onto screen coordinates.
isPolygon	true: draw as (multi-)polygon, false draw as (multi-)linestring

Definition at line 47 of file qgsrubberband.cpp.

References QGis::Line, QGis::Polygon, reset(), setBrushStyle(), setColor(), setLineStyle(), and setWidth().

QgsRubberBand::~QgsRubberBand ( )

Definition at line 67 of file qgsrubberband.cpp.

QgsRubberBand::QgsRubberBand ( )

private

Definition at line 63 of file qgsrubberband.cpp.

Member Function Documentation

void QgsRubberBand::addGeometry	(	QgsGeometry *	geom,
		QgsVectorLayer *	layer
	)

Add 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.

Parameters

geom	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.

Note: added in 1.5

Definition at line 249 of file qgsrubberband.cpp.

References addPoint(), QgsGeometry::asMultiPoint(), QgsGeometry::asMultiPolygon(), QgsGeometry::asMultiPolyline(), QgsGeometry::asPoint(), QgsGeometry::asPolygon(), QgsGeometry::asPolyline(), QgsMapRenderer::layerToMapCoordinates(), QgsMapCanvas::mapRenderer(), QgsMapCanvasItem::mMapCanvas, mPoints, removeLastPoint(), updateRect(), QGis::WKBLineString, QGis::WKBLineString25D, QGis::WKBMultiLineString, QGis::WKBMultiLineString25D, QGis::WKBMultiPoint, QGis::WKBMultiPoint25D, QGis::WKBMultiPolygon, QGis::WKBMultiPolygon25D, QGis::WKBPoint, QGis::WKBPoint25D, QGis::WKBPolygon, QGis::WKBPolygon25D, QgsGeometry::wkbType(), and QGis::WKBUnknown.

Referenced by setToGeometry().

void QgsRubberBand::addPoint	(	const QgsPoint &	p,
		bool	doUpdate = `true`,
		int	geometryIndex = `0`
	)

Add 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

Parameters

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)

Add a point to the shape being created.

Definition at line 131 of file qgsrubberband.cpp.

References mPoints, size(), and updateRect().

Referenced by addGeometry(), and setToCanvasRectangle().

QgsGeometry * QgsRubberBand::asGeometry ( )

Returns the rubberband as a Geometry.

Returns: A geometry object which reflects the current state of the rubberband.

Note: Added in 1.6

Definition at line 583 of file qgsrubberband.cpp.

References QgsGeometry::fromMultiPoint(), QgsGeometry::fromMultiPolyline(), QgsGeometry::fromPolygon(), QgsGeometry::fromPolyline(), getPolyline(), QGis::Line, mGeometryType, mPoints, QGis::Point, and QGis::Polygon.

const QgsPoint * QgsRubberBand::getPoint	(	int	i,
		int	j = `0`
	)		const

Return vertex.

Parameters

i	The geometry index
j	The vertex index within geometry i

Definition at line 575 of file qgsrubberband.cpp.

References mPoints.

QgsPolyline QgsRubberBand::getPolyline ( const QList< QgsPoint > & points )

staticprivate

Definition at line 640 of file qgsrubberband.cpp.

Referenced by asGeometry().

void QgsRubberBand::movePoint	(	const QgsPoint &	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

Update the line between the last added point and the mouse position.

Definition at line 201 of file qgsrubberband.cpp.

References mPoints, and updateRect().

void QgsRubberBand::movePoint	(	int	index,
		const QgsPoint &	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 219 of file qgsrubberband.cpp.

References index, mPoints, and updateRect().

int QgsRubberBand::numberOfVertices ( ) const

Returns count of vertices in all lists of mPoint.

Returns: The total number of vertices

Definition at line 560 of file qgsrubberband.cpp.

References mPoints.

void QgsRubberBand::paint ( QPainter * p )

protectedvirtual

Draw the shape in response to an update event.

Implements QgsMapCanvasItem.

Definition at line 426 of file qgsrubberband.cpp.

References ICON_BOX, ICON_CIRCLE, ICON_CROSS, ICON_FULL_BOX, ICON_NONE, ICON_X, QGis::Line, mBrush, mGeometryType, mIconSize, mIconType, mPen, mPoints, mTranslationOffsetX, mTranslationOffsetY, QGis::Point, QGis::Polygon, QgsMapCanvasItem::toCanvasCoordinates(), QgsPoint::x(), and QgsPoint::y().

int QgsRubberBand::partSize ( int geometryIndex ) const

Returns number of vertices in feature part.

Parameters

geometryIndex The index of the feature part (in case of multipart geometries)

Returns: number of vertices

Definition at line 554 of file qgsrubberband.cpp.

References mPoints.

void QgsRubberBand::removeLastPoint	(	int	geometryIndex = `0`,
		bool	doUpdate = `true`
	)

Removes the last point.

Most useful in connection with undo operations

Definition at line 193 of file qgsrubberband.cpp.

References removePoint().

Referenced by addGeometry().

void QgsRubberBand::removePoint	(	int	index = `0`,
		bool	doUpdate = `true`,
		int	geometryIndex = `0`
	)

Remove a vertex from the rubberband and (optionally) update canvas.

Parameters

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 167 of file qgsrubberband.cpp.

References index, mPoints, size(), and updateRect().

Referenced by removeLastPoint().

void QgsRubberBand::reset ( QGis::GeometryType geometryType = QGis::Line )

Clears all the geometries in this rubberband.

Sets the representation type according to geometryType.

Parameters

geometryType Defines how the data should be drawn onto the screen. (Use QGis::Line, QGis::Polygon or QGis::Point)

Note: Added in 1.9.

Remove all points from the shape being created.

Definition at line 112 of file qgsrubberband.cpp.

References mGeometryType, mPoints, and updateRect().

Referenced by QgsRubberBand(), setToCanvasRectangle(), and setToGeometry().

void QgsRubberBand::reset ( bool isPolygon )

Deprecated:: Use the reset method which takes QGis::GeometryType as second argument instead Clears all the geometries in this rubberband. Sets the representation type according to isPolygon.

Parameters

isPolygon true: draw as (multi-)polygon, false draw as (multi-)linestring

Definition at line 120 of file qgsrubberband.cpp.

References QGis::Line, mGeometryType, mPoints, QGis::Polygon, and updateRect().

void QgsRubberBand::setBrushStyle ( Qt::BrushStyle brushStyle )

Set the style of the brush.

Note: Added in 1.9

Definition at line 104 of file qgsrubberband.cpp.

References mBrush.

Referenced by QgsRubberBand().

void QgsRubberBand::setColor ( const QColor & color )

Set the color for the rubberband.

Parameters

color The color used to render this rubberband

Set the outline and fill color.

Definition at line 74 of file qgsrubberband.cpp.

References mBrush, and mPen.

Referenced by QgsRubberBand().

void QgsRubberBand::setIcon ( IconType icon )

Set the icon type to highlight point geometries.

Parameters

icon	The icon to visualize point geometries

Note: Added in 1.9

Definition at line 89 of file qgsrubberband.cpp.

References icon(), and mIconType.

void QgsRubberBand::setIconSize ( int iconSize )

Set the size of the point icons.

Note: Added in 1.9

Definition at line 94 of file qgsrubberband.cpp.

References mIconSize.

void QgsRubberBand::setLineStyle ( Qt::PenStyle penStyle )

Set the style of the line.

Note: Added in 1.9

Definition at line 99 of file qgsrubberband.cpp.

References mPen.

Referenced by QgsRubberBand().

void QgsRubberBand::setToCanvasRectangle ( const QRect & rect )

Sets this rubber band to a map canvas rectangle.

Parameters

rect	rectangle in canvas coordinates

Note: added in version 1.7

Definition at line 405 of file qgsrubberband.cpp.

References addPoint(), QgsMapCanvas::getCoordinateTransform(), QgsMapCanvasItem::mMapCanvas, QGis::Polygon, reset(), QgsMapToPixel::toMapCoordinates(), QgsPoint::x(), and QgsPoint::y().

Referenced by QgsMapToolZoom::canvasMoveEvent().

void QgsRubberBand::setToGeometry	(	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.

Parameters

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 237 of file qgsrubberband.cpp.

References addGeometry(), mGeometryType, reset(), and QgsGeometry::type().