Expose project QgsPathResolver to render context

So that it can be used when resolving paths to data defined file-based settings, e.g. svg marker paths. Fixes #17364
qgis · Jan 29, 2018 · ec22411 · ec22411
1 parent cf3014c
commit ec22411
Show file tree

Hide file tree

Showing 14 changed files with 122 additions and 6 deletions.
diff --git a/python/core/qgsmapsettings.sip.in b/python/core/qgsmapsettings.sip.in
@@ -327,6 +327,26 @@ from a source to destination coordinate reference system.
 .. versionadded:: 3.0
 
 .. seealso:: :py:func:`transformContext`
+%End
+
+    const QgsPathResolver &pathResolver() const;
+%Docstring
+Returns the path resolver for conversion between relative and absolute paths
+during rendering operations, e.g. for resolving relative symbol paths.
+
+.. versionadded:: 3.0
+
+.. seealso:: :py:func:`setPathResolver`
+%End
+
+    void setPathResolver( const QgsPathResolver &resolver );
+%Docstring
+Sets the path ``resolver`` for conversion between relative and absolute paths
+during rendering operations, e.g. for resolving relative symbol paths.
+
+.. versionadded:: 3.0
+
+.. seealso:: :py:func:`pathResolver`
 %End
 
     const QgsMapToPixel &mapToPixel() const;
@@ -465,6 +485,8 @@ Returns global configuration of the labeling engine
 
 
 
+
+
     void updateDerived();
 };
 

diff --git a/python/core/qgsrendercontext.sip.in b/python/core/qgsrendercontext.sip.in
@@ -131,6 +131,26 @@ from a source to destination coordinate reference system.
 .. versionadded:: 3.0
 
 .. seealso:: :py:func:`transformContext`
+%End
+
+    const QgsPathResolver &pathResolver() const;
+%Docstring
+Returns the path resolver for conversion between relative and absolute paths
+during rendering operations, e.g. for resolving relative symbol paths.
+
+.. versionadded:: 3.0
+
+.. seealso:: :py:func:`setPathResolver`
+%End
+
+    void setPathResolver( const QgsPathResolver &resolver );
+%Docstring
+Sets the path ``resolver`` for conversion between relative and absolute paths
+during rendering operations, e.g. for resolving relative symbol paths.
+
+.. versionadded:: 3.0
+
+.. seealso:: :py:func:`pathResolver`
 %End
 
     const QgsRectangle &extent() const;

diff --git a/src/3d/qgs3dmapsettings.h b/src/3d/qgs3dmapsettings.h
@@ -106,6 +106,24 @@ class _3D_EXPORT Qgs3DMapSettings : public QObject
      */
     void setTransformContext( const QgsCoordinateTransformContext &context );
 
+    /**
+     * Returns the path resolver for conversion between relative and absolute paths
+     * during rendering operations, e.g. for resolving relative symbol paths.
+     *
+     * \since QGIS 3.0
+     * \see setPathResolver()
+     */
+    const QgsPathResolver &pathResolver() const { return mPathResolver; }
+
+    /**
+     * Sets the path \a resolver for conversion between relative and absolute paths
+     * during rendering operations, e.g. for resolving relative symbol paths.
+     *
+     * \since QGIS 3.0
+     * \see pathResolver()
+     */
+    void setPathResolver( const QgsPathResolver &resolver ) { mPathResolver = resolver; }
+
     //! Sets background color of the 3D map view
     void setBackgroundColor( const QColor &color );
     //! Returns background color of the 3D map view
@@ -259,6 +277,7 @@ class _3D_EXPORT Qgs3DMapSettings : public QObject
     QString mSkyboxFileExtension; //!< Extension part of the files with skybox textures
     //! Coordinate transform context
     QgsCoordinateTransformContext mTransformContext;
+    QgsPathResolver mPathResolver;
 };
 
 

diff --git a/src/3d/terrain/qgsterraintexturegenerator_p.cpp b/src/3d/terrain/qgsterraintexturegenerator_p.cpp
@@ -133,6 +133,7 @@ QgsMapSettings QgsTerrainTextureGenerator::baseMapSettings()
   mapSettings.setBackgroundColor( mMap.backgroundColor() );
   mapSettings.setFlag( QgsMapSettings::DrawLabeling, mMap.showLabels() );
   mapSettings.setTransformContext( mMap.transformContext() );
+  mapSettings.setPathResolver( mMap.pathResolver() );
   return mapSettings;
 }
 

diff --git a/src/app/qgisapp.cpp b/src/app/qgisapp.cpp
@@ -10300,6 +10300,7 @@ void QgisApp::new3DMapCanvas()
     map->setBackgroundColor( mMapCanvas->canvasColor() );
     map->setLayers( mMapCanvas->layers() );
     map->setTransformContext( QgsProject::instance()->transformContext() );
+    map->setPathResolver( QgsProject::instance()->pathResolver() );
     connect( QgsProject::instance(), &QgsProject::transformContextChanged, map, [map]
     {
       map->setTransformContext( QgsProject::instance()->transformContext() );

diff --git a/src/app/qgsmapsavedialog.cpp b/src/app/qgsmapsavedialog.cpp
@@ -296,6 +296,7 @@ void QgsMapSaveDialog::applyMapSettings( QgsMapSettings &mapSettings )
   mapSettings.setRotation( mMapCanvas->rotation() );
   mapSettings.setLayers( mMapCanvas->layers() );
   mapSettings.setTransformContext( QgsProject::instance()->transformContext() );
+  mapSettings.setPathResolver( QgsProject::instance()->pathResolver() );
 
   //build the expression context
   QgsExpressionContext expressionContext;

diff --git a/src/core/layout/qgslayoutitemmap.cpp b/src/core/layout/qgslayoutitemmap.cpp
@@ -1096,6 +1096,7 @@ QgsMapSettings QgsLayoutItemMap::mapSettings( const QgsRectangle &extent, QSizeF
   jobMapSettings.setFlag( QgsMapSettings::DrawSelection, false );
   jobMapSettings.setFlag( QgsMapSettings::UseAdvancedEffects, mLayout->renderContext().flags() & QgsLayoutRenderContext::FlagUseAdvancedEffects );
   jobMapSettings.setTransformContext( mLayout->project()->transformContext() );
+  jobMapSettings.setPathResolver( mLayout->project()->pathResolver() );
 
   jobMapSettings.setLabelingEngineSettings( mLayout->project()->labelingEngineSettings() );
 

diff --git a/src/core/qgsmapsettings.h b/src/core/qgsmapsettings.h
@@ -287,6 +287,24 @@ class CORE_EXPORT QgsMapSettings
      */
     void setTransformContext( const QgsCoordinateTransformContext &context );
 
+    /**
+     * Returns the path resolver for conversion between relative and absolute paths
+     * during rendering operations, e.g. for resolving relative symbol paths.
+     *
+     * \since QGIS 3.0
+     * \see setPathResolver()
+     */
+    const QgsPathResolver &pathResolver() const { return mPathResolver; }
+
+    /**
+     * Sets the path \a resolver for conversion between relative and absolute paths
+     * during rendering operations, e.g. for resolving relative symbol paths.
+     *
+     * \since QGIS 3.0
+     * \see pathResolver()
+     */
+    void setPathResolver( const QgsPathResolver &resolver ) { mPathResolver = resolver; }
+
     const QgsMapToPixel &mapToPixel() const { return mMapToPixel; }
 
     /**
@@ -423,6 +441,9 @@ class CORE_EXPORT QgsMapSettings
     QgsMapToPixel mMapToPixel;
 
     QgsCoordinateTransformContext mTransformContext;
+
+    QgsPathResolver mPathResolver;
+
 #ifdef QGISDEBUG
     bool mHasTransformContext = false;
 #endif

diff --git a/src/core/qgspallabeling.cpp b/src/core/qgspallabeling.cpp
@@ -2566,8 +2566,8 @@ void QgsPalLayerSettings::parseShapeBackground( QgsRenderContext &context )
     QgsDebugMsgLevel( QString( "exprVal ShapeSVGFile:%1" ).arg( svgfile ), 4 );
 
     // '' empty paths are allowed
-    svgPath = svgfile;
-    dataDefinedValues.insert( QgsPalLayerSettings::ShapeSVGFile, QVariant( svgfile ) );
+    svgPath = QgsSymbolLayerUtils::svgSymbolNameToPath( svgfile, context.pathResolver() );
+    dataDefinedValues.insert( QgsPalLayerSettings::ShapeSVGFile, QVariant( svgPath ) );
   }
 
   // data defined shape size type?

diff --git a/src/core/qgsrendercontext.cpp b/src/core/qgsrendercontext.cpp
@@ -56,6 +56,7 @@ QgsRenderContext::QgsRenderContext( const QgsRenderContext &rh )
   , mSegmentationTolerance( rh.mSegmentationTolerance )
   , mSegmentationToleranceType( rh.mSegmentationToleranceType )
   , mTransformContext( rh.mTransformContext )
+  , mPathResolver( rh.mPathResolver )
 #ifdef QGISDEBUG
   , mHasTransformContext( rh.mHasTransformContext )
 #endif
@@ -82,6 +83,7 @@ QgsRenderContext &QgsRenderContext::operator=( const QgsRenderContext &rh )
   mSegmentationToleranceType = rh.mSegmentationToleranceType;
   mDistanceArea = rh.mDistanceArea;
   mTransformContext = rh.mTransformContext;
+  mPathResolver = rh.mPathResolver;
 #ifdef QGISDEBUG
   mHasTransformContext = rh.mHasTransformContext;
 #endif
@@ -169,6 +171,7 @@ QgsRenderContext QgsRenderContext::fromMapSettings( const QgsMapSettings &mapSet
   ctx.mDistanceArea.setSourceCrs( mapSettings.destinationCrs(), mapSettings.transformContext() );
   ctx.mDistanceArea.setEllipsoid( mapSettings.ellipsoid() );
   ctx.setTransformContext( mapSettings.transformContext() );
+  ctx.setPathResolver( mapSettings.pathResolver() );
   //this flag is only for stopping during the current rendering progress,
   //so must be false at every new render operation
   ctx.setRenderingStopped( false );

diff --git a/src/core/qgsrendercontext.h b/src/core/qgsrendercontext.h
@@ -33,6 +33,7 @@
 #include "qgsvectorsimplifymethod.h"
 #include "qgsdistancearea.h"
 #include "qgscoordinatetransformcontext.h"
+#include "qgspathresolver.h"
 
 class QPainter;
 class QgsAbstractGeometry;
@@ -152,6 +153,24 @@ class CORE_EXPORT QgsRenderContext
      */
     void setTransformContext( const QgsCoordinateTransformContext &context );
 
+    /**
+     * Returns the path resolver for conversion between relative and absolute paths
+     * during rendering operations, e.g. for resolving relative symbol paths.
+     *
+     * \since QGIS 3.0
+     * \see setPathResolver()
+     */
+    const QgsPathResolver &pathResolver() const { return mPathResolver; }
+
+    /**
+     * Sets the path \a resolver for conversion between relative and absolute paths
+     * during rendering operations, e.g. for resolving relative symbol paths.
+     *
+     * \since QGIS 3.0
+     * \see pathResolver()
+     */
+    void setPathResolver( const QgsPathResolver &resolver ) { mPathResolver = resolver; }
+
     const QgsRectangle &extent() const {return mExtent;}
 
     const QgsMapToPixel &mapToPixel() const {return mMapToPixel;}
@@ -420,6 +439,9 @@ class CORE_EXPORT QgsRenderContext
     QgsAbstractGeometry::SegmentationToleranceType mSegmentationToleranceType = QgsAbstractGeometry::MaximumAngle;
 
     QgsCoordinateTransformContext mTransformContext;
+
+    QgsPathResolver mPathResolver;
+
 #ifdef QGISDEBUG
     bool mHasTransformContext = false;
 #endif

diff --git a/src/core/symbology/qgsfillsymbollayer.cpp b/src/core/symbology/qgsfillsymbollayer.cpp
@@ -2188,7 +2188,8 @@ void QgsSVGFillSymbolLayer::applyDataDefinedSettings( QgsSymbolRenderContext &co
   if ( mDataDefinedProperties.isActive( QgsSymbolLayer::PropertyFile ) )
   {
     context.setOriginalValueVariable( mSvgFilePath );
-    svgFile = mDataDefinedProperties.valueAsString( QgsSymbolLayer::PropertyFile, context.renderContext().expressionContext(), mSvgFilePath );
+    svgFile = QgsSymbolLayerUtils::svgSymbolNameToPath( mDataDefinedProperties.valueAsString( QgsSymbolLayer::PropertyFile, context.renderContext().expressionContext(), mSvgFilePath ),
+              context.renderContext().pathResolver() );
   }
   QColor svgFillColor = mColor;
   if ( mDataDefinedProperties.isActive( QgsSymbolLayer::PropertyFillColor ) )

diff --git a/src/core/symbology/qgsmarkersymbollayer.cpp b/src/core/symbology/qgsmarkersymbollayer.cpp
@@ -1978,7 +1978,8 @@ void QgsSvgMarkerSymbolLayer::renderPoint( QPointF point, QgsSymbolRenderContext
   if ( mDataDefinedProperties.isActive( QgsSymbolLayer::PropertyName ) )
   {
     context.setOriginalValueVariable( mPath );
-    path = mDataDefinedProperties.valueAsString( QgsSymbolLayer::PropertyName, context.renderContext().expressionContext(), mPath );
+    path = QgsSymbolLayerUtils::svgSymbolNameToPath( mDataDefinedProperties.valueAsString( QgsSymbolLayer::PropertyName, context.renderContext().expressionContext(), mPath ),
+           context.renderContext().pathResolver() );
   }
 
   double strokeWidth = mStrokeWidth;
@@ -2408,7 +2409,8 @@ bool QgsSvgMarkerSymbolLayer::writeDxf( QgsDxfExport &e, double mmMapUnitScaleFa
   if ( mDataDefinedProperties.isActive( QgsSymbolLayer::PropertyName ) )
   {
     context.setOriginalValueVariable( mPath );
-    path = mDataDefinedProperties.valueAsString( QgsSymbolLayer::PropertyName, context.renderContext().expressionContext(), mPath );
+    path = QgsSymbolLayerUtils::svgSymbolNameToPath( mDataDefinedProperties.valueAsString( QgsSymbolLayer::PropertyName, context.renderContext().expressionContext(), mPath ),
+           context.renderContext().pathResolver() );
   }
 
   double strokeWidth = mStrokeWidth;
@@ -2484,7 +2486,8 @@ QRectF QgsSvgMarkerSymbolLayer::bounds( QPointF point, QgsSymbolRenderContext &c
   if ( mDataDefinedProperties.isActive( QgsSymbolLayer::PropertyName ) )
   {
     context.setOriginalValueVariable( mPath );
-    path = mDataDefinedProperties.valueAsString( QgsSymbolLayer::PropertyName, context.renderContext().expressionContext(), mPath );
+    path = QgsSymbolLayerUtils::svgSymbolNameToPath( mDataDefinedProperties.valueAsString( QgsSymbolLayer::PropertyName, context.renderContext().expressionContext(), mPath ),
+           context.renderContext().pathResolver() );
   }
 
   double strokeWidth = mStrokeWidth;

diff --git a/src/gui/qgsmapcanvas.cpp b/src/gui/qgsmapcanvas.cpp
@@ -503,6 +503,7 @@ void QgsMapCanvas::refreshMap()
                     << new QgsExpressionContextScope( mExpressionContextScope );
 
   mSettings.setExpressionContext( expressionContext );
+  mSettings.setPathResolver( QgsProject::instance()->pathResolver() );
 
   if ( !mTheme.isEmpty() )
   {