qgsplotrubberband.h

Go to the documentation of this file.

/***************************************************************************
                          qgsplotrubberband.h
                          ---------------
    begin                : March 2022
    copyright            : (C) 2022 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   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 QGSPLOTRUBBERBAND_H
#define QGSPLOTRUBBERBAND_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
 
#include <QBrush>
#include <QObject>
#include <QPen>
#include <QPointF>
 
class QgsPlotCanvas;
class QGraphicsRectItem;

class GUI_EXPORT QgsPlotRubberBand : public QObject
{
    Q_OBJECT
 
  public:
    QgsPlotRubberBand( QgsPlotCanvas *canvas = nullptr );
 
    ~QgsPlotRubberBand() override = default;

    virtual void start( QPointF position, Qt::KeyboardModifiers modifiers ) = 0;

    virtual void update( QPointF position, Qt::KeyboardModifiers modifiers ) = 0;

    virtual QRectF finish( QPointF position = QPointF(), Qt::KeyboardModifiers modifiers = Qt::KeyboardModifiers() ) = 0;

    QgsPlotCanvas *canvas() const;

    QBrush brush() const;

    void setBrush( const QBrush &brush );

    QPen pen() const;

    void setPen( const QPen &pen );
 
  protected:
    QRectF updateRect( QPointF start, QPointF position, bool constrainSquare, bool fromCenter );
 
  private:
    QgsPlotCanvas *mCanvas = nullptr;
 
    QBrush mBrush = Qt::NoBrush;
    QPen mPen = QPen( QBrush( QColor( 227, 22, 22, 200 ) ), 0 );
};

class GUI_EXPORT QgsPlotRectangularRubberBand : public QgsPlotRubberBand
{
    Q_OBJECT
 
  public:
    QgsPlotRectangularRubberBand( QgsPlotCanvas *canvas = nullptr );
 
    ~QgsPlotRectangularRubberBand() override;
 
    void start( QPointF position, Qt::KeyboardModifiers modifiers ) override;
    void update( QPointF position, Qt::KeyboardModifiers modifiers ) override;
    QRectF finish( QPointF position = QPointF(), Qt::KeyboardModifiers modifiers = Qt::KeyboardModifiers() ) override;
 
  private:
    QGraphicsRectItem *mRubberBandItem = nullptr;

    QPointF mRubberBandStartPos;
};
 
#endif // QGSPLOTRUBBERBAND_H