Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :   qgsmapunitscale.h
       3                 :            :   Struct for storing maximum and minimum scales for measurements in map units
       4                 :            :   -------------------
       5                 :            :    begin                : April 2014
       6                 :            :    copyright            : (C) Sandro Mani
       7                 :            :    email                : smani at sourcepole dot ch
       8                 :            : 
       9                 :            :  ***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSMAPUNITSCALE_H
      19                 :            : #define QGSMAPUNITSCALE_H
      20                 :            : 
      21                 :            : #include "qgis_core.h"
      22                 :            : #include "qgis.h"
      23                 :            : 
      24                 :            : class QgsRenderContext;
      25                 :            : 
      26                 :            : /**
      27                 :            :  * \ingroup core
      28                 :            :  * \class QgsMapUnitScale
      29                 :            :  * \brief Struct for storing maximum and minimum scales for measurements in map units
      30                 :            :  *
      31                 :            :  * For measurements in map units, a minimum and a maximum scale can be defined.
      32                 :            :  * Outside this range, the measurements aren't scaled anymore proportionally to
      33                 :            :  * the map scale.
      34                 :            :  */
      35                 :            : 
      36                 :            : class CORE_EXPORT QgsMapUnitScale
      37                 :            : {
      38                 :            :   public:
      39                 :            : 
      40                 :            :     /**
      41                 :            :      * Constructor for QgsMapUnitScale
      42                 :            :      * \param minScale minimum allowed scale, or 0.0 if no minimum scale set
      43                 :            :      * \param maxScale maximum allowed scale, or 0.0 if no maximum scale set
      44                 :            :      * The scale values indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
      45                 :            :      */
      46                 :      11645 :     explicit QgsMapUnitScale( double minScale = 0.0, double maxScale = 0.0 )
      47                 :      11645 :       : minScale( minScale )
      48                 :      11645 :       , maxScale( maxScale )
      49                 :      11645 :     {}
      50                 :            : 
      51                 :            :     /**
      52                 :            :      * The minimum scale, or 0.0 if unset.
      53                 :            :      * The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
      54                 :            :      */
      55                 :            :     double minScale;
      56                 :            : 
      57                 :            :     /**
      58                 :            :      * The maximum scale, or 0.0 if unset.
      59                 :            :      * The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
      60                 :            :      */
      61                 :            :     double maxScale;
      62                 :            : 
      63                 :            :     //! Whether the minimum size in mm should be respected
      64                 :      11645 :     bool minSizeMMEnabled = false;
      65                 :            :     //! The minimum size in millimeters, or 0.0 if unset
      66                 :      11645 :     double minSizeMM = 0.0;
      67                 :            :     //! Whether the maximum size in mm should be respected
      68                 :      11645 :     bool maxSizeMMEnabled = false;
      69                 :            :     //! The maximum size in millimeters, or 0.0 if unset
      70                 :      11645 :     double maxSizeMM = 0.0;
      71                 :            : 
      72                 :            :     /**
      73                 :            :      * Computes a map units per pixel scaling factor, respecting the minimum and maximum scales
      74                 :            :      * set for the object.
      75                 :            :      * \param c render context
      76                 :            :      * \returns map units per pixel, limited between minimum and maximum scales
      77                 :            :      */
      78                 :            :     double computeMapUnitsPerPixel( const QgsRenderContext &c ) const;
      79                 :            : 
      80                 :          0 :     bool operator==( const QgsMapUnitScale &other ) const
      81                 :            :     {
      82                 :          0 :       return qgsDoubleNear( minScale, other.minScale )
      83                 :          0 :              && qgsDoubleNear( maxScale, other.maxScale )
      84                 :          0 :              && minSizeMMEnabled == other.minSizeMMEnabled
      85                 :          0 :              && qgsDoubleNear( minSizeMM, other.minSizeMM )
      86                 :          0 :              && maxSizeMMEnabled == other.maxSizeMMEnabled
      87                 :          0 :              && qgsDoubleNear( maxSizeMM, other.maxSizeMM );
      88                 :            :     }
      89                 :            : 
      90                 :          0 :     bool operator!=( const QgsMapUnitScale &other ) const
      91                 :            :     {
      92                 :          0 :       return !operator==( other );
      93                 :            :     }
      94                 :            : };
      95                 :            : 
      96                 :            : 
      97                 :            : #endif // QGSMAPUNITSCALE_H
      98                 :            : 
      99                 :            : 
     100                 :            :