Fix "feature rendering order" checkbox is not honored (fix #14323)

nyalldawson · nyalldawson · commit 4285d70b6c85 · 2016-02-19T10:11:43.000+11:00
diff --git a/python/core/symbology-ng/qgsrendererv2.sip b/python/core/symbology-ng/qgsrendererv2.sip
@@ -352,15 +352,36 @@ class QgsFeatureRendererV2
     /**
      * Get the order in which features shall be processed by this renderer.
      * @note added in QGIS 2.14
+     * @note this property has no effect if orderByEnabled() is false
+     * @see orderByEnabled()
      */
     QgsFeatureRequest::OrderBy orderBy() const;
 
     /**
      * Define the order in which features shall be processed by this renderer.
+     * @note this property has no effect if orderByEnabled() is false
      * @note added in QGIS 2.14
+     * @see setOrderByEnabled()
      */
     void setOrderBy( const QgsFeatureRequest::OrderBy& orderBy );
 
+    /**
+     * Returns whether custom ordering will be applied before features are processed by this renderer.
+     * @note added in QGIS 2.14
+     * @see orderBy()
+     * @see setOrderByEnabled()
+     */
+    bool orderByEnabled() const;
+
+    /**
+     * Sets whether custom ordering should be applied before features are processed by this renderer.
+     * @param enabled set to true to enable custom feature ordering
+     * @note added in QGIS 2.14
+     * @see setOrderBy()
+     * @see orderByEnabled()
+     */
+    void setOrderByEnabled( bool enabled );
+
   protected:
     QgsFeatureRendererV2( const QString& type );
 
diff --git a/src/core/qgsvectorlayerrenderer.cpp b/src/core/qgsvectorlayerrenderer.cpp
@@ -150,13 +150,14 @@ bool QgsVectorLayerRenderer::render()
   QgsRectangle requestExtent = mContext.extent();
   mRendererV2->modifyRequestExtent( requestExtent, mContext );
 
-  QgsFeatureRequest::OrderBy orderBy = mRendererV2->orderBy();
-
   QgsFeatureRequest featureRequest = QgsFeatureRequest()
                                      .setFilterRect( requestExtent )
                                      .setSubsetOfAttributes( mAttrNames, mFields )
-                                     .setExpressionContext( mContext.expressionContext() )
-                                     .setOrderBy( orderBy );
+                                     .setExpressionContext( mContext.expressionContext() );
+  if ( mRendererV2->orderByEnabled() )
+  {
+    featureRequest.setOrderBy( mRendererV2->orderBy() );
+  }
 
   const QgsFeatureFilterProvider* featureFilterProvider = mContext.featureFilterProvider();
   if ( featureFilterProvider )
diff --git a/src/core/symbology-ng/qgscategorizedsymbolrendererv2.cpp b/src/core/symbology-ng/qgscategorizedsymbolrendererv2.cpp
@@ -784,6 +784,7 @@ QDomElement QgsCategorizedSymbolRendererV2::save( QDomDocument& doc )
     mOrderBy.save( orderBy );
     rendererElem.appendChild( orderBy );
   }
+  rendererElem.setAttribute( "enableorderby", ( mOrderByEnabled ? "1" : "0" ) );
 
   return rendererElem;
 }
@@ -1052,6 +1053,7 @@ QgsCategorizedSymbolRendererV2* QgsCategorizedSymbolRendererV2::convertFromRende
   }
 
   r->setOrderBy( renderer->orderBy() );
+  r->setOrderByEnabled( renderer->orderByEnabled() );
 
   return r;
 }
diff --git a/src/core/symbology-ng/qgsgraduatedsymbolrendererv2.cpp b/src/core/symbology-ng/qgsgraduatedsymbolrendererv2.cpp
@@ -1201,6 +1201,7 @@ QDomElement QgsGraduatedSymbolRendererV2::save( QDomDocument& doc )
     mOrderBy.save( orderBy );
     rendererElem.appendChild( orderBy );
   }
+  rendererElem.setAttribute( "enableorderby", ( mOrderByEnabled ? "1" : "0" ) );
 
   return rendererElem;
 }
@@ -1745,6 +1746,7 @@ QgsGraduatedSymbolRendererV2* QgsGraduatedSymbolRendererV2::convertFromRenderer(
   }
 
   r->setOrderBy( renderer->orderBy() );
+  r->setOrderByEnabled( renderer->orderByEnabled() );
 
   return r;
 }
diff --git a/src/core/symbology-ng/qgsheatmaprenderer.cpp b/src/core/symbology-ng/qgsheatmaprenderer.cpp
@@ -361,6 +361,7 @@ QDomElement QgsHeatmapRenderer::save( QDomDocument& doc )
     rendererElem.appendChild( colorRampElem );
   }
   rendererElem.setAttribute( "invert_ramp", QString::number( mInvertRamp ) );
+  rendererElem.setAttribute( "forceraster", ( mForceRaster ? "1" : "0" ) );
 
   if ( mPaintEffect && !QgsPaintEffectRegistry::isDefaultStack( mPaintEffect ) )
     mPaintEffect->saveProperties( doc, rendererElem );
@@ -371,6 +372,7 @@ QDomElement QgsHeatmapRenderer::save( QDomDocument& doc )
     mOrderBy.save( orderBy );
     rendererElem.appendChild( orderBy );
   }
+  rendererElem.setAttribute( "enableorderby", ( mOrderByEnabled ? "1" : "0" ) );
 
   return rendererElem;
 }
diff --git a/src/core/symbology-ng/qgsinvertedpolygonrenderer.cpp b/src/core/symbology-ng/qgsinvertedpolygonrenderer.cpp
@@ -385,6 +385,7 @@ QDomElement QgsInvertedPolygonRenderer::save( QDomDocument& doc )
     mOrderBy.save( orderBy );
     rendererElem.appendChild( orderBy );
   }
+  rendererElem.setAttribute( "enableorderby", ( mOrderByEnabled ? "1" : "0" ) );
 
   return rendererElem;
 }
diff --git a/src/core/symbology-ng/qgspointdisplacementrenderer.cpp b/src/core/symbology-ng/qgspointdisplacementrenderer.cpp
@@ -426,6 +426,7 @@ QDomElement QgsPointDisplacementRenderer::save( QDomDocument& doc )
     mOrderBy.save( orderBy );
     rendererElement.appendChild( orderBy );
   }
+  rendererElement.setAttribute( "enableorderby", ( mOrderByEnabled ? "1" : "0" ) );
 
   return rendererElement;
 }
diff --git a/src/core/symbology-ng/qgsrendererv2.cpp b/src/core/symbology-ng/qgsrendererv2.cpp
@@ -195,6 +195,7 @@ void QgsFeatureRendererV2::copyRendererData( QgsFeatureRendererV2* destRenderer
 
   destRenderer->setPaintEffect( mPaintEffect->clone() );
   destRenderer->mOrderBy = mOrderBy;
+  destRenderer->mOrderByEnabled = mOrderByEnabled;
 }
 
 void QgsFeatureRendererV2::copyPaintEffect( QgsFeatureRendererV2 *destRenderer ) const
@@ -212,6 +213,7 @@ QgsFeatureRendererV2::QgsFeatureRendererV2( const QString& type )
     , mCurrentVertexMarkerSize( 3 )
     , mPaintEffect( nullptr )
     , mForceRaster( false )
+    , mOrderByEnabled( false )
 {
   mPaintEffect = QgsPaintEffectRegistry::defaultStack();
   mPaintEffect->setEnabled( false );
@@ -334,6 +336,7 @@ QgsFeatureRendererV2* QgsFeatureRendererV2::load( QDomElement& element )
     // restore order by
     QDomElement orderByElem = element.firstChildElement( "orderby" );
     r->mOrderBy.load( orderByElem );
+    r->setOrderByEnabled( element.attribute( "enableorderby", "0" ).toInt() );
   }
   return r;
 }
@@ -353,6 +356,7 @@ QDomElement QgsFeatureRendererV2::save( QDomDocument& doc )
     mOrderBy.save( orderBy );
     rendererElem.appendChild( orderBy );
   }
+  rendererElem.setAttribute( "enableorderby", ( mOrderByEnabled ? "1" : "0" ) );
   return rendererElem;
 }
 
@@ -617,6 +621,16 @@ void QgsFeatureRendererV2::setOrderBy( const QgsFeatureRequest::OrderBy& orderBy
   mOrderBy = orderBy;
 }
 
+bool QgsFeatureRendererV2::orderByEnabled() const
+{
+  return mOrderByEnabled;
+}
+
+void QgsFeatureRendererV2::setOrderByEnabled( bool enabled )
+{
+  mOrderByEnabled = enabled;
+}
+
 void QgsFeatureRendererV2::convertSymbolSizeScale( QgsSymbolV2 * symbol, QgsSymbolV2::ScaleMethod method, const QString & field )
 {
   if ( symbol->type() == QgsSymbolV2::Marker )
diff --git a/src/core/symbology-ng/qgsrendererv2.h b/src/core/symbology-ng/qgsrendererv2.h
@@ -375,15 +375,36 @@ class CORE_EXPORT QgsFeatureRendererV2
     /**
      * Get the order in which features shall be processed by this renderer.
      * @note added in QGIS 2.14
+     * @note this property has no effect if orderByEnabled() is false
+     * @see orderByEnabled()
      */
     QgsFeatureRequest::OrderBy orderBy() const;
 
     /**
      * Define the order in which features shall be processed by this renderer.
+     * @note this property has no effect if orderByEnabled() is false
      * @note added in QGIS 2.14
+     * @see setOrderByEnabled()
      */
     void setOrderBy( const QgsFeatureRequest::OrderBy& orderBy );
 
+    /**
+     * Returns whether custom ordering will be applied before features are processed by this renderer.
+     * @note added in QGIS 2.14
+     * @see orderBy()
+     * @see setOrderByEnabled()
+     */
+    bool orderByEnabled() const;
+
+    /**
+     * Sets whether custom ordering should be applied before features are processed by this renderer.
+     * @param enabled set to true to enable custom feature ordering
+     * @note added in QGIS 2.14
+     * @see setOrderBy()
+     * @see orderByEnabled()
+     */
+    void setOrderByEnabled( bool enabled );
+
   protected:
     QgsFeatureRendererV2( const QString& type );
 
@@ -447,6 +468,8 @@ class CORE_EXPORT QgsFeatureRendererV2
 
     QgsFeatureRequest::OrderBy mOrderBy;
 
+    bool mOrderByEnabled;
+
   private:
     Q_DISABLE_COPY( QgsFeatureRendererV2 )
 };
diff --git a/src/core/symbology-ng/qgsrulebasedrendererv2.cpp b/src/core/symbology-ng/qgsrulebasedrendererv2.cpp
@@ -993,6 +993,7 @@ QDomElement QgsRuleBasedRendererV2::save( QDomDocument& doc )
     mOrderBy.save( orderBy );
     rendererElem.appendChild( orderBy );
   }
+  rendererElem.setAttribute( "enableorderby", ( mOrderByEnabled ? "1" : "0" ) );
 
   return rendererElem;
 }
diff --git a/src/core/symbology-ng/qgssinglesymbolrendererv2.cpp b/src/core/symbology-ng/qgssinglesymbolrendererv2.cpp
@@ -387,6 +387,8 @@ QDomElement QgsSingleSymbolRendererV2::save( QDomDocument& doc )
     mOrderBy.save( orderBy );
     rendererElem.appendChild( orderBy );
   }
+  rendererElem.setAttribute( "enableorderby", ( mOrderByEnabled ? "1" : "0" ) );
+
   return rendererElem;
 }
 
@@ -481,6 +483,7 @@ QgsSingleSymbolRendererV2* QgsSingleSymbolRendererV2::convertFromRenderer( const
   if ( r )
   {
     r->setOrderBy( renderer->orderBy() );
+    r->setOrderByEnabled( renderer->orderByEnabled() );
   }
 
   return r;
diff --git a/src/gui/symbology-ng/qgsrendererv2propertiesdialog.cpp b/src/gui/symbology-ng/qgsrendererv2propertiesdialog.cpp
@@ -136,15 +136,15 @@ QgsRendererV2PropertiesDialog::QgsRendererV2PropertiesDialog( QgsVectorLayer* la
   // setup slot rendererChanged()
   connect( cboRenderers, SIGNAL( currentIndexChanged( int ) ), this, SLOT( rendererChanged() ) );
   //setup order by
-  if ( mOrderBy.isEmpty() )
+  if ( mLayer->rendererV2()->orderByEnabled() )
   {
-    btnOrderBy->setEnabled( false );
-    checkboxEnableOrderBy->setChecked( false );
-    lineEditOrderBy->setEnabled( false );
+    checkboxEnableOrderBy->setChecked( true );
   }
   else
   {
-    checkboxEnableOrderBy->setChecked( true );
+    btnOrderBy->setEnabled( false );
+    checkboxEnableOrderBy->setChecked( false );
+    lineEditOrderBy->setEnabled( false );
   }
   lineEditOrderBy->setReadOnly( true );
   connect( checkboxEnableOrderBy, SIGNAL( toggled( bool ) ), btnOrderBy, SLOT( setEnabled( bool ) ) );
@@ -222,7 +222,7 @@ void QgsRendererV2PropertiesDialog::rendererChanged()
     {
       if ( mMapCanvas )
         mActiveWidget->setMapCanvas( mMapCanvas );
-      changeOrderBy( mActiveWidget->renderer()->orderBy() );
+      changeOrderBy( mActiveWidget->renderer()->orderBy(), mActiveWidget->renderer()->orderByEnabled() );
       connect( mActiveWidget, SIGNAL( layerVariablesChanged() ), this, SIGNAL( layerVariablesChanged() ) );
     }
   }
@@ -248,6 +248,7 @@ void QgsRendererV2PropertiesDialog::apply()
     renderer->setPaintEffect( mPaintEffect->clone() );
     // set the order by
     renderer->setOrderBy( mOrderBy );
+    renderer->setOrderByEnabled( checkboxEnableOrderBy->isChecked() );
 
     mLayer->setRendererV2( renderer->clone() );
   }
@@ -278,11 +279,11 @@ void QgsRendererV2PropertiesDialog::showOrderByDialog()
   }
 }
 
-void QgsRendererV2PropertiesDialog::changeOrderBy( const QgsFeatureRequest::OrderBy& orderBy )
+void QgsRendererV2PropertiesDialog::changeOrderBy( const QgsFeatureRequest::OrderBy& orderBy, bool orderByEnabled )
 {
   mOrderBy = orderBy;
   lineEditOrderBy->setText( mOrderBy.dump() );
-  checkboxEnableOrderBy->setChecked( !orderBy.isEmpty() );
+  checkboxEnableOrderBy->setChecked( orderByEnabled );
 }
 
 
diff --git a/src/gui/symbology-ng/qgsrendererv2propertiesdialog.h b/src/gui/symbology-ng/qgsrendererv2propertiesdialog.h
@@ -65,7 +65,7 @@ class GUI_EXPORT QgsRendererV2PropertiesDialog : public QDialog, private Ui::Qgs
   private slots:
     void showOrderByDialog();
 
-    void changeOrderBy( const QgsFeatureRequest::OrderBy& orderBy );
+    void changeOrderBy( const QgsFeatureRequest::OrderBy& orderBy, bool orderByEnabled );
 
   protected:
 
diff --git a/tests/src/python/test_qgssinglesymbolrenderer.py b/tests/src/python/test_qgssinglesymbolrenderer.py
@@ -81,14 +81,19 @@ def tearDown(self):
 
     def testOrderBy(self):
         self.renderer.setOrderBy(QgsFeatureRequest.OrderBy([QgsFeatureRequest.OrderByClause('Value', False)]))
+        self.renderer.setOrderByEnabled(True)
 
         # Setup rendering check
         renderchecker = QgsMultiRenderChecker()
         renderchecker.setMapSettings(self.mapsettings)
         renderchecker.setControlName('expected_singlesymbol_orderby')
         result = renderchecker.runTest('singlesymbol_orderby')
-
         assert result
 
+        # disable order by and retest
+        self.renderer.setOrderByEnabled(False)
+        result = renderchecker.runTest('single')
+
+
 if __name__ == '__main__':
     unittest.main()

Original file line number	Diff line number	Diff line change
`@@ -784,6 +784,7 @@ QDomElement QgsCategorizedSymbolRendererV2::save( QDomDocument& doc )`
`784`	`784`	`mOrderBy.save( orderBy );`
`785`	`785`	`rendererElem.appendChild( orderBy );`
`786`	`786`	`}`
	`787`	`+ rendererElem.setAttribute( "enableorderby", ( mOrderByEnabled ? "1" : "0" ) );`
`787`	`788`
`788`	`789`	`return rendererElem;`
`789`	`790`	`}`
`@@ -1052,6 +1053,7 @@ QgsCategorizedSymbolRendererV2* QgsCategorizedSymbolRendererV2::convertFromRende`
`1052`	`1053`	`}`
`1053`	`1054`
`1054`	`1055`	`r->setOrderBy( renderer->orderBy() );`
	`1056`	`+ r->setOrderByEnabled( renderer->orderByEnabled() );`
`1055`	`1057`
`1056`	`1058`	`return r;`
`1057`	`1059`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1201,6 +1201,7 @@ QDomElement QgsGraduatedSymbolRendererV2::save( QDomDocument& doc )`
`1201`	`1201`	`mOrderBy.save( orderBy );`
`1202`	`1202`	`rendererElem.appendChild( orderBy );`
`1203`	`1203`	`}`
	`1204`	`+ rendererElem.setAttribute( "enableorderby", ( mOrderByEnabled ? "1" : "0" ) );`
`1204`	`1205`
`1205`	`1206`	`return rendererElem;`
`1206`	`1207`	`}`
`@@ -1745,6 +1746,7 @@ QgsGraduatedSymbolRendererV2* QgsGraduatedSymbolRendererV2::convertFromRenderer(`
`1745`	`1746`	`}`
`1746`	`1747`
`1747`	`1748`	`r->setOrderBy( renderer->orderBy() );`
	`1749`	`+ r->setOrderByEnabled( renderer->orderByEnabled() );`
`1748`	`1750`
`1749`	`1751`	`return r;`
`1750`	`1752`	`}`
Original file line number	Diff line number	Diff line change
`@@ -361,6 +361,7 @@ QDomElement QgsHeatmapRenderer::save( QDomDocument& doc )`
`361`	`361`	`rendererElem.appendChild( colorRampElem );`
`362`	`362`	`}`
`363`	`363`	`rendererElem.setAttribute( "invert_ramp", QString::number( mInvertRamp ) );`
	`364`	`+ rendererElem.setAttribute( "forceraster", ( mForceRaster ? "1" : "0" ) );`
`364`	`365`
`365`	`366`	`if ( mPaintEffect && !QgsPaintEffectRegistry::isDefaultStack( mPaintEffect ) )`
`366`	`367`	`mPaintEffect->saveProperties( doc, rendererElem );`
`@@ -371,6 +372,7 @@ QDomElement QgsHeatmapRenderer::save( QDomDocument& doc )`
`371`	`372`	`mOrderBy.save( orderBy );`
`372`	`373`	`rendererElem.appendChild( orderBy );`
`373`	`374`	`}`
	`375`	`+ rendererElem.setAttribute( "enableorderby", ( mOrderByEnabled ? "1" : "0" ) );`
`374`	`376`
`375`	`377`	`return rendererElem;`
`376`	`378`	`}`
Original file line number	Diff line number	Diff line change
`@@ -385,6 +385,7 @@ QDomElement QgsInvertedPolygonRenderer::save( QDomDocument& doc )`
`385`	`385`	`mOrderBy.save( orderBy );`
`386`	`386`	`rendererElem.appendChild( orderBy );`
`387`	`387`	`}`
	`388`	`+ rendererElem.setAttribute( "enableorderby", ( mOrderByEnabled ? "1" : "0" ) );`
`388`	`389`
`389`	`390`	`return rendererElem;`
`390`	`391`	`}`
Original file line number	Diff line number	Diff line change
`@@ -426,6 +426,7 @@ QDomElement QgsPointDisplacementRenderer::save( QDomDocument& doc )`
`426`	`426`	`mOrderBy.save( orderBy );`
`427`	`427`	`rendererElement.appendChild( orderBy );`
`428`	`428`	`}`
	`429`	`+ rendererElement.setAttribute( "enableorderby", ( mOrderByEnabled ? "1" : "0" ) );`
`429`	`430`
`430`	`431`	`return rendererElement;`
`431`	`432`	`}`
Original file line number	Diff line number	Diff line change
`@@ -195,6 +195,7 @@ void QgsFeatureRendererV2::copyRendererData( QgsFeatureRendererV2* destRenderer`
`195`	`195`
`196`	`196`	`destRenderer->setPaintEffect( mPaintEffect->clone() );`
`197`	`197`	`destRenderer->mOrderBy = mOrderBy;`
	`198`	`+ destRenderer->mOrderByEnabled = mOrderByEnabled;`
`198`	`199`	`}`
`199`	`200`
`200`	`201`	`void QgsFeatureRendererV2::copyPaintEffect( QgsFeatureRendererV2 *destRenderer ) const`
`@@ -212,6 +213,7 @@ QgsFeatureRendererV2::QgsFeatureRendererV2( const QString& type )`
`212`	`213`	`, mCurrentVertexMarkerSize( 3 )`
`213`	`214`	`, mPaintEffect( nullptr )`
`214`	`215`	`, mForceRaster( false )`
	`216`	`+ , mOrderByEnabled( false )`
`215`	`217`	`{`
`216`	`218`	`mPaintEffect = QgsPaintEffectRegistry::defaultStack();`
`217`	`219`	`mPaintEffect->setEnabled( false );`
`@@ -334,6 +336,7 @@ QgsFeatureRendererV2* QgsFeatureRendererV2::load( QDomElement& element )`
`334`	`336`	`// restore order by`
`335`	`337`	`QDomElement orderByElem = element.firstChildElement( "orderby" );`
`336`	`338`	`r->mOrderBy.load( orderByElem );`
	`339`	`+ r->setOrderByEnabled( element.attribute( "enableorderby", "0" ).toInt() );`
`337`	`340`	`}`
`338`	`341`	`return r;`
`339`	`342`	`}`
`@@ -353,6 +356,7 @@ QDomElement QgsFeatureRendererV2::save( QDomDocument& doc )`
`353`	`356`	`mOrderBy.save( orderBy );`
`354`	`357`	`rendererElem.appendChild( orderBy );`
`355`	`358`	`}`
	`359`	`+ rendererElem.setAttribute( "enableorderby", ( mOrderByEnabled ? "1" : "0" ) );`
`356`	`360`	`return rendererElem;`
`357`	`361`	`}`
`358`	`362`
`@@ -617,6 +621,16 @@ void QgsFeatureRendererV2::setOrderBy( const QgsFeatureRequest::OrderBy& orderBy`
`617`	`621`	`mOrderBy = orderBy;`
`618`	`622`	`}`
`619`	`623`
	`624`	`+bool QgsFeatureRendererV2::orderByEnabled() const`
	`625`	`+{`
	`626`	`+ return mOrderByEnabled;`
	`627`	`+}`
	`628`	`+`
	`629`	`+void QgsFeatureRendererV2::setOrderByEnabled( bool enabled )`
	`630`	`+{`
	`631`	`+ mOrderByEnabled = enabled;`
	`632`	`+}`
	`633`	`+`
`620`	`634`	`void QgsFeatureRendererV2::convertSymbolSizeScale( QgsSymbolV2 * symbol, QgsSymbolV2::ScaleMethod method, const QString & field )`
`621`	`635`	`{`
`622`	`636`	`if ( symbol->type() == QgsSymbolV2::Marker )`
Original file line number	Diff line number	Diff line change
`@@ -993,6 +993,7 @@ QDomElement QgsRuleBasedRendererV2::save( QDomDocument& doc )`
`993`	`993`	`mOrderBy.save( orderBy );`
`994`	`994`	`rendererElem.appendChild( orderBy );`
`995`	`995`	`}`
	`996`	`+ rendererElem.setAttribute( "enableorderby", ( mOrderByEnabled ? "1" : "0" ) );`
`996`	`997`
`997`	`998`	`return rendererElem;`
`998`	`999`	`}`