QGIS/python/core/qgsmapunitscale.sip
Denis Rouzaud 93971d5ed3 [sip] align pointer and reference in blacklisted files
this will facilitate sip diff checking
2017-05-01 17:49:43 +02:00

47 lines
1.5 KiB
Plaintext

/*!
* \class QgsMapUnitScale
* \brief Struct for storing maximum and minimum scales for measurements in map units
*
* 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.
*/
class QgsMapUnitScale
{
%TypeHeaderCode
#include <qgsmapunitscale.h>
%End
public:
/** Constructor for QgsMapUnitScale
* @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
*/
explicit QgsMapUnitScale( double minScale = 0.0, double maxScale = 0.0 );
/** The minimum scale, or 0.0 if unset */
double minScale;
/** The maximum scale, or 0.0 if unset */
double maxScale;
/** Whether the minimum size in mm should be respected */
bool minSizeMMEnabled;
/** The minimum size in millimeters, or 0.0 if unset */
double minSizeMM;
/** Whether the maximum size in mm should be respected */
bool maxSizeMMEnabled;
/** The maximum size in millimeters, or 0.0 if unset */
double maxSizeMM;
/** Computes a map units per pixel scaling factor, respecting the minimum and maximum scales
* set for the object.
* @param c render context
* @returns map units per pixel, limited between minimum and maximum scales
*/
double computeMapUnitsPerPixel( const QgsRenderContext &c ) const;
bool operator==( const QgsMapUnitScale &other ) const;
bool operator!=( const QgsMapUnitScale &other ) const;
};