qgslayoutitemmapgrid.h

Go to the documentation of this file.

/***************************************************************************
                         qgslayoutitemmapgrid.h
                         ----------------------
    begin                : October 2017
    copyright            : (C) 2017 by Marco Hugentobler, Nyall Dawson
    email                : marco dot hugentobler at sourcepole dot ch
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 QGSLAYOUTITEMMAPGRID_H
#define QGSLAYOUTITEMMAPGRID_H

#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgslayoutitemmapitem.h"
#include "qgssymbol.h"
#include <QPainter>

class QgsCoordinateTransform;
class QgsLayoutItemMapGrid;
class QgsLayoutItemMap;
class QDomDocument;
class QDomElement;
class QPainter;
class QgsRenderContext;

class CORE_EXPORT QgsLayoutItemMapGridStack : public QgsLayoutItemMapItemStack
{
  public:

    QgsLayoutItemMapGridStack( QgsLayoutItemMap *map );

    void addGrid( QgsLayoutItemMapGrid *grid SIP_TRANSFER );

    void removeGrid( const QString &gridId );

    void moveGridUp( const QString &gridId );

    void moveGridDown( const QString &gridId );

    QgsLayoutItemMapGrid *grid( const QString &gridId ) const;

    QgsLayoutItemMapGrid *grid( int index ) const;

    QgsLayoutItemMapGrid &operator[]( int index );

    QList< QgsLayoutItemMapGrid * > asList() const;

    bool readXml( const QDomElement &elem, const QDomDocument &doc, const QgsReadWriteContext &context ) override;

    double maxGridExtension() const;

    void calculateMaxGridExtension( double &top, double &right, double &bottom, double &left ) const;
};

//
// QgsLayoutItemMapGrid
//

class CORE_EXPORT QgsLayoutItemMapGrid : public QgsLayoutItemMapItem
{

    Q_OBJECT

  public:

    enum GridUnit
    {
      MapUnit, 
      MM, 
      CM, 
      DynamicPageSizeBased, 
    };

    enum GridStyle
    {
      Solid = 0,
      Cross, 
      Markers, 
      FrameAnnotationsOnly 
    };

    enum DisplayMode
    {
      ShowAll = 0, 
      LatitudeOnly, 
      LongitudeOnly, 
      HideAll 
    };

    enum AnnotationPosition
    {
      InsideMapFrame = 0, 
      OutsideMapFrame, 
    };

    enum AnnotationDirection
    {
      Horizontal = 0, 
      Vertical, 
      VerticalDescending, 
      BoundaryDirection 
    };

    enum AnnotationFormat
    {
      Decimal = 0, 
      DegreeMinute, 
      DegreeMinuteSecond, 
      DecimalWithSuffix, 
      DegreeMinuteNoSuffix, 
      DegreeMinutePadded, 
      DegreeMinuteSecondNoSuffix, 
      DegreeMinuteSecondPadded, 
      CustomFormat 
    };

    enum BorderSide
    {
      Left, 
      Right, 
      Bottom, 
      Top 
    };

    enum FrameStyle
    {
      NoFrame = 0, 
      Zebra, 
      InteriorTicks,  
      ExteriorTicks,  
      InteriorExteriorTicks, 
      LineBorder, 
      LineBorderNautical, 
      ZebraNautical, 
    };

    enum FrameSideFlag
    {
      FrameLeft = 0x01, 
      FrameRight = 0x02, 
      FrameTop = 0x04, 
      FrameBottom = 0x08 
    };
    Q_DECLARE_FLAGS( FrameSideFlags, FrameSideFlag )

    
    enum AnnotationCoordinate
    {
      Longitude = 0, 
      Latitude 
    };

    QgsLayoutItemMapGrid( const QString &name, QgsLayoutItemMap *map );

    void draw( QPainter *painter ) override;
    bool writeXml( QDomElement &elem, QDomDocument &doc, const QgsReadWriteContext &context ) const override;
    bool readXml( const QDomElement &itemElem, const QDomDocument &doc, const QgsReadWriteContext &context ) override;

    void setCrs( const QgsCoordinateReferenceSystem &crs );

    QgsCoordinateReferenceSystem crs() const { return mCRS; }

    void setBlendMode( const QPainter::CompositionMode mode ) { mBlendMode = mode; }

    QPainter::CompositionMode blendMode() const { return mBlendMode; }

    bool usesAdvancedEffects() const override;

    double maxExtension() const;

    void calculateMaxExtension( double &top, double &right, double &bottom, double &left ) const;

    void setEnabled( bool enabled ) override;

    //
    // GRID UNITS
    //

    void setUnits( GridUnit unit );

    GridUnit units() const { return mGridUnit; }

    void setIntervalX( double interval );

    double intervalX() const { return mGridIntervalX; }

    void setIntervalY( double interval );

    double intervalY() const { return mGridIntervalY; }

    void setOffsetX( double offset );

    double offsetX() const { return mGridOffsetX; }

    void setOffsetY( double offset );

    double offsetY() const { return mGridOffsetY; }

    double minimumIntervalWidth() const { return mMinimumIntervalWidth; }

    void setMinimumIntervalWidth( double width );

    double maximumIntervalWidth() const { return mMaximumIntervalWidth; }

    void setMaximumIntervalWidth( double width );

    //
    // GRID APPEARANCE
    //

    void setStyle( GridStyle style );

    GridStyle style() const { return mGridStyle; }

    void setCrossLength( const double length );

    double crossLength() const { return mCrossLength; }

    void setGridLineWidth( double width );

    void setGridLineColor( const QColor &color );

    void setLineSymbol( QgsLineSymbol *symbol SIP_TRANSFER );

    const QgsLineSymbol *lineSymbol() const; SIP_SKIP

    QgsLineSymbol *lineSymbol();

    void setMarkerSymbol( QgsMarkerSymbol *symbol SIP_TRANSFER );

    const QgsMarkerSymbol *markerSymbol() const; SIP_SKIP

    QgsMarkerSymbol *markerSymbol();

    //
    // ANNOTATIONS
    //

    void setAnnotationEnabled( const bool enabled ) { mShowGridAnnotation = enabled; }

    bool annotationEnabled() const { return mShowGridAnnotation; }

    void setAnnotationFont( const QFont &font ) { mGridAnnotationFont = font; }

    QFont annotationFont() const { return mGridAnnotationFont; }

    void setAnnotationFontColor( const QColor &color ) { mGridAnnotationFontColor = color; }

    QColor annotationFontColor() const { return mGridAnnotationFontColor; }

    void setAnnotationPrecision( const int precision ) { mGridAnnotationPrecision = precision; }

    int annotationPrecision() const { return mGridAnnotationPrecision; }

    void setAnnotationDisplay( DisplayMode display, BorderSide border );

    DisplayMode annotationDisplay( BorderSide border ) const;

    void setAnnotationPosition( AnnotationPosition position, BorderSide side );

    AnnotationPosition annotationPosition( BorderSide side ) const;

    void setAnnotationFrameDistance( const double distance );

    double annotationFrameDistance() const { return mAnnotationFrameDistance; }

    void setAnnotationDirection( AnnotationDirection direction, BorderSide side );

    void setAnnotationDirection( AnnotationDirection direction );

    AnnotationDirection annotationDirection( BorderSide border ) const;

    void setAnnotationFormat( const AnnotationFormat format ) { mGridAnnotationFormat = format; }

    AnnotationFormat annotationFormat() const { return mGridAnnotationFormat; }

    void setAnnotationExpression( const QString &expression ) { mGridAnnotationExpressionString = expression; mGridAnnotationExpression.reset(); }

    QString annotationExpression() const { return mGridAnnotationExpressionString; }

    //
    // GRID FRAME
    //

    void setFrameStyle( const FrameStyle style ) { mGridFrameStyle = style; }

    FrameStyle frameStyle() const { return mGridFrameStyle; }

    void setFrameDivisions( DisplayMode divisions, BorderSide side );

    DisplayMode frameDivisions( BorderSide side ) const;

    void setFrameSideFlags( QgsLayoutItemMapGrid::FrameSideFlags flags );

    void setFrameSideFlag( QgsLayoutItemMapGrid::FrameSideFlag flag, bool on = true );

    QgsLayoutItemMapGrid::FrameSideFlags frameSideFlags() const;

    bool testFrameSideFlag( FrameSideFlag flag ) const;

    void setFrameWidth( const double width );

    double frameWidth() const { return mGridFrameWidth; }

    void setFrameMargin( const double margin );

    double frameMargin() const { return mGridFrameMargin; }

    void setFramePenSize( const double width );

    double framePenSize() const { return mGridFramePenThickness; }

    void setFramePenColor( const QColor &color ) { mGridFramePenColor = color; }

    QColor framePenColor() const {return mGridFramePenColor;}

    void setFrameFillColor1( const QColor &color ) { mGridFrameFillColor1 = color; }

    QColor frameFillColor1() const { return mGridFrameFillColor1; }

    void setFrameFillColor2( const QColor &color ) { mGridFrameFillColor2 = color; }

    QColor frameFillColor2() const { return mGridFrameFillColor2; }

    QgsExpressionContext createExpressionContext() const override;
    bool accept( QgsStyleEntityVisitorInterface *visitor ) const override;
    void refresh() override;

  private:

    QgsLayoutItemMapGrid() = delete;

    struct GridExtension
    {
      GridExtension() = default;
      double top = 0.0;
      double right = 0.0;
      double bottom = 0.0;
      double left = 0.0;
    };

    mutable bool mTransformDirty = true;

    GridStyle mGridStyle = QgsLayoutItemMapGrid::Solid;
    double mGridIntervalX = 0.0;
    double mGridIntervalY = 0.0;
    double mGridOffsetX = 0.0;
    double mGridOffsetY = 0.0;
    QFont mGridAnnotationFont;
    QColor mGridAnnotationFontColor  = Qt::black;
    int mGridAnnotationPrecision = 3;
    bool mShowGridAnnotation = false;

    DisplayMode mLeftGridAnnotationDisplay = QgsLayoutItemMapGrid::ShowAll;
    DisplayMode mRightGridAnnotationDisplay = QgsLayoutItemMapGrid::ShowAll;
    DisplayMode mTopGridAnnotationDisplay = QgsLayoutItemMapGrid::ShowAll;
    DisplayMode mBottomGridAnnotationDisplay = QgsLayoutItemMapGrid::ShowAll;

    AnnotationPosition mLeftGridAnnotationPosition = QgsLayoutItemMapGrid::OutsideMapFrame;
    AnnotationPosition mRightGridAnnotationPosition = QgsLayoutItemMapGrid::OutsideMapFrame;
    AnnotationPosition mTopGridAnnotationPosition = QgsLayoutItemMapGrid::OutsideMapFrame;
    AnnotationPosition mBottomGridAnnotationPosition = QgsLayoutItemMapGrid::OutsideMapFrame;

    double mAnnotationFrameDistance = 1.0;

    AnnotationDirection mLeftGridAnnotationDirection = QgsLayoutItemMapGrid::Horizontal;
    AnnotationDirection mRightGridAnnotationDirection = QgsLayoutItemMapGrid::Horizontal;
    AnnotationDirection mTopGridAnnotationDirection = QgsLayoutItemMapGrid::Horizontal;
    AnnotationDirection mBottomGridAnnotationDirection = QgsLayoutItemMapGrid::Horizontal;
    AnnotationFormat mGridAnnotationFormat = QgsLayoutItemMapGrid::Decimal;

    QString mGridAnnotationExpressionString;
    mutable std::unique_ptr< QgsExpression > mGridAnnotationExpression;

    FrameStyle mGridFrameStyle = QgsLayoutItemMapGrid::NoFrame;
    FrameSideFlags mGridFrameSides;
    double mGridFrameWidth = 2.0;
    double mGridFramePenThickness = 0.3;
    QColor mGridFramePenColor = QColor( 0, 0, 0 );
    QColor mGridFrameFillColor1 = Qt::white;
    QColor mGridFrameFillColor2 = Qt::black;
    double mCrossLength = 3.0;
    double mGridFrameMargin = 0.0;

    double mMinimumIntervalWidth = 50;
    double mMaximumIntervalWidth = 100;

    DisplayMode mLeftFrameDivisions = QgsLayoutItemMapGrid::ShowAll;
    DisplayMode mRightFrameDivisions = QgsLayoutItemMapGrid::ShowAll;
    DisplayMode mTopFrameDivisions = QgsLayoutItemMapGrid::ShowAll;
    DisplayMode mBottomFrameDivisions = QgsLayoutItemMapGrid::ShowAll;

    std::unique_ptr< QgsLineSymbol > mGridLineSymbol;
    std::unique_ptr< QgsMarkerSymbol > mGridMarkerSymbol;

    QgsCoordinateReferenceSystem mCRS;

    GridUnit mGridUnit = MapUnit;

    QPainter::CompositionMode mBlendMode = QPainter::CompositionMode_SourceOver;

    mutable QList< QPair< double, QPolygonF > > mTransformedXLines;
    mutable QList< QPair< double, QPolygonF > > mTransformedYLines;
    mutable QList< QgsPointXY > mTransformedIntersections;
    QRectF mPrevPaintRect;
    mutable QPolygonF mPrevMapPolygon;

    bool mEvaluatedEnabled = true;
    double mEvaluatedIntervalX = 0;
    double mEvaluatedIntervalY = 0;
    double mEvaluatedOffsetX = 0;
    double mEvaluatedOffsetY = 0;
    double mEvaluatedGridFrameWidth = 0;
    double mEvaluatedGridFrameMargin = 0;
    double mEvaluatedAnnotationFrameDistance = 0;
    double mEvaluatedCrossLength = 0;
    double mEvaluatedGridFrameLineThickness = 0;

    class QgsMapAnnotation
    {
      public:
        double coordinate;
        QPointF itemPosition;
        QgsLayoutItemMapGrid::AnnotationCoordinate coordinateType;
    };

    void drawGridFrame( QPainter *p, const QList< QPair< double, QLineF > > &hLines, const QList< QPair< double, QLineF > > &vLines, GridExtension *extension = nullptr ) const;

    void drawCoordinateAnnotations( QPainter *p, const QList< QPair< double, QLineF > > &hLines, const QList< QPair< double, QLineF > > &vLines, QgsExpressionContext &expressionContext, GridExtension *extension = nullptr ) const;

    void drawCoordinateAnnotation( QPainter *p, QPointF pos, const QString &annotationString, AnnotationCoordinate coordinateType, GridExtension *extension = nullptr ) const;

    void drawAnnotation( QPainter *p, QPointF pos, int rotation, const QString &annotationText ) const;

    QString gridAnnotationString( double value, AnnotationCoordinate coord, QgsExpressionContext &expressionContext ) const;

    int xGridLines( QList< QPair< double, QLineF > > &lines ) const;

    int yGridLines( QList< QPair< double, QLineF > > &lines ) const;

    int xGridLinesCrsTransform( const QgsRectangle &bbox, const QgsCoordinateTransform &t, QList< QPair< double, QPolygonF > > &lines ) const;

    int yGridLinesCrsTransform( const QgsRectangle &bbox, const QgsCoordinateTransform &t, QList< QPair< double, QPolygonF > > &lines ) const;

    void drawGridLine( const QLineF &line, QgsRenderContext &context ) const;

    void drawGridLine( const QPolygonF &line, QgsRenderContext &context ) const;

    void sortGridLinesOnBorders( const QList< QPair< double, QLineF > > &hLines, const QList< QPair< double, QLineF > > &vLines, QMap< double, double > &leftFrameEntries,
                                 QMap< double, double > &rightFrameEntries, QMap< double, double > &topFrameEntries, QMap< double, double > &bottomFrameEntries ) const;

    void drawGridFrameBorder( QPainter *p, const QMap< double, double > &borderPos, BorderSide border, double *extension = nullptr ) const;

    BorderSide borderForLineCoord( QPointF p, AnnotationCoordinate coordinateType ) const;

    int crsGridParams( QgsRectangle &crsRect, QgsCoordinateTransform &inverseTransform ) const;

    static QList<QPolygonF> trimLinesToMap( const QPolygonF &line, const QgsRectangle &rect );

    QPolygonF scalePolygon( const QPolygonF &polygon, double scale ) const;

    void drawGridCrsTransform( QgsRenderContext &context, double dotsPerMM, QList< QPair< double, QLineF > > &horizontalLines,
                               QList< QPair< double, QLineF > > &verticalLines, bool calculateLinesOnly = false ) const;

    void drawGridNoTransform( QgsRenderContext &context, double dotsPerMM, QList<QPair<double, QLineF> > &horizontalLines, QList<QPair<double, QLineF> > &verticalLines, bool calculateLinesOnly = false ) const;

    void createDefaultGridLineSymbol();

    void createDefaultGridMarkerSymbol();

    void drawGridMarker( QPointF point, QgsRenderContext &context ) const;

    void drawGridFrameZebraBorder( QPainter *p, const QMap<double, double> &borderPos, BorderSide border, double *extension = nullptr ) const;

    void drawGridFrameTicks( QPainter *p, const QMap<double, double> &borderPos, BorderSide border, double *extension = nullptr ) const;

    void drawGridFrameLineBorder( QPainter *p, BorderSide border, double *extension = nullptr ) const;

    void calculateCrsTransformLines() const;

    bool shouldShowDivisionForSide( AnnotationCoordinate coordinate, BorderSide side ) const;
    bool shouldShowDivisionForDisplayMode( AnnotationCoordinate coordinate, DisplayMode mode ) const;
    void refreshDataDefinedProperties();

    double mapWidth() const;

    friend class TestQgsLayoutMapGrid;

};

Q_DECLARE_OPERATORS_FOR_FLAGS( QgsLayoutItemMapGrid::FrameSideFlags )

#endif // QGSLAYOUTITEMMAPGRID_H