qgsmaptopixel.h

Go to the documentation of this file.

/***************************************************************************
                          qgsmaptopixel.h  -  description
                             -------------------
    begin                : Sat Jun 22 2002
    copyright            : (C) 2002 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 QGSMAPTOPIXEL
#define QGSMAPTOPIXEL

#include "qgspoint.h"
#include <vector>

#include <cassert>

class QgsPoint;
class QPoint;

class CORE_EXPORT QgsMapToPixel
{
  public:
    /* Constructor
    * @param mapUnitsPerPixel Map units per pixel
    * @param ymax Maximum y value of the map canvas
    * @param ymin Minimum y value of the map canvas
    * @param xmin Minimum x value of the map canvas
    */
    QgsMapToPixel( double mapUnitsPerPixel = 0, double ymax = 0, double ymin = 0,
                   double xmin = 0 );
    ~QgsMapToPixel();
    QgsPoint transform( const QgsPoint& p ) const;
    void transform( QgsPoint* p ) const;
    QgsPoint transform( double x, double y ) const;
    /* Transform device coordinates to map coordinates. Modifies the
       given coordinates in place. Intended as a fast way to do the
       transform. */
    void transformInPlace( double& x, double& y ) const;

    /* Transform device coordinates to map coordinates. Modifies the
       given coordinates in place. Intended as a fast way to do the
       transform.
       @note not available in python bindings
     */
    void transformInPlace( QVector<double>& x, QVector<double>& y ) const;

#ifdef ANDROID
    void transformInPlace( float& x, float& y ) const;
    void transformInPlace( QVector<float>& x, QVector<float>& y ) const;
#endif

    QgsPoint toMapCoordinates( int x, int y ) const;

    QgsPoint toMapCoordinatesF( double x, double y ) const;

    QgsPoint toMapCoordinates( QPoint p ) const;

    QgsPoint toMapPoint( double x, double y ) const;
    void setMapUnitsPerPixel( double mapUnitsPerPixel );

    double mapUnitsPerPixel() const;

    void setYMaximum( double ymax );
    void setYMinimum( double ymin );
    void setXMinimum( double xmin );
    void setParameters( double mapUnitsPerPixel, double xmin, double ymin, double ymax );
    QString showParameters();

  private:
    double mMapUnitsPerPixel;
    double yMax;
    double yMin;
    double xMin;
};


#endif // QGSMAPTOPIXEL