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 <QColor>
#include <QImage>
#include <QSize>
#include <QStringList>

#include "qgsabstractgeometryv2.h"
#include "qgscoordinatereferencesystem.h"
#include "qgsdatumtransformstore.h"
#include "qgsmaptopixel.h"
#include "qgsrectangle.h"
#include "qgsscalecalculator.h"
#include "qgsexpressioncontext.h"

class QPainter;

class QgsCoordinateTransform;
class QgsScaleCalculator;
class QgsMapRendererJob;
class QgsMapLayer;


class CORE_EXPORT QgsMapSettings
{
  public:
    QgsMapSettings();

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

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

    double rotation() const;
    void setRotation( double degrees );

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

    void setMagnificationFactor( double factor );

    double magnificationFactor() const;

    QStringList layers() const;
    void setLayers( const QStringList& 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 setCrsTransformEnabled( bool enabled );
    bool hasCrsTransformEnabled() const;

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

    QGis::UnitType mapUnits() const;
    void setMapUnits( QGis::UnitType u );

    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, 
      // TODO: ignore scale-based visibility (overview)
    };
    Q_DECLARE_FLAGS( Flags, Flag )

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

    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; }

    // -- utility functions --

    const QgsDatumTransformStore& datumTransformStore() const { return mDatumTransformStore; }
    QgsDatumTransformStore& datumTransformStore() { return mDatumTransformStore; }

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

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

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

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

    QgsPoint layerToMapCoordinates( QgsMapLayer* theLayer, QgsPoint point ) const;

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

    QgsPoint mapToLayerCoordinates( QgsMapLayer* theLayer, QgsPoint point ) const;

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

    const QgsCoordinateTransform* layerTransform( QgsMapLayer *layer ) const;

    QgsRectangle fullExtent() const;

    /* serialization */

    void readXML( QDomNode& theNode );

    void writeXML( QDomNode& theNode, QDomDocument& theDoc );

    void setSegmentationTolerance( double tolerance ) { mSegmentationTolerance = tolerance; }
    double segmentationTolerance() const { return mSegmentationTolerance; }
    void setSegmentationToleranceType( QgsAbstractGeometryV2::SegmentationToleranceType type ) { mSegmentationToleranceType = type; }
    QgsAbstractGeometryV2::SegmentationToleranceType segmentationToleranceType() const { return mSegmentationToleranceType; }

  protected:

    double mDpi;

    QSize mSize;

    QgsRectangle mExtent;

    double mRotation;
    double mMagnificationFactor;

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

    bool mProjectionsEnabled;
    QgsCoordinateReferenceSystem mDestCRS;
    QgsDatumTransformStore mDatumTransformStore;

    QColor mBackgroundColor;
    QColor mSelectionColor;

    Flags mFlags;

    QImage::Format mImageFormat;

    double mSegmentationTolerance;
    QgsAbstractGeometryV2::SegmentationToleranceType mSegmentationToleranceType;


    // derived properties
    bool mValid; 
    QgsRectangle mVisibleExtent; 
    double mMapUnitsPerPixel;
    double mScale;

    // utiity stuff
    QgsScaleCalculator mScaleCalculator;
    QgsMapToPixel mMapToPixel;

    void updateDerived();
};

Q_DECLARE_OPERATORS_FOR_FLAGS( QgsMapSettings::Flags )


#endif // QGSMAPSETTINGS_H