qgscomposermap.h

Go to the documentation of this file.

/***************************************************************************
                         qgscomposermap.h
                             -------------------
    begin                : January 2005
    copyright            : (C) 2005 by Radim Blazek
    email                : [email protected]
 ***************************************************************************/

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

//#include "ui_qgscomposermapbase.h"
#include "qgscomposeritem.h"
#include "qgsrectangle.h"
#include <QFont>
#include <QGraphicsRectItem>

class QgsComposition;
class QgsComposerMapOverviewStack;
class QgsComposerMapOverview;
class QgsComposerMapGridStack;
class QgsComposerMapGrid;
class QgsMapRenderer;
class QgsMapToPixel;
class QDomNode;
class QDomDocument;
class QGraphicsView;
class QPainter;
class QgsFillSymbolV2;
class QgsLineSymbolV2;
class QgsVectorLayer;
class QgsAnnotation;

Q_NOWARN_DEPRECATED_PUSH
class CORE_EXPORT QgsComposerMap : public QgsComposerItem
{
    Q_OBJECT

  public:
    QgsComposerMap( QgsComposition *composition, int x, int y, int width, int height );
    QgsComposerMap( QgsComposition *composition );
    virtual ~QgsComposerMap();

    virtual int type() const override { return ComposerMap; }

    enum PreviewMode
    {
      Cache = 0,   // Use raster cache
      Render,      // Render the map
      Rectangle    // Display only rectangle
    };

    //grid enums are moved to QgsComposerMapGrid
    //TODO - remove for QGIS 3.0
    enum GridStyle
    {
      Solid = 0, //solid lines
      Cross, //only draw line crossings
      Markers,
      FrameAnnotationsOnly
    };

    enum GridAnnotationPosition
    {
      InsideMapFrame = 0,
      OutsideMapFrame,
      Disabled
    };

    enum GridAnnotationDirection
    {
      Horizontal = 0,
      Vertical,
      HorizontalAndVertical,
      BoundaryDirection
    };

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

    enum GridFrameStyle
    {
      NoGridFrame = 0,
      Zebra, // black/white pattern
      InteriorTicks,
      ExteriorTicks,
      InteriorExteriorTicks,
      LineBorder
    };

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

    enum AtlasScalingMode
    {
      Fixed,      
      Predefined, 
      Auto        
    };

    void draw( QPainter *painter, const QgsRectangle& extent, QSizeF size, double dpi, double* forceWidthScale = nullptr );

    void paint( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle, QWidget* pWidget ) override;

    void cache();

    QgsMapSettings mapSettings( const QgsRectangle& extent, QSizeF size, int dpi ) const;

    int id() const {return mId;}

    bool isDrawing() const {return mDrawing;}

    void resize( double dx, double dy );

    void moveContent( double dx, double dy ) override;

    Q_DECL_DEPRECATED void zoomContent( int delta, double x, double y ) override;

    virtual void zoomContent( const double factor, const QPointF point, const ZoomMode mode = QgsComposerItem::Zoom ) override;

    void setSceneRect( const QRectF& rectangle ) override;

    double scale() const;

    void setNewScale( double scaleDenominator, bool forceUpdate = true );

    void setNewExtent( const QgsRectangle& extent );

    void zoomToExtent( const QgsRectangle& extent );

    void setNewAtlasFeatureExtent( const QgsRectangle& extent );

    Q_DECL_DEPRECATED void toggleAtlasPreview() {}

    const QgsRectangle* currentMapExtent() const;

    QgsRectangle* currentMapExtent();

    PreviewMode previewMode() const {return mPreviewMode;}
    void setPreviewMode( PreviewMode m );

    bool keepLayerSet() const {return mKeepLayerSet;}
    void setKeepLayerSet( bool enabled ) {mKeepLayerSet = enabled;}

    QStringList layerSet() const {return mLayerSet;}
    void setLayerSet( const QStringList& layerSet ) {mLayerSet = layerSet;}
    void storeCurrentLayerSet();

    bool keepLayerStyles() const { return mKeepLayerStyles; }
    void setKeepLayerStyles( bool enabled ) { mKeepLayerStyles = enabled; }

    QMap<QString, QString> layerStyleOverrides() const { return mLayerStyleOverrides; }
    void setLayerStyleOverrides( const QMap<QString, QString>& overrides );
    void storeCurrentLayerStyles();

    bool followVisibilityPreset() const { return mFollowVisibilityPreset; }
    void setFollowVisibilityPreset( bool follow ) { mFollowVisibilityPreset = follow; }
    QString followVisibilityPresetName() const { return mFollowVisibilityPresetName; }
    void setFollowVisibilityPresetName( const QString& name ) { mFollowVisibilityPresetName = name; }

    // Set cache outdated
    void setCacheUpdated( bool u = false );

    QgsRectangle extent() const {return mExtent;}

    Q_DECL_DEPRECATED const QgsMapRenderer* mapRenderer() const;

    void setOffset( double xOffset, double yOffset );

    bool containsWMSLayer() const;

    bool containsAdvancedEffects() const;

    bool writeXML( QDomElement& elem, QDomDocument & doc ) const override;

    bool readXML( const QDomElement& itemElem, const QDomDocument& doc ) override;

    Q_DECL_DEPRECATED void setGridEnabled( bool enabled );

    Q_DECL_DEPRECATED bool gridEnabled() const;

    Q_DECL_DEPRECATED void setGridStyle( GridStyle style );

    Q_DECL_DEPRECATED GridStyle gridStyle() const;

    Q_DECL_DEPRECATED void setGridIntervalX( double interval );

    Q_DECL_DEPRECATED double gridIntervalX() const;

    Q_DECL_DEPRECATED void setGridIntervalY( double interval );

    Q_DECL_DEPRECATED double gridIntervalY() const;

    Q_DECL_DEPRECATED void setGridOffsetX( double offset );

    Q_DECL_DEPRECATED double gridOffsetX() const;

    Q_DECL_DEPRECATED void setGridOffsetY( double offset );

    Q_DECL_DEPRECATED double gridOffsetY() const;

    Q_DECL_DEPRECATED void setGridPen( const QPen& p );

    Q_DECL_DEPRECATED QPen gridPen() const;

    Q_DECL_DEPRECATED void setGridPenWidth( double w );

    Q_DECL_DEPRECATED void setGridPenColor( const QColor& c );

    Q_DECL_DEPRECATED void setGridAnnotationFont( const QFont& f );

    Q_DECL_DEPRECATED QFont gridAnnotationFont() const;

    Q_DECL_DEPRECATED void setAnnotationFontColor( const QColor& c );

    Q_DECL_DEPRECATED QColor annotationFontColor() const;

    Q_DECL_DEPRECATED void setGridAnnotationPrecision( int p );

    Q_DECL_DEPRECATED int gridAnnotationPrecision() const;

    Q_DECL_DEPRECATED void setShowGridAnnotation( bool show );

    Q_DECL_DEPRECATED bool showGridAnnotation() const;

    Q_DECL_DEPRECATED void setGridAnnotationPosition( GridAnnotationPosition p, QgsComposerMap::Border border );

    Q_DECL_DEPRECATED GridAnnotationPosition gridAnnotationPosition( QgsComposerMap::Border border ) const;

    Q_DECL_DEPRECATED void setAnnotationFrameDistance( double d );

    Q_DECL_DEPRECATED double annotationFrameDistance() const;

    Q_DECL_DEPRECATED void setGridAnnotationDirection( GridAnnotationDirection d, QgsComposerMap::Border border );

    Q_DECL_DEPRECATED GridAnnotationDirection gridAnnotationDirection( QgsComposerMap::Border border ) const;

    Q_DECL_DEPRECATED void setGridAnnotationFormat( GridAnnotationFormat f );

    Q_DECL_DEPRECATED GridAnnotationFormat gridAnnotationFormat() const;

    Q_DECL_DEPRECATED void setGridFrameStyle( GridFrameStyle style );

    Q_DECL_DEPRECATED GridFrameStyle gridFrameStyle() const;

    Q_DECL_DEPRECATED void setGridFrameWidth( double w );

    Q_DECL_DEPRECATED double gridFrameWidth() const;

    Q_DECL_DEPRECATED void setGridFramePenSize( double w );

    Q_DECL_DEPRECATED double gridFramePenSize() const;

    Q_DECL_DEPRECATED void setGridFramePenColor( const QColor& c );

    Q_DECL_DEPRECATED QColor gridFramePenColor() const;

    Q_DECL_DEPRECATED void setGridFrameFillColor1( const QColor& c );

    Q_DECL_DEPRECATED QColor gridFrameFillColor1() const;

    Q_DECL_DEPRECATED void setGridFrameFillColor2( const QColor& c );

    Q_DECL_DEPRECATED QColor gridFrameFillColor2() const;

    Q_DECL_DEPRECATED void setCrossLength( double l );

    Q_DECL_DEPRECATED double crossLength();

    Q_DECL_DEPRECATED void setGridLineSymbol( QgsLineSymbolV2* symbol );

    Q_DECL_DEPRECATED QgsLineSymbolV2* gridLineSymbol();

    Q_DECL_DEPRECATED QPainter::CompositionMode gridBlendMode() const;

    Q_DECL_DEPRECATED void setGridBlendMode( QPainter::CompositionMode blendMode );

    QgsComposerMapGridStack* grids() { return mGridStack; }

    QgsComposerMapGrid* grid();

    QgsComposerMapOverviewStack* overviews() { return mOverviewStack; }

    QgsComposerMapOverview* overview();

    QRectF boundingRect() const override;

    /* reimplement setFrameOutlineWidth, so that updateBoundingRect() is called after setting the frame width */
    virtual void setFrameOutlineWidth( const double outlineWidth ) override;

    Q_DECL_DEPRECATED void setRotation( double r ) override;

    Q_DECL_DEPRECATED double rotation() const { return mMapRotation;}

    void setMapRotation( double r );

    double mapRotation( QgsComposerObject::PropertyValueType valueType = QgsComposerObject::EvaluatedValue ) const;

    void updateItem() override;

    void setMapCanvas( QGraphicsView* canvas ) { mMapCanvas = canvas; }

    void setDrawCanvasItems( bool b ) { mDrawCanvasItems = b; }
    bool drawCanvasItems() const { return mDrawCanvasItems; }

    void setDrawSelection( bool b ) { mDrawSelection = b; }
    bool drawSelection() const { return mDrawSelection; }

    double mapUnitsToMM() const;

    Q_DECL_DEPRECATED void setOverviewFrameMap( int mapId );

    Q_DECL_DEPRECATED int overviewFrameMapId() const;

    Q_DECL_DEPRECATED void setOverviewFrameMapSymbol( QgsFillSymbolV2* symbol );

    Q_DECL_DEPRECATED QgsFillSymbolV2* overviewFrameMapSymbol();

    Q_DECL_DEPRECATED QPainter::CompositionMode overviewBlendMode() const;

    Q_DECL_DEPRECATED void setOverviewBlendMode( QPainter::CompositionMode blendMode );

    Q_DECL_DEPRECATED bool overviewInverted() const;

    Q_DECL_DEPRECATED void setOverviewInverted( bool inverted );

    Q_DECL_DEPRECATED bool overviewCentered() const;

    Q_DECL_DEPRECATED void setOverviewCentered( bool centered );

    void assignFreeId();

    Q_DECL_DEPRECATED bool imageSizeConsideringRotation( double& width, double& height ) const;
    Q_DECL_DEPRECATED bool cornerPointOnRotatedAndScaledRect( double& x, double& y, double width, double height ) const;
    Q_DECL_DEPRECATED void sizeChangedByRotation( double& width, double& height );

    bool atlasDriven() const { return mAtlasDriven; }

    void setAtlasDriven( bool enabled );

    Q_DECL_DEPRECATED bool atlasFixedScale() const;

    Q_DECL_DEPRECATED void setAtlasFixedScale( bool fixed );

    AtlasScalingMode atlasScalingMode() const { return mAtlasScalingMode; }

    void setAtlasScalingMode( AtlasScalingMode mode ) { mAtlasScalingMode = mode; }

    double atlasMargin( const QgsComposerObject::PropertyValueType valueType = QgsComposerObject::EvaluatedValue );

    void setAtlasMargin( double margin ) { mAtlasMargin = margin; }

    void setUpdatesEnabled( bool enabled ) { mUpdatesEnabled = enabled; }

    bool updatesEnabled() const { return mUpdatesEnabled; }

    int numberExportLayers() const override;

    QPolygonF visibleExtentPolygon() const;

    //overridden to show "Map 1" type names
    virtual QString displayName() const override;

    QPolygonF transformedMapPolygon() const;

    QPointF mapToItemCoords( QPointF mapCoords ) const;

    Q_DECL_DEPRECATED void connectMapOverviewSignals();

    void requestedExtent( QgsRectangle& extent ) const;

    virtual QgsExpressionContext* createExpressionContext() const override;

  signals:
    void extentChanged();

    void mapRotationChanged( double newRotation );

    void preparedForAtlas();

    void layerStyleOverridesChanged();

  public slots:

    void updateCachedImage();

    void renderModeUpdateCachedImage();

    void updateBoundingRect();

    void overviewExtentChanged() {}

    virtual void refreshDataDefinedProperty( const QgsComposerObject::DataDefinedProperty property = QgsComposerObject::AllProperties, const QgsExpressionContext* context = nullptr ) override;

  protected slots:

    void layersChanged();

  private:

    int mId;

    QgsComposerMapGridStack* mGridStack;

    QgsComposerMapOverviewStack* mOverviewStack;

    // Map region in map units realy used for rendering
    // It can be the same as mUserExtent, but it can be bigger in on dimension if mCalculate==Scale,
    // so that full rectangle in paper is used.
    QgsRectangle mExtent;

    // Current temporary map region in map units. This is overwritten when atlas feature changes. It's also
    // used when the user changes the map extent and an atlas preview is enabled. This allows the user
    // to manually tweak each atlas preview page without affecting the actual original map extent.
    QgsRectangle mAtlasFeatureExtent;

    // Cache used in composer preview
    QImage mCacheImage;

    // Is cache up to date
    bool mCacheUpdated;

    PreviewMode mPreviewMode;

    int mNumCachedLayers;

    bool mDrawing;

    double mXOffset;
    double mYOffset;

    double mMapRotation;
    double mEvaluatedMapRotation;

    bool mKeepLayerSet;

    QStringList mLayerSet;

    bool mKeepLayerStyles;
    QMap<QString, QString> mLayerStyleOverrides;

    bool mFollowVisibilityPreset;
    QString mFollowVisibilityPresetName;

    bool mUpdatesEnabled;

    void connectUpdateSlot();

    void syncLayerSet();

    const QgsComposerMapGrid* constFirstMapGrid() const;

    const QgsComposerMapOverview* constFirstMapOverview() const;

    QRectF mCurrentRectangle;
    QGraphicsView* mMapCanvas;
    bool mDrawCanvasItems;

    bool mDrawSelection;

    void adjustExtentToItemShape( double itemWidth, double itemHeight, QgsRectangle& extent ) const;

    bool mAtlasDriven;
    AtlasScalingMode mAtlasScalingMode;
    double mAtlasMargin;

    void init();

    void updateToolTip();

    QStringList layersToRender( const QgsExpressionContext* context = nullptr ) const;

    QMap<QString, QString> layerStyleOverridesToRender( const QgsExpressionContext& context ) const;

    QgsRectangle transformedExtent() const;

    void mapPolygon( const QgsRectangle& extent, QPolygonF& poly ) const;

    void transformShift( double& xShift, double& yShift ) const;

    void drawCanvasItems( QPainter* painter, const QStyleOptionGraphicsItem* itemStyle );
    void drawCanvasItem( const QgsAnnotation* item, QPainter* painter, const QStyleOptionGraphicsItem* itemStyle );
    QPointF composerMapPosForItem( const QgsAnnotation* item ) const;

    enum PartType
    {
      Background,
      Layer,
      Grid,
      OverviewMapExtent,
      Frame,
      SelectionBoxes
    };

    bool shouldDrawPart( PartType part ) const;

    void refreshMapExtents( const QgsExpressionContext* context = nullptr );

    friend class QgsComposerMapOverview; //to access mXOffset, mYOffset
    friend class TestQgsComposerMap;
};
Q_NOWARN_DEPRECATED_POP

#endif