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 "qgis_gui.h"
#include "qgis_sip.h"
#include "qgscoordinatereferencesystem.h"
#include "qgsgeometry.h"
#include "qgsmapcanvasitem.h"
 
#include <QBrush>
#include <QObject>
#include <QPen>
#include <QPointer>
#include <QPolygon>
#include <QSvgRenderer>
#include <QVector>
 
class QgsMapLayer;
class QgsVectorLayer;
class QgsMapLayer;
class QPaintEvent;
class QgsSymbol;
 
#ifdef SIP_RUN
//%ModuleHeaderCode
// For ConvertToSubClassCode.
#include <qgsrubberband.h>
//%End
#endif
 
class QgsRubberBand;

class GUI_EXPORT QgsRubberBandPreviewItem
{
  public:
    virtual ~QgsRubberBandPreviewItem() = default;

    QgsRubberBand *rubberBand();

    virtual void render( QgsRenderContext &context ) = 0;

    virtual QRectF boundingRect() const;
 
  protected:
    QgsRubberBandPreviewItem( QgsRubberBand *rubberBand );
 
  private:
    QPointer< QgsRubberBand > mRubberBand;
};
 

#ifndef SIP_RUN
class GUI_EXPORT QgsRubberBand : public QObject, public QgsMapCanvasItem
{
#else
class GUI_EXPORT QgsRubberBand : public QgsMapCanvasItem
{
#endif
    Q_OBJECT
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast<QgsRubberBand *>( sipCpp ) )
    {
      sipType = sipType_QgsRubberBand;
      // We need to tweak the pointer as sip believes it is single inheritance
      // from QgsMapCanvasItem, but the raw address of QgsRubberBand (sipCpp)
      // is actually a QObject
      *sipCppRet = dynamic_cast<QgsRubberBand *>( sipCpp );
    }
    else
      sipType = nullptr;
  SIP_END
#endif
  public:
    Q_PROPERTY( QColor fillColor READ fillColor WRITE setFillColor )
    Q_PROPERTY( QColor strokeColor READ strokeColor WRITE setStrokeColor )
    Q_PROPERTY( int iconSize READ iconSize WRITE setIconSize )
    Q_PROPERTY( QColor secondaryStrokeColor READ secondaryStrokeColor WRITE setSecondaryStrokeColor )
    Q_PROPERTY( int width READ width WRITE setWidth )

    QgsRubberBand( QgsMapCanvas *mapCanvas SIP_TRANSFERTHIS, Qgis::GeometryType geometryType = Qgis::GeometryType::Line );
    ~QgsRubberBand() override;

    void setColor( const QColor &color );

    void setFillColor( const QColor &color );

    QColor fillColor() const { return mBrush.color(); }

    void setStrokeColor( const QColor &color );

    QColor strokeColor() const { return mPen.color(); }

    void setSecondaryStrokeColor( const QColor &color );

    QColor secondaryStrokeColor() const { return mSecondaryPen.color(); }

    void setWidth( double width );

    int width() const { return mPen.width(); }

    void setIcon( Qgis::RubberBandIconType icon );

    void setSvgIcon( const QString &path, QPoint drawOffset );
 

    Qgis::RubberBandIconType icon() const { return mIconType; }

    void setIconSize( double iconSize );

    double iconSize() const { return mIconSize; }

    void setLineStyle( Qt::PenStyle penStyle );

    void setBrushStyle( Qt::BrushStyle brushStyle );

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

    void addPreviewItem( QgsRubberBandPreviewItem *item SIP_TRANSFER );

    void clearPreviewItems();

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

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

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

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

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

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

    int partSize( int geometryIndex ) const;

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

    void setToGeometry( const QgsGeometry &geometry, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem() );

    void setToCanvasRectangle( QRect rect );

    void copyPointsFrom( const QgsRubberBand *other );

    void addGeometry( const QgsGeometry &geometry, QgsMapLayer *layer, bool doUpdate = true );

    void addGeometry( const QgsGeometry &geometry, const QgsCoordinateReferenceSystem &crs = QgsCoordinateReferenceSystem(), bool doUpdate = true );

    void setTranslationOffset( double dx, double dy );

    int size() const;

    int numberOfVertices() const;
 
    // TODO QGIS 5: rename i to geometryIndex, j to vertexIndex
    // TODO QGIS 5: reorder parameters to geom, ring, ring

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

    QgsGeometry asGeometry() const;
 
    void updatePosition() override;

    QgsSymbol *symbol() const;

    void setSymbol( QgsSymbol *symbol SIP_TRANSFER );

    Qgis::RubberBandComponents renderedComponents() const;

    void setRenderedComponents( Qgis::RubberBandComponents components );
    QRectF boundingRect() const override;
 
  protected:
    using QgsMapCanvasItem::paint;

    void paint( QPainter *p ) override;

    void drawShape( QPainter *p, const QVector<QPointF> &pts );

    void drawShape( QPainter *p, const QVector<QPolygonF> &rings );

    void updateRect();
 
  private:
    QBrush mBrush;
    QPen mPen;
    QPen mSecondaryPen;

    double mIconSize = 5;

    Qgis::RubberBandIconType mIconType = Qgis::RubberBandIconType::Circle;
    Qgis::RubberBandComponents mComponentsToRender = Qgis::RubberBandComponent::Symbol | Qgis::RubberBandComponent::PreviewItems;
    std::unique_ptr<QSvgRenderer> mSvgRenderer;
    QPoint mSvgOffset;
 
    std::unique_ptr<QgsSymbol> mSymbol;

    QVector<QVector<QVector<QgsPointXY>>> mPoints;
    Qgis::GeometryType mGeometryType = Qgis::GeometryType::Polygon;
    double mTranslationOffsetX = 0.0;
    double mTranslationOffsetY = 0.0;
 
    std::vector<std::unique_ptr<QgsRubberBandPreviewItem>> mPreviewItems;
 
    QgsRubberBand();
};
 
#endif