qgspointdistancerenderer.h

Go to the documentation of this file.

/***************************************************************************
                              qgspointdistancerenderer.cpp
                              ----------------------------
  begin                : January 26, 2010
  copyright            : (C) 2010 by Marco Hugentobler
  email                : marco at hugis 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 QGSPOINTDISTANCERENDERER_H
#define QGSPOINTDISTANCERENDERER_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgsmapunitscale.h"
#include "qgsrenderer.h"
 
#include <QFont>
 
class QgsSpatialIndex;
class QgsMarkerSymbol;
class QgsSymbolRenderContext;

 
class CORE_EXPORT QgsPointDistanceRenderer: public QgsFeatureRenderer
{
  public:

    struct CORE_EXPORT GroupedFeature
    {

        GroupedFeature( const QgsFeature &feature, QgsMarkerSymbol *symbol SIP_TRANSFER, bool isSelected, const QString &label = QString() );
        ~GroupedFeature();

        QgsFeature feature;

        QgsMarkerSymbol *symbol() const { return mSymbol.get(); }

        bool isSelected;

        QString label;
 
      private:
        std::shared_ptr< QgsMarkerSymbol > mSymbol;
    };

    typedef QList< QgsPointDistanceRenderer::GroupedFeature > ClusteredGroup;

    QgsPointDistanceRenderer( const QString &rendererName, const QString &labelAttributeName = QString() );
 
    Q_DECL_DEPRECATED void toSld( QDomDocument &doc, QDomElement &element, const QVariantMap &props = QVariantMap() ) const override SIP_DEPRECATED;
    bool toSld( QDomDocument &doc, QDomElement &element, QgsSldExportContext &context ) const override;
    bool renderFeature( const QgsFeature &feature, QgsRenderContext &context, int layer = -1, bool selected = false, bool drawVertexMarker = false ) override SIP_THROW( QgsCsException );
    QSet<QString> usedAttributes( const QgsRenderContext &context ) const override;
    bool filterNeedsGeometry() const override;
    QgsFeatureRenderer::Capabilities capabilities() override;
    QgsSymbolList symbols( QgsRenderContext &context ) const override;
    QgsSymbol *symbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
    QgsSymbol *originalSymbolForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
    QgsSymbolList symbolsForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
    QgsSymbolList originalSymbolsForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
    QSet< QString > legendKeysForFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
    QString legendKeyToExpression( const QString &key, QgsVectorLayer *layer, bool &ok ) const override;
    bool willRenderFeature( const QgsFeature &feature, QgsRenderContext &context ) const override;
    void startRender( QgsRenderContext &context, const QgsFields &fields ) override;
    void stopRender( QgsRenderContext &context ) override;
    QgsLegendSymbolList legendSymbolItems() const override;
    void setEmbeddedRenderer( QgsFeatureRenderer *r SIP_TRANSFER ) override;
    const QgsFeatureRenderer *embeddedRenderer() const override;
    void setLegendSymbolItem( const QString &key, QgsSymbol *symbol SIP_TRANSFER ) override;
    bool legendSymbolItemsCheckable() const override;
    bool legendSymbolItemChecked( const QString &key ) override;
    void checkLegendSymbolItem( const QString &key, bool state ) override;
    QString filter( const QgsFields &fields = QgsFields() ) override;
    bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;

    void setLabelAttributeName( const QString &name ) { mLabelAttributeName = name; }

    QString labelAttributeName() const { return mLabelAttributeName; }

    void setLabelFont( const QFont &font ) { mLabelFont = font; }

    QFont labelFont() const { return mLabelFont;}

    void setMinimumLabelScale( double scale ) { mMinLabelScale = scale; }

    double minimumLabelScale() const { return mMinLabelScale; }

    void setLabelColor( const QColor &color ) { mLabelColor = color;}

    QColor labelColor() const { return mLabelColor; }

    void setTolerance( double distance ) { mTolerance = distance; }

    double tolerance() const { return mTolerance; }

    void setToleranceUnit( Qgis::RenderUnit unit ) { mToleranceUnit = unit; }

    Qgis::RenderUnit toleranceUnit() const { return mToleranceUnit; }

    void setToleranceMapUnitScale( const QgsMapUnitScale &scale ) { mToleranceMapUnitScale = scale; }

    const QgsMapUnitScale &toleranceMapUnitScale() const { return mToleranceMapUnitScale; }
 
  protected:

    std::unique_ptr< QgsFeatureRenderer > mRenderer;

    QString mLabelAttributeName;

    int mLabelIndex = -1;

    double mTolerance = 3;
    Qgis::RenderUnit mToleranceUnit = Qgis::RenderUnit::Millimeters;
    QgsMapUnitScale mToleranceMapUnitScale;

    QFont mLabelFont;
    QColor mLabelColor;
    bool mDrawLabels = true;
    double mMinLabelScale = 0;

    QList<ClusteredGroup> mClusteredGroups;

    QMap<QgsFeatureId, int> mGroupIndex;

    QMap<QgsFeatureId, QgsPointXY > mGroupLocations;

    QgsSpatialIndex *mSpatialIndex = nullptr;

    void drawLabels( QPointF centerPoint, QgsSymbolRenderContext &context, const QList<QPointF> &labelShifts, const ClusteredGroup &group ) const;
 
  private:

    virtual void drawGroup( QPointF centerPoint, QgsRenderContext &context, const ClusteredGroup &group ) const = 0 SIP_FORCE;

    QgsRectangle searchRect( const QgsPoint *p, double distance ) const;

    void printGroupInfo() const;

    QString getLabel( const QgsFeature &feature ) const;

    void drawGroup( const ClusteredGroup &group, QgsRenderContext &context ) const;

    QgsMarkerSymbol *firstSymbolForFeature( const QgsFeature &feature, QgsRenderContext &context );

    QgsExpressionContextScope *createGroupScope( const ClusteredGroup &group ) const;
 
};
 
#endif // QGSPOINTDISTANCERENDERER_H