qgsatlascomposition.h

Go to the documentation of this file.

/***************************************************************************
                             qgsatlascomposermap.h
                             ---------------------
    begin                : October 2012
    copyright            : (C) 2005 by Hugo Mercier
    email                : hugo dot mercier at oslandia 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 QGSATLASCOMPOSITION_H
#define QGSATLASCOMPOSITION_H

#include "qgscoordinatetransform.h"
#include "qgsfeature.h"

#include <memory>
#include <QString>
#include <QDomElement>
#include <QDomDocument>
#include <QStringList>

class QgsComposerMap;
class QgsComposition;
class QgsVectorLayer;
class QgsExpression;
class QgsExpressionContext;

class CORE_EXPORT QgsAtlasComposition : public QObject
{
    Q_OBJECT
  public:
    QgsAtlasComposition( QgsComposition* composition );
    ~QgsAtlasComposition();

    bool enabled() const { return mEnabled; }

    void setEnabled( bool enabled );

    bool hideCoverage() const { return mHideCoverage; }

    void setHideCoverage( bool hide );

    QString filenamePattern() const { return mFilenamePattern; }

    bool setFilenamePattern( const QString& pattern );

    QString filenamePatternErrorString() const { return mFilenameParserError; }

    QgsVectorLayer* coverageLayer() const { return mCoverageLayer; }

    void setCoverageLayer( QgsVectorLayer* layer );

    QString pageNameExpression() const { return mPageNameExpression; }

    void setPageNameExpression( const QString& pageNameExpression ) { mPageNameExpression = pageNameExpression; }

    QString nameForPage( int pageNumber ) const;

    bool singleFile() const { return mSingleFile; }

    void setSingleFile( bool single ) { mSingleFile = single; }

    bool sortFeatures() const { return mSortFeatures; }
    void setSortFeatures( bool doSort ) { mSortFeatures = doSort; }

    bool sortAscending() const { return mSortAscending; }
    void setSortAscending( bool ascending ) { mSortAscending = ascending; }

    bool filterFeatures() const { return mFilterFeatures; }
    void setFilterFeatures( bool doFilter ) { mFilterFeatures = doFilter; }

    QString featureFilter() const { return mFeatureFilter; }
    void setFeatureFilter( const QString& expression ) { mFeatureFilter = expression; }

    QString featureFilterErrorString() const { return mFilterParserError; }

    QString sortKeyAttributeName() const { return mSortKeyAttributeName; }
    void setSortKeyAttributeName( const QString& fieldName ) { mSortKeyAttributeName = fieldName; }

    const QVector<qreal>& predefinedScales() const { return mPredefinedScales; }

    void setPredefinedScales( const QVector<qreal>& scales );

    bool beginRender();
    void endRender();

    int numFeatures() const;

    bool prepareForFeature( const int i, const bool updateMaps = true );

    bool prepareForFeature( const QgsFeature *feat );

    const QString& currentFilename() const;

    void writeXML( QDomElement& elem, QDomDocument& doc ) const;

    void readXML( const QDomElement& elem, const QDomDocument& doc );

    void readXMLMapSettings( const QDomElement& elem, const QDomDocument& doc );

    QgsComposition* composition() { return mComposition; }

    int updateFeatures();

    QgsFeature feature() const { return mCurrentFeature; }

    QString currentPageName() const;

    int currentFeatureNumber() const { return mCurrentFeatureNo; }

    void prepareMap( QgsComposerMap* map );


    //deprecated methods

    Q_DECL_DEPRECATED QgsComposerMap* composerMap() const;

    Q_DECL_DEPRECATED void setComposerMap( QgsComposerMap* map );

    Q_DECL_DEPRECATED bool fixedScale() const;

    Q_DECL_DEPRECATED void setFixedScale( bool fixed );

    Q_DECL_DEPRECATED float margin() const;

    Q_DECL_DEPRECATED void setMargin( float margin );

    Q_DECL_DEPRECATED int sortKeyAttributeIndex() const;
    Q_DECL_DEPRECATED void setSortKeyAttributeIndex( int idx );

    Q_DECL_DEPRECATED QgsFeature* currentFeature() { return &mCurrentFeature; }

  public slots:

    void refreshFeature();

    void nextFeature();
    void prevFeature();
    void lastFeature();
    void firstFeature();

  signals:
    void parameterChanged();

    void toggled( bool );

    void statusMsgChanged( QString message );

    void coverageLayerChanged( QgsVectorLayer* layer );

    void renderBegun();

    void renderEnded();

    void featureChanged( QgsFeature* feature );

    void numberFeaturesChanged( int numFeatures );

  private:
    bool updateFilenameExpression();

    bool evalFeatureFilename( const QgsExpressionContext &context );

    QgsComposition* mComposition;

    bool mEnabled;
    bool mHideCoverage;
    QString mFilenamePattern;
    QgsVectorLayer* mCoverageLayer;
    bool mSingleFile;

    QgsCoordinateTransform mTransform;
    QString mCurrentFilename;
    // feature ordering
    bool mSortFeatures;
    // sort direction
    bool mSortAscending;

    // current atlas feature number
    int mCurrentFeatureNo;

  public:
    typedef QMap< QgsFeatureId, QVariant > SorterKeys;

  private slots:
    void removeLayers( const QStringList& layers );

  private:
    // value of field that is used for ordering of features
    SorterKeys mFeatureKeys;
    // key (attribute index) used for ordering
    QString mSortKeyAttributeName;

    QString mPageNameExpression;

    // feature filtering
    bool mFilterFeatures;
    // feature expression filter
    QString mFeatureFilter;

    // id of each iterated feature (after filtering and sorting) paired with atlas page name
    QVector< QPair<QgsFeatureId, QString> > mFeatureIds;

    QgsFeature mCurrentFeature;

    QScopedPointer<QgsExpression> mFilenameExpr;

    // bounding box of the current feature transformed into map crs
    QgsRectangle mTransformedFeatureBounds;

    QString mFilenameParserError;
    QString mFilterParserError;

    //forces all atlas enabled maps to redraw
    void updateAtlasMaps();

    //computes the extent of the current feature, in the crs of the specified map
    void computeExtent( QgsComposerMap *map );

    QgsExpressionContext createExpressionContext();

    //list of predefined scales
    QVector<qreal> mPredefinedScales;
};

#endif