qgsscalecalculator.h

Go to the documentation of this file.

/***************************************************************************
                          qgsscalecalculator.h
              Calculates scale based on map extent and units
                             -------------------
    begin                : May 18, 2004
    copyright            : (C) 2004 by Gary E.Sherman
    email                : sherman at mrcc.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 QGSSCALECALCULATOR_H
#define QGSSCALECALCULATOR_H

#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsunittypes.h"

class QString;
class QgsRectangle;

class CORE_EXPORT QgsScaleCalculator
{
  public:

    QgsScaleCalculator( double dpi = 0,
                        QgsUnitTypes::DistanceUnit mapUnits = QgsUnitTypes::DistanceMeters );

    void setDpi( double dpi );

    double dpi();

    void setMapUnits( QgsUnitTypes::DistanceUnit mapUnits );

    QgsUnitTypes::DistanceUnit mapUnits() const;

    double calculate( const QgsRectangle &mapExtent, double canvasWidth ) const;

    double calculateGeographicDistance( const QgsRectangle &mapExtent ) const;

  private:

    double mDpi;

    QgsUnitTypes::DistanceUnit mMapUnits;
};

#endif // #ifndef QGSSCALECALCULATOR_H