Consolidate all render context unit conversion to single methods

within QgsRenderContext

Fix invalid conversions, update unit tests

Author: nyalldawson

doc/api_break.dox

@@ -1718,6 +1718,11 @@ QgsSymbolLayerUtils (renamed from QgsSymbolLayerUtilsV2)        {#qgis_api_break
 - The signatures for wellKnownMarkerToSld() and wellKnownMarkerFromSld() were changed.
 - The symbolPreviewPixmap() customContext is now the fourth parameter
 - createRenderContext() was moved to QgsRenderContext::fromQPainter()
+- lineWidthScaleFactor() and convertToPainterUnits() were moved to QgsRenderContext::convertToPainterUnits()
+- convertToMapUnits() was moved to QgsRenderContext::convertToMapUnits()
+- convertFromMapUnits() was moved to QgsRenderContext::convertFromMapUnits()
+- pixelSizeScaleFactor() was removed. Use QgsRenderContext::convertToPainterUnits() instead.
+- mapUnitScaleFactor() was removed. Use QgsRenderContext::convertToMapUnits() instead.
 
 
 QgsSymbolSelectorWidget        {#qgis_api_break_3_0_QgsSymbolSelectorWidget}

python/core/diagram/qgsdiagram.sip

@@ -61,7 +61,7 @@ class QgsDiagram
      *
      *  @return The converted length for rendering
      */
-    float sizePainterUnits( float l, const QgsDiagramSettings& s, const QgsRenderContext& c );
+    double sizePainterUnits( double l, const QgsDiagramSettings& s, const QgsRenderContext& c );
 
     /** Calculates a size to match the current settings and rendering context
      *  @param s    The settings that contain the font size and size type

python/core/qgsrendercontext.sip

@@ -196,4 +196,9 @@ class QgsRenderContext
     void setSegmentationToleranceType( QgsAbstractGeometry::SegmentationToleranceType type );
     /** Gets segmentation tolerance type (maximum angle or maximum difference between curve and approximation)*/
     QgsAbstractGeometry::SegmentationToleranceType segmentationToleranceType() const;
+
+    double convertToPainterUnits( double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale& scale = QgsMapUnitScale() ) const;
+    double convertToMapUnits( double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale& scale = QgsMapUnitScale() ) const;
+    double convertFromMapUnits( double sizeInMapUnits, QgsUnitTypes::RenderUnit outputUnit ) const;
+
 };

python/core/qgstextrenderer.sip

@@ -1054,15 +1054,6 @@ class QgsTextRenderer
      */
     static int sizeToPixel( double size, const QgsRenderContext& c, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale& mapUnitScale = QgsMapUnitScale() );
 
-    /** Calculates size (considering output size should be in pixel or map units, scale factors and optionally oversampling)
-     * @param size size to convert
-     * @param c rendercontext
-     * @param unit size units
-     * @param mapUnitScale a mapUnitScale clamper
-     * @return size that will render, as double
-     */
-    static double scaleToPixelContext( double size, const QgsRenderContext& c, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale& mapUnitScale = QgsMapUnitScale() );
-
     /** Draws text within a rectangle using the specified settings.
      * @param rect destination rectangle for text
      * @param rotation text rotation

python/core/symbology-ng/qgssymbollayerutils.sip

@@ -380,56 +380,6 @@ class QgsSymbolLayerUtils
      */
     static QColor parseColorWithAlpha( const QString& colorStr, bool &containsAlpha, bool strictEval = false );
 
-    /** Returns the line width scale factor depending on the unit and the paint device.
-     * Consider using convertToPainterUnits() instead, as convertToPainterUnits() respects the size limits specified by the scale
-     * parameter.
-     * @param c render context
-     * @param u units to convert from
-     * @param scale map unit scale, specifying limits for the map units to convert from
-     * @see convertToPainterUnits()
-     */
-    static double lineWidthScaleFactor( const QgsRenderContext& c, QgsUnitTypes::RenderUnit u, const QgsMapUnitScale& scale = QgsMapUnitScale() );
-
-    /** Converts a size from the specied units to painter units. The conversion respects the limits
-     * specified by the optional scale parameter.
-     * @param c render context
-     * @param size size to convert
-     * @param unit units for specified size
-     * @param scale map unit scale
-     * @note added in QGIS 2.12
-     * @see lineWidthScaleFactor()
-     * @see convertToMapUnits()
-     */
-    static double convertToPainterUnits( const QgsRenderContext&c, double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale& scale = QgsMapUnitScale() );
-
-    /** Converts a size from the specied units to map units. The conversion respects the limits
-     * specified by the optional scale parameter.
-     * @param c render context
-     * @param size size to convert
-     * @param unit units for specified size
-     * @param scale map unit scale
-     * @note added in QGIS 2.16
-     * @see convertFromMapUnits()
-     * @see convertToPainterUnits()
-     */
-    static double convertToMapUnits( const QgsRenderContext&c, double size, QgsUnitTypes::RenderUnit unit, const QgsMapUnitScale& scale = QgsMapUnitScale() );
-
-    /** Converts a size from map units to the specied units.
-     * @param context render context
-     * @param sizeInMapUnits size (in map units) to convert
-     * @param outputUnit output units
-     * @note added in QGIS 3.0
-     * @see convertToMapUnits()
-     */
-    static double convertFromMapUnits( const QgsRenderContext& context, double sizeInMapUnits, QgsUnitTypes::RenderUnit outputUnit );
-
-
-    /** Returns scale factor painter units -> pixel dimensions*/
-    static double pixelSizeScaleFactor( const QgsRenderContext& c, QgsUnitTypes::RenderUnit u, const QgsMapUnitScale& scale = QgsMapUnitScale() );
-
-    /** Returns scale factor painter units -> map units*/
-    static double mapUnitScaleFactor( const QgsRenderContext& c, QgsUnitTypes::RenderUnit u, const QgsMapUnitScale& scale = QgsMapUnitScale() );
-
     /** Multiplies opacity of image pixel values with a (global) transparency value*/
     static void multiplyImageOpacity( QImage* image, qreal alpha );
 

scripts/spell_check/spelling.dat

@@ -6374,6 +6374,7 @@ specialise:specialize
 speciallized:specialized
 speciefied:specified
 specifc:specific
+specied:specified
 specifed:specified
 specificatin:specification
 specificaton:specification

src/core/CMakeLists.txt

@@ -164,6 +164,7 @@ SET(QGIS_CORE_SRCS
   qgsmapsettings.cpp
   qgsmaptopixel.cpp
   qgsmaptopixelgeometrysimplifier.cpp
+  qgsmapunitscale.cpp
   qgsmessagelog.cpp
   qgsmessageoutput.cpp
   qgsmimedatautils.cpp

src/core/diagram/qgsdiagram.cpp

@@ -58,18 +58,18 @@ QgsExpression *QgsDiagram::getExpression( const QString &expression, const QgsEx
 
 void QgsDiagram::setPenWidth( QPen& pen, const QgsDiagramSettings& s, const QgsRenderContext& c )
 {
-  pen.setWidthF( QgsSymbolLayerUtils::convertToPainterUnits( c, s.penWidth, s.lineSizeUnit, s.lineSizeScale ) );
+  pen.setWidthF( c.convertToPainterUnits( s.penWidth, s.lineSizeUnit, s.lineSizeScale ) );
 }
 
 
 QSizeF QgsDiagram::sizePainterUnits( QSizeF size, const QgsDiagramSettings& s, const QgsRenderContext& c )
 {
-  return QSizeF( QgsSymbolLayerUtils::convertToPainterUnits( c, size.width(), s.sizeType, s.sizeScale ), QgsSymbolLayerUtils::convertToPainterUnits( c, size.height(), s.sizeType, s.sizeScale ) );
+  return QSizeF( c.convertToPainterUnits( size.width(), s.sizeType, s.sizeScale ), c.convertToPainterUnits( size.height(), s.sizeType, s.sizeScale ) );
 }
 
-float QgsDiagram::sizePainterUnits( float l, const QgsDiagramSettings& s, const QgsRenderContext& c )
+double QgsDiagram::sizePainterUnits( double l, const QgsDiagramSettings& s, const QgsRenderContext& c )
 {
-  return QgsSymbolLayerUtils::convertToPainterUnits( c, l, s.sizeType, s.sizeScale );
+  return c.convertToPainterUnits( l, s.sizeType, s.sizeScale );
 }
 
 QFont QgsDiagram::scaledFont( const QgsDiagramSettings& s, const QgsRenderContext& c )

src/core/diagram/qgsdiagram.h

@@ -98,7 +98,7 @@ class CORE_EXPORT QgsDiagram
      *
      *  @return The converted length for rendering
      */
-    float sizePainterUnits( float l, const QgsDiagramSettings& s, const QgsRenderContext& c );
+    double sizePainterUnits( double l, const QgsDiagramSettings& s, const QgsRenderContext& c );
 
     /** Calculates a size to match the current settings and rendering context
      *  @param s    The settings that contain the font size and size type

src/core/effects/qgsgloweffect.cpp

@@ -79,7 +79,7 @@ void QgsGlowEffect::draw( QgsRenderContext &context )
   }
 
   QgsImageOperation::DistanceTransformProperties dtProps;
-  dtProps.spread = mSpread * QgsSymbolLayerUtils::pixelSizeScaleFactor( context, mSpreadUnit, mSpreadMapUnitScale );
+  dtProps.spread = context.convertToPainterUnits( mSpread, mSpreadUnit, mSpreadMapUnitScale );
   dtProps.useMaxDistance = false;
   dtProps.shadeExterior = shadeExterior();
   dtProps.ramp = ramp;
@@ -213,7 +213,7 @@ QgsGlowEffect &QgsGlowEffect::operator=( const QgsGlowEffect & rhs )
 QRectF QgsGlowEffect::boundingRect( const QRectF &rect, const QgsRenderContext& context ) const
 {
   //spread size
-  double spread = mSpread * QgsSymbolLayerUtils::pixelSizeScaleFactor( context, mSpreadUnit, mSpreadMapUnitScale );
+  double spread = context.convertToPainterUnits( mSpread, mSpreadUnit, mSpreadMapUnitScale );
   //plus possible extension due to blur, with a couple of extra pixels thrown in for safety
   spread += mBlurLevel * 2 + 10;
   return rect.adjusted( -spread, -spread, spread, spread );