QGIS/python/core/auto_generated/qgsmapunitscale.sip.in

72 lines
2.3 KiB
Plaintext
Raw Normal View History

2017-05-14 09:48:41 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsmapunitscale.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
2014-04-06 21:14:02 +02:00
class QgsMapUnitScale
{
2017-05-14 09:48:41 +02:00
%Docstring
Struct for storing maximum and minimum scales for measurements in map units
2017-05-14 09:48:41 +02:00
2017-12-15 10:36:55 -04:00
For measurements in map units, a minimum and a maximum scale can be defined.
Outside this range, the measurements aren't scaled anymore proportionally to
the map scale.
2017-05-14 09:48:41 +02:00
%End
2014-04-06 21:14:02 +02:00
%TypeHeaderCode
2017-05-14 09:48:41 +02:00
#include "qgsmapunitscale.h"
2014-04-06 21:14:02 +02:00
%End
2014-05-27 23:22:50 +02:00
public:
explicit QgsMapUnitScale( double minScale = 0.0, double maxScale = 0.0 );
2017-05-14 09:48:41 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Constructor for QgsMapUnitScale
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param minScale: minimum allowed scale, or 0.0 if no minimum scale set
:param maxScale: maximum allowed scale, or 0.0 if no maximum scale set
The scale values indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
2017-05-14 09:48:41 +02:00
%End
2014-04-06 21:14:02 +02:00
2014-05-27 23:22:50 +02:00
double minScale;
2014-05-27 23:22:50 +02:00
double maxScale;
2014-04-06 21:14:02 +02:00
bool minSizeMMEnabled;
double minSizeMM;
bool maxSizeMMEnabled;
double maxSizeMM;
double computeMapUnitsPerPixel( const QgsRenderContext &c ) const;
2017-05-14 09:48:41 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Computes a map units per pixel scaling factor, respecting the minimum and maximum scales
set for the object.
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param c: render context
:return: map units per pixel, limited between minimum and maximum scales
2017-05-14 09:48:41 +02:00
%End
bool operator==( const QgsMapUnitScale &other ) const;
2017-05-14 09:48:41 +02:00
bool operator!=( const QgsMapUnitScale &other ) const;
2014-04-06 21:14:02 +02:00
};
2017-05-14 09:48:41 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsmapunitscale.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/