Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                               qgspointclusterrenderer.h
       3                 :            :                               -------------------------
       4                 :            :   begin                : February 2016
       5                 :            :   copyright            : (C) 2016 by Nyall Dawson
       6                 :            :   email                : nyall dot dawson at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSPOINTCLUSTERRENDERER_H
      19                 :            : #define QGSPOINTCLUSTERRENDERER_H
      20                 :            : 
      21                 :            : #include "qgis_core.h"
      22                 :            : #include "qgis.h"
      23                 :            : #include "qgspointdistancerenderer.h"
      24                 :            : 
      25                 :            : /**
      26                 :            :  * \class QgsPointClusterRenderer
      27                 :            :  * \ingroup core
      28                 :            :  * \brief A renderer that automatically clusters points with the same geographic position.
      29                 :            :  * \since QGIS 3.0
      30                 :            : */
      31                 :          0 : class CORE_EXPORT QgsPointClusterRenderer: public QgsPointDistanceRenderer
      32                 :            : {
      33                 :            :   public:
      34                 :            : 
      35                 :            :     QgsPointClusterRenderer();
      36                 :            : 
      37                 :            :     QgsPointClusterRenderer *clone() const override SIP_FACTORY;
      38                 :            :     void startRender( QgsRenderContext &context, const QgsFields &fields ) override;
      39                 :            :     void stopRender( QgsRenderContext &context ) override;
      40                 :            :     QDomElement save( QDomDocument &doc, const QgsReadWriteContext &context ) override;
      41                 :            :     QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;
      42                 :            :     bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;
      43                 :            : 
      44                 :            :     //! Creates a renderer from XML element
      45                 :            :     static QgsFeatureRenderer *create( QDomElement &symbologyElem, const QgsReadWriteContext &context ) SIP_FACTORY;
      46                 :            : 
      47                 :            :     /**
      48                 :            :      * Returns the symbol used for rendering clustered groups (but not ownership of the symbol).
      49                 :            :      * \see setClusterSymbol()
      50                 :            :     */
      51                 :            :     QgsMarkerSymbol *clusterSymbol();
      52                 :            : 
      53                 :            :     /**
      54                 :            :      * Sets the symbol for rendering clustered groups.
      55                 :            :      * \param symbol new cluster symbol. Ownership is transferred to the renderer.
      56                 :            :      * \see clusterSymbol()
      57                 :            :     */
      58                 :            :     void setClusterSymbol( QgsMarkerSymbol *symbol SIP_TRANSFER );
      59                 :            : 
      60                 :            :     /**
      61                 :            :      * Creates a QgsPointClusterRenderer from an existing renderer.
      62                 :            :      * \returns a new renderer if the conversion was possible, otherwise NULLPTR.
      63                 :            :      */
      64                 :            :     static QgsPointClusterRenderer *convertFromRenderer( const QgsFeatureRenderer *renderer ) SIP_FACTORY;
      65                 :            : 
      66                 :            :   private:
      67                 :            : #ifdef SIP_RUN
      68                 :            :     QgsPointClusterRenderer( const QgsPointClusterRenderer & );
      69                 :            :     QgsPointClusterRenderer &operator=( const QgsPointClusterRenderer & );
      70                 :            : #endif
      71                 :            : 
      72                 :            :     //! Symbol for point clusters
      73                 :            :     std::unique_ptr< QgsMarkerSymbol > mClusterSymbol;
      74                 :            : 
      75                 :            :     void drawGroup( QPointF centerPoint, QgsRenderContext &context, const QgsPointDistanceRenderer::ClusteredGroup &group ) override SIP_FORCE;
      76                 :            : 
      77                 :            : };
      78                 :            : 
      79                 :            : #endif // QGSPOINTCLUSTERRENDERER_H