QgsMapUnitScale Class Reference

Struct for storing maximum and minimum scales for measurements in map units. More...

#include <qgsmapunitscale.h>

Public Member Functions
	QgsMapUnitScale (double minScale=0.0, double maxScale=0.0)
	Constructor for QgsMapUnitScale. More...
double	computeMapUnitsPerPixel (const QgsRenderContext &c) const
	Computes a map units per pixel scaling factor, respecting the minimum and maximum scales set for the object. More...
bool	operator!= (const QgsMapUnitScale &other) const
bool	operator== (const QgsMapUnitScale &other) const

Public Attributes
double	maxScale
	The maximum scale, or 0.0 if unset. More...
double	maxSizeMM = 0.0
	The maximum size in millimeters, or 0.0 if unset. More...
bool	maxSizeMMEnabled = false
	Whether the maximum size in mm should be respected. More...
double	minScale
	The minimum scale, or 0.0 if unset. More...
double	minSizeMM = 0.0
	The minimum size in millimeters, or 0.0 if unset. More...
bool	minSizeMMEnabled = false
	Whether the minimum size in mm should be respected. More...

Detailed Description

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.

Definition at line 37 of file qgsmapunitscale.h.

Constructor & Destructor Documentation

QgsMapUnitScale::QgsMapUnitScale ( double  minScale = 0.0, double  maxScale = 0.0  )

inlineexplicit

Constructor for QgsMapUnitScale.

Parameters

minScale	minimum allowed scale, or 0.0 if no minimum scale set
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.

Definition at line 47 of file qgsmapunitscale.h.

Member Function Documentation

double QgsMapUnitScale::computeMapUnitsPerPixel

(

const QgsRenderContext &

c

)

const

Computes a map units per pixel scaling factor, respecting the minimum and maximum scales set for the object.

Parameters

c	render context

Returns

map units per pixel, limited between minimum and maximum scales

Definition at line 20 of file qgsmapunitscale.cpp.

bool QgsMapUnitScale::operator!= ( const QgsMapUnitScale &  other ) const

inline

Definition at line 91 of file qgsmapunitscale.h.

bool QgsMapUnitScale::operator== ( const QgsMapUnitScale &  other ) const

inline

Definition at line 81 of file qgsmapunitscale.h.

Member Data Documentation

double QgsMapUnitScale::maxScale

The maximum scale, or 0.0 if unset.

The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

Definition at line 62 of file qgsmapunitscale.h.

double QgsMapUnitScale::maxSizeMM = 0.0

The maximum size in millimeters, or 0.0 if unset.

Definition at line 71 of file qgsmapunitscale.h.

bool QgsMapUnitScale::maxSizeMMEnabled = false

Whether the maximum size in mm should be respected.

Definition at line 69 of file qgsmapunitscale.h.

double QgsMapUnitScale::minScale

The minimum scale, or 0.0 if unset.

The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

Definition at line 56 of file qgsmapunitscale.h.

double QgsMapUnitScale::minSizeMM = 0.0

The minimum size in millimeters, or 0.0 if unset.

Definition at line 67 of file qgsmapunitscale.h.

bool QgsMapUnitScale::minSizeMMEnabled = false

Whether the minimum size in mm should be respected.

Definition at line 65 of file qgsmapunitscale.h.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.4.15+24xenial/src/core/qgsmapunitscale.h
• /build/qgis-3.4.15+24xenial/src/core/qgsmapunitscale.cpp