qgshighlight.h

Go to the documentation of this file.

/***************************************************************************
    qgshighlight.h - widget to highlight geometries
     --------------------------------------
    Date                 : 02-Mar-2011
    Copyright            : (C) 2011 by Juergen E. Fischer, norBIT GmbH
    Email                : jef at norbit dot de
 ***************************************************************************
 *                                                                         *
 *   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 QGSHIGHLIGHT_H
#define QGSHIGHLIGHT_H
 
#include "qgis_gui.h"
#include "qgsfeature.h"
#include "qgsgeometry.h"
#include "qgsmapcanvasitem.h"
#include "qgsrendercontext.h"
 
#include <QBrush>
#include <QColor>
#include <QList>
#include <QPainter>
#include <QPainterPath>
#include <QPen>
#include <QPointer>
 
class QgsMapLayer;
class QgsVectorLayer;
class QgsSymbol;
class QgsFeatureRenderer;
 
 
#ifdef SIP_RUN
//%ModuleHeaderCode
// For ConvertToSubClassCode.
#include <qgshighlight.h>
//%End
#endif

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

    QgsHighlight( QgsMapCanvas *mapCanvas SIP_TRANSFERTHIS, const QgsGeometry &geom, QgsMapLayer *layer );

    QgsHighlight( QgsMapCanvas *mapCanvas SIP_TRANSFERTHIS, const QgsFeature &feature, QgsVectorLayer *layer );
    ~QgsHighlight() override;

    QColor color() const { return mColor; }

    void setColor( const QColor &color );

    QColor fillColor() const { return mFillColor; }

    void setFillColor( const QColor &fillColor );

    int width() const { return mWidth; }

    void setWidth( int width );

    double buffer() const { return mBuffer; }

    void setBuffer( double buffer ) { mBuffer = buffer; }

    void setMinWidth( double width ) { mMinWidth = width; }

    QgsMapLayer *layer() const { return mLayer; }
 
    void updatePosition() override;

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

    void updateRect();
 
  private slots:
    void updateTransformedGeometry();
 
  private:
    enum PointSymbol
    {
      Square,
      Circle
    };
 
    void init();
    void setSymbol( QgsSymbol *symbol, const QgsRenderContext &context, const QColor &color, const QColor &fillColor );
    double getSymbolWidth( const QgsRenderContext &context, double width, Qgis::RenderUnit unit );
    std::unique_ptr<QgsFeatureRenderer> createRenderer( QgsRenderContext &context, const QColor &color, const QColor &fillColor );
    void paintPoint( QgsRenderContext &context, const QgsPoint *point, double size, Qgis::RenderUnit sizeUnit, PointSymbol symbol );
    void paintLine( QPainter *p, QgsPolylineXY line );
    void paintPolygon( QPainter *p, const QgsPolygonXY &polygon );
    QgsRenderContext createRenderContext();
 
    int mWidth = 1;    // line / stroke width property
    QColor mColor;     // line / stroke color property
    QColor mFillColor; // line / stroke fillColor property
    QBrush mBrush;
    QPen mPen;
    QgsGeometry mOriginalGeometry;
    QgsGeometry mGeometry;
    QPointer<QgsMapLayer> mLayer;
    QgsFeature mFeature;
    double mBuffer = 0;   // line / stroke buffer in millimeters
    double mMinWidth = 0; // line / stroke minimum width in millimeters
    QgsRenderContext mRenderContext;
 
    // we don't want to make PointSymbol public for now, so just grant access selectively via a friend
    friend class QgsMapToolAddFeature;
    friend class QgsUpdateGpsDetailsAction;
    double mPointSizeRadiusMM = 1.5;
    PointSymbol mPointSymbol = PointSymbol::Square;
};
 
#endif