qgsmapsettings.h

Go to the documentation of this file.

/***************************************************************************
  qgsmapsettings.h
  --------------------------------------
  Date                 : December 2013
  Copyright            : (C) 2013 by Martin Dobias
  Email                : wonder dot sk at gmail dot com
 ***************************************************************************
 *                                                                         *
 *   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 QGSMAPSETTINGS_H
#define QGSMAPSETTINGS_H

#include "qgis_core.h"
#include "qgis_sip.h"
#include <QColor>
#include <QImage>
#include <QPointer>
#include <QSize>
#include <QStringList>

#include "qgscoordinatereferencesystem.h"
#include "qgslabelingenginesettings.h"
#include "qgsmaptopixel.h"
#include "qgsrectangle.h"
#include "qgsscalecalculator.h"
#include "qgsexpressioncontext.h"
#include "qgsmaplayer.h"
#include "qgsgeometry.h"

class QPainter;

class QgsCoordinateTransform;
class QgsScaleCalculator;
class QgsMapRendererJob;
class QgsRenderedFeatureHandlerInterface;

class CORE_EXPORT QgsLabelBlockingRegion
{
  public:

    explicit QgsLabelBlockingRegion( const QgsGeometry &geometry )
      : geometry( geometry )
    {}

    QgsGeometry geometry;

};


class CORE_EXPORT QgsMapSettings
{
  public:
    QgsMapSettings();

    QgsRectangle extent() const;

    void setExtent( const QgsRectangle &rect, bool magnified = true );

    double extentBuffer() const;

    void setExtentBuffer( double buffer );

    QSize outputSize() const;
    void setOutputSize( QSize size );

    float devicePixelRatio() const;

    void setDevicePixelRatio( float dpr );

    QSize deviceOutputSize() const;

    double rotation() const;

    void setRotation( double rotation );

    double outputDpi() const;
    void setOutputDpi( double dpi );

    void setMagnificationFactor( double factor );

    double magnificationFactor() const;

    QStringList layerIds() const;

    QList<QgsMapLayer *> layers() const;

    void setLayers( const QList<QgsMapLayer *> &layers );

    QMap<QString, QString> layerStyleOverrides() const;

    void setLayerStyleOverrides( const QMap<QString, QString> &overrides );

    QString customRenderFlags() const { return mCustomRenderFlags; }

    void setCustomRenderFlags( const QString &customRenderFlags ) { mCustomRenderFlags = customRenderFlags; }

    void setDestinationCrs( const QgsCoordinateReferenceSystem &crs );
    QgsCoordinateReferenceSystem destinationCrs() const;

    QgsUnitTypes::DistanceUnit mapUnits() const;

    bool setEllipsoid( const QString &ellipsoid );

    QString ellipsoid() const { return mEllipsoid; }

    void setBackgroundColor( const QColor &color ) { mBackgroundColor = color; }
    QColor backgroundColor() const { return mBackgroundColor; }

    void setSelectionColor( const QColor &color ) { mSelectionColor = color; }
    QColor selectionColor() const { return mSelectionColor; }

    enum Flag
    {
      Antialiasing             = 0x01,  
      DrawEditingInfo          = 0x02,  
      ForceVectorOutput        = 0x04,  
      UseAdvancedEffects       = 0x08,  
      DrawLabeling             = 0x10,  
      UseRenderingOptimization = 0x20,  
      DrawSelection            = 0x40,  
      DrawSymbolBounds         = 0x80,  
      RenderMapTile            = 0x100, 
      RenderPartialOutput      = 0x200, 
      RenderPreviewJob         = 0x400, 
      RenderBlocking           = 0x800, 
      // TODO: ignore scale-based visibility (overview)
    };
    Q_DECLARE_FLAGS( Flags, Flag )

    
    void setFlags( QgsMapSettings::Flags flags );
    void setFlag( Flag flag, bool on = true );
    Flags flags() const;
    bool testFlag( Flag flag ) const;

    QgsRenderContext::TextRenderFormat textRenderFormat() const
    {
      return mTextRenderFormat;
    }

    void setTextRenderFormat( QgsRenderContext::TextRenderFormat format )
    {
      mTextRenderFormat = format;
      // ensure labeling engine setting is also kept in sync, just in case anyone accesses QgsMapSettings::labelingEngineSettings().defaultTextRenderFormat()
      // instead of correctly calling QgsMapSettings::textRenderFormat(). It can't hurt to be consistent!
      mLabelingEngineSettings.setDefaultTextRenderFormat( format );
    }

    void setOutputImageFormat( QImage::Format format ) { mImageFormat = format; }
    QImage::Format outputImageFormat() const { return mImageFormat; }

    bool hasValidSettings() const;
    QgsRectangle visibleExtent() const;

    QPolygonF visiblePolygon() const;
    double mapUnitsPerPixel() const;

    double scale() const;

    void setExpressionContext( const QgsExpressionContext &context ) { mExpressionContext = context; }

    const QgsExpressionContext &expressionContext() const { return mExpressionContext; }

    QgsCoordinateTransformContext transformContext() const;

    void setTransformContext( const QgsCoordinateTransformContext &context );

    const QgsPathResolver &pathResolver() const { return mPathResolver; }

    void setPathResolver( const QgsPathResolver &resolver ) { mPathResolver = resolver; }

    const QgsMapToPixel &mapToPixel() const { return mMapToPixel; }

    double layerToMapUnits( const QgsMapLayer *layer, const QgsRectangle &referenceExtent = QgsRectangle() ) const;

    QgsRectangle layerExtentToOutputExtent( const QgsMapLayer *layer, QgsRectangle extent ) const;

    QgsRectangle outputExtentToLayerExtent( const QgsMapLayer *layer, QgsRectangle extent ) const;

    QgsPointXY layerToMapCoordinates( const QgsMapLayer *layer, QgsPointXY point ) const;

    QgsRectangle layerToMapCoordinates( const QgsMapLayer *layer, QgsRectangle rect ) const;

    QgsPointXY mapToLayerCoordinates( const QgsMapLayer *layer, QgsPointXY point ) const;

    QgsRectangle mapToLayerCoordinates( const QgsMapLayer *layer, QgsRectangle rect ) const;

    QgsCoordinateTransform layerTransform( const QgsMapLayer *layer ) const;

    QgsRectangle fullExtent() const;

    /* serialization */

    void readXml( QDomNode &node );

    void writeXml( QDomNode &node, QDomDocument &doc );

    void setSegmentationTolerance( double tolerance ) { mSegmentationTolerance = tolerance; }
    double segmentationTolerance() const { return mSegmentationTolerance; }

    void setSegmentationToleranceType( QgsAbstractGeometry::SegmentationToleranceType type ) { mSegmentationToleranceType = type; }
    QgsAbstractGeometry::SegmentationToleranceType segmentationToleranceType() const { return mSegmentationToleranceType; }

    void setLabelingEngineSettings( const QgsLabelingEngineSettings &settings )
    {
      mLabelingEngineSettings = settings;
      mTextRenderFormat = settings.defaultTextRenderFormat();
    }

    const QgsLabelingEngineSettings &labelingEngineSettings() const { return mLabelingEngineSettings; }

    QgsGeometry labelBoundaryGeometry() const;

    void setLabelBoundaryGeometry( const QgsGeometry &boundary );

    void setLabelBlockingRegions( const QList< QgsLabelBlockingRegion > &regions ) { mLabelBlockingRegions = regions; }

    QList< QgsLabelBlockingRegion > labelBlockingRegions() const { return mLabelBlockingRegions; }

    void setSimplifyMethod( const QgsVectorSimplifyMethod &method ) { mSimplifyMethod = method; }

    const QgsVectorSimplifyMethod &simplifyMethod() const { return mSimplifyMethod; }

    void addRenderedFeatureHandler( QgsRenderedFeatureHandlerInterface *handler );

    QList< QgsRenderedFeatureHandlerInterface * > renderedFeatureHandlers() const;

  protected:

    double mDpi;

    QSize mSize;
    float mDevicePixelRatio = 1.0;

    QgsRectangle mExtent;
    double mExtentBuffer = 0.0;

    double mRotation = 0.0;
    double mMagnificationFactor = 1.0;

    QgsWeakMapLayerPointerList mLayers;
    QMap<QString, QString> mLayerStyleOverrides;
    QString mCustomRenderFlags;
    QgsExpressionContext mExpressionContext;

    QgsCoordinateReferenceSystem mDestCRS;
    QString mEllipsoid;

    QColor mBackgroundColor;
    QColor mSelectionColor;

    Flags mFlags;

    QImage::Format mImageFormat = QImage::Format_ARGB32_Premultiplied;

    double mSegmentationTolerance;
    QgsAbstractGeometry::SegmentationToleranceType mSegmentationToleranceType = QgsAbstractGeometry::MaximumAngle;

    QgsLabelingEngineSettings mLabelingEngineSettings;

    // derived properties
    bool mValid = false; 
    QgsRectangle mVisibleExtent; 
    double mMapUnitsPerPixel = 1;
    double mScale = 1;

    // utiity stuff
    QgsScaleCalculator mScaleCalculator;
    QgsMapToPixel mMapToPixel;

    QgsCoordinateTransformContext mTransformContext;

    QgsPathResolver mPathResolver;

    QgsRenderContext::TextRenderFormat mTextRenderFormat = QgsRenderContext::TextFormatAlwaysOutlines;

    QgsGeometry mLabelBoundaryGeometry;

    QgsVectorSimplifyMethod mSimplifyMethod;

#ifdef QGISDEBUG
    bool mHasTransformContext = false;
#endif

    void updateDerived();

  private:

    QList< QgsLabelBlockingRegion > mLabelBlockingRegions;
    QList< QgsRenderedFeatureHandlerInterface * > mRenderedFeatureHandlers;
};

Q_DECLARE_OPERATORS_FOR_FLAGS( QgsMapSettings::Flags )


#endif // QGSMAPSETTINGS_H