qgsrubberband.h

Go to the documentation of this file.

/***************************************************************************
    qgsrubberband.h - Rubberband widget for drawing multilines and polygons
     --------------------------------------
    Date                 : 07-Jan-2006
    Copyright            : (C) 2006 by Tom Elwertowski
    Email                : telwertowski at users dot sourceforge dot net
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSRUBBERBAND_H
#define QGSRUBBERBAND_H

#include "qgsmapcanvasitem.h"
#include "qgsgeometry.h"
#include <QBrush>
#include <QList>
#include <QPen>
#include <QPolygon>

class QgsVectorLayer;
class QPaintEvent;

class GUI_EXPORT QgsRubberBand: public QgsMapCanvasItem
{
  public:

    enum IconType
    {
      ICON_NONE,
      ICON_CROSS,
      ICON_X,
      ICON_BOX,
      ICON_CIRCLE,
      ICON_FULL_BOX
    };

    QgsRubberBand( QgsMapCanvas* mapCanvas, QGis::GeometryType geometryType = QGis::Line );
    Q_DECL_DEPRECATED QgsRubberBand( QgsMapCanvas* mapCanvas, bool isPolygon );
    ~QgsRubberBand();

    void setColor( const QColor & color );

    void setFillColor( const QColor & color );

    void setBorderColor( const QColor & color );

    void setWidth( int width );

    void setIcon( IconType icon );

    void setIconSize( int iconSize );

    void setLineStyle( Qt::PenStyle penStyle );

    void setBrushStyle( Qt::BrushStyle brushStyle );

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

    Q_DECL_DEPRECATED void reset( bool isPolygon );

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

    void closePoints( bool doUpdate = true, int geometryIndex = 0 );

    void removePoint( int index = 0, bool doUpdate = true, int geometryIndex = 0 );

    void removeLastPoint( int geometryIndex = 0, bool doUpdate = true );

    void movePoint( const QgsPoint & p, int geometryIndex = 0 );

    void movePoint( int index, const QgsPoint& p, int geometryIndex = 0 );

    int partSize( int geometryIndex ) const;

    void setToGeometry( const QgsGeometry *geom, QgsVectorLayer* layer );

    void setToCanvasRectangle( QRect rect );

    void addGeometry( const QgsGeometry *geom, QgsVectorLayer* layer );

    void setTranslationOffset( double dx, double dy );

    int size() const;

    int numberOfVertices() const;

    const QgsPoint *getPoint( int i, int j = 0 ) const;

    QgsGeometry* asGeometry();

    virtual void updatePosition() override;

  protected:
    virtual void paint( QPainter* p ) override;

    void updateRect();

  private:
    QBrush mBrush;
    QPen mPen;

    int mIconSize;

    IconType mIconType;

    QList< QList <QgsPoint> > mPoints;
    QGis::GeometryType mGeometryType;
    double mTranslationOffsetX;
    double mTranslationOffsetY;

    QgsRubberBand();

    static QgsPolyline getPolyline( const QList<QgsPoint> & points );

};

#endif