Cleaner API for selecting features in QgsVectorLayer

- add selectByRect( QgsRectangle&, SelectBehaviour) and selectByIds( QgsFeatureIds, SelectBehaviour) for selecting by rect and ids respectively, with options to add to selection/ remove from selection/intersect with current selection - deprecate select( QgsRectangle ) and setSelectedFeatures in favour of new methods - add unit tests
qgis · May 19, 2016 · 23a3a77 · 23a3a77
1 parent 1767d3b
commit 23a3a77
Show file tree

Hide file tree

Showing 16 changed files with 188 additions and 55 deletions.
diff --git a/python/core/qgsvectorlayer.sip b/python/core/qgsvectorlayer.sip
@@ -304,19 +304,42 @@ class QgsVectorLayer : QgsMapLayer
      *
      * @see   invertSelectionInRectangle(QgsRectangle & rect)
      * @see selectByExpression()
+     * @deprecated use selectByRect() instead
      */
-    void select( QgsRectangle & rect, bool addToSelection );
+    void select( QgsRectangle & rect, bool addToSelection ) /Deprecated/;
+
+    /**
+     * Select features found within the search rectangle (in layer's coordinates)
+     * @param rect search rectangle
+     * @param behaviour selection type, allows adding to current selection, removing
+     * from selection, etc.
+     * @see invertSelectionInRectangle(QgsRectangle & rect)
+     * @see selectByExpression()
+     * @see selectByIds()
+     */
+    void selectByRect( QgsRectangle & rect, SelectBehaviour behaviour = SetSelection );
 
     /** Select matching features using an expression.
      * @param expression expression to evaluate to select features
      * @param behaviour selection type, allows adding to current selection, removing
      * from selection, etc.
      * @note added in QGIS 2.16
-     * @see select()
-     * @see modifySelection()
+     * @see selectByRect()
+     * @see selectByIds()
      */
     void selectByExpression( const QString& expression, SelectBehaviour behaviour = SetSelection );
 
+    /** Select matching features using a list of feature IDs. Will emit the
+     * selectionChanged() signal with the clearAndSelect flag set.
+     * @param ids feature IDs to select
+     * @param behaviour selection type, allows adding to current selection, removing
+     * from selection, etc.
+     * @note added in QGIS 2.16
+     * @see selectByRect()
+     * @see selectByExpression()
+     */
+    void selectByIds( const QgsFeatureIds &ids, SelectBehaviour behaviour = SetSelection );
+
     /**
      * Modifies the current selection on this layer
      *
@@ -386,8 +409,9 @@ class QgsVectorLayer : QgsMapLayer
      * clearAndSelect flag set.
      *
      * @param ids   The ids which will be the new selection
+     * @deprecated use selectByIds() instead
      */
-    void setSelectedFeatures( const QgsFeatureIds &ids );
+    void setSelectedFeatures( const QgsFeatureIds &ids ) /Deprecated/;
 
     /** Returns the bounding box of the selected features. If there is no selection, QgsRectangle(0,0,0,0) is returned */
     QgsRectangle boundingBoxOfSelected();

diff --git a/src/app/qgsmaptoolselectutils.cpp b/src/app/qgsmaptoolselectutils.cpp
@@ -221,7 +221,7 @@ void QgsMapToolSelectUtils::setSelectFeatures( QgsMapCanvas* canvas,
   }
   else
   {
-    vlayer->setSelectedFeatures( newSelectedFeatures );
+    vlayer->selectByIds( newSelectedFeatures );
   }
 
   QApplication::restoreOverrideCursor();

diff --git a/src/app/qgsmergeattributesdialog.cpp b/src/app/qgsmergeattributesdialog.cpp
@@ -459,7 +459,7 @@ void QgsMergeAttributesDialog::on_mRemoveFeatureFromSelectionButton_clicked()
   //remove feature from the vector layer selection
   QgsFeatureIds selectedIds = mVectorLayer->selectedFeaturesIds();
   selectedIds.remove( featureId );
-  mVectorLayer->setSelectedFeatures( selectedIds );
+  mVectorLayer->selectByIds( selectedIds );
   mMapCanvas->repaint();
 
   //remove feature option from the combo box (without altering the current merge values)

diff --git a/src/core/qgsvectorlayer.cpp b/src/core/qgsvectorlayer.cpp
@@ -437,32 +437,30 @@ void QgsVectorLayer::deselect( const QgsFeatureIds& featureIds )
 }
 
 void QgsVectorLayer::select( QgsRectangle & rect, bool addToSelection )
+{
+  selectByRect( rect, addToSelection ? AddToSelection : SetSelection );
+}
+
+void QgsVectorLayer::selectByRect( QgsRectangle& rect, QgsVectorLayer::SelectBehaviour behaviour )
 {
   // normalize the rectangle
   rect.normalize();
 
-  //select all the elements
-  QgsFeatureIterator fit = getFeatures( QgsFeatureRequest()
-                                        .setFilterRect( rect )
-                                        .setFlags( QgsFeatureRequest::ExactIntersect | QgsFeatureRequest::NoGeometry )
-                                        .setSubsetOfAttributes( QgsAttributeList() ) );
+  QgsFeatureIds newSelection;
 
-  QgsFeatureIds ids;
+  QgsFeatureIterator features = getFeatures( QgsFeatureRequest()
+                                .setFilterRect( rect )
+                                .setFlags( QgsFeatureRequest::ExactIntersect | QgsFeatureRequest::NoGeometry )
+                                .setSubsetOfAttributes( QgsAttributeList() ) );
 
-  QgsFeature f;
-  while ( fit.nextFeature( f ) )
+  QgsFeature feat;
+  while ( features.nextFeature( feat ) )
   {
-    ids << f.id();
+    newSelection << feat.id();
   }
+  features.close();
 
-  if ( !addToSelection )
-  {
-    setSelectedFeatures( mSelectedFeatureIds + ids );
-  }
-  else
-  {
-    select( ids );
-  }
+  selectByIds( newSelection, behaviour );
 }
 
 void QgsVectorLayer::selectByExpression( const QString& expression, QgsVectorLayer::SelectBehaviour behaviour )
@@ -478,10 +476,8 @@ void QgsVectorLayer::selectByExpression( const QString& expression, QgsVectorLay
   {
     QgsFeatureRequest request = QgsFeatureRequest().setFilterExpression( expression )
                                 .setExpressionContext( context )
-                                .setFlags( QgsFeatureRequest::NoGeometry );
-    //TODO - investigate whether removing all attributes is possible
-    //for now, just set the first attribute
-    request.setSubsetOfAttributes( QgsAttributeList() << 0 );
+                                .setFlags( QgsFeatureRequest::NoGeometry )
+                                .setSubsetOfAttributes( QgsAttributeList() );
 
     QgsFeatureIterator features = getFeatures( request );
 
@@ -527,7 +523,36 @@ void QgsVectorLayer::selectByExpression( const QString& expression, QgsVectorLay
     }
   }
 
-  setSelectedFeatures( newSelection );
+  selectByIds( newSelection );
+}
+
+void QgsVectorLayer::selectByIds( const QgsFeatureIds& ids, QgsVectorLayer::SelectBehaviour behaviour )
+{
+  QgsFeatureIds newSelection;
+
+  switch ( behaviour )
+  {
+    case SetSelection:
+      newSelection = ids;
+      break;
+
+    case AddToSelection:
+      newSelection = mSelectedFeatureIds + ids;
+      break;
+
+    case RemoveFromSelection:
+      newSelection = mSelectedFeatureIds - ids;
+      break;
+
+    case IntersectSelection:
+      newSelection = mSelectedFeatureIds.intersect( ids );
+      break;
+  }
+
+  QgsFeatureIds deselectedFeatures = mSelectedFeatureIds - newSelection;
+  mSelectedFeatureIds = newSelection;
+
+  emit selectionChanged( newSelection, deselectedFeatures, true );
 }
 
 void QgsVectorLayer::modifySelection( QgsFeatureIds selectIds, QgsFeatureIds deselectIds )
@@ -548,12 +573,12 @@ void QgsVectorLayer::invertSelection()
 {
   QgsFeatureIds ids = allFeatureIds();
   ids.subtract( mSelectedFeatureIds );
-  setSelectedFeatures( ids );
+  selectByIds( ids );
 }
 
 void QgsVectorLayer::selectAll()
 {
-  setSelectedFeatures( allFeatureIds() );
+  selectByIds( allFeatureIds() );
 }
 
 QgsFeatureIds QgsVectorLayer::allFeatureIds()
@@ -607,7 +632,7 @@ void QgsVectorLayer::removeSelection()
   if ( mSelectedFeatureIds.isEmpty() )
     return;
 
-  setSelectedFeatures( QgsFeatureIds() );
+  selectByIds( QgsFeatureIds() );
 }
 
 QgsVectorDataProvider* QgsVectorLayer::dataProvider()
@@ -2555,11 +2580,7 @@ bool QgsVectorLayer::rollBack( bool deleteBuffer )
 
 void QgsVectorLayer::setSelectedFeatures( const QgsFeatureIds& ids )
 {
-  QgsFeatureIds deselectedFeatures = mSelectedFeatureIds - ids;
-
-  mSelectedFeatureIds = ids;
-
-  emit selectionChanged( ids, deselectedFeatures, true );
+  selectByIds( ids, SetSelection );
 }
 
 int QgsVectorLayer::selectedFeatureCount()
@@ -2630,7 +2651,7 @@ bool QgsVectorLayer::addFeatures( QgsFeatureList features, bool makeSelected )
     for ( QgsFeatureList::iterator iter = features.begin(); iter != features.end(); ++iter )
       ids << iter->id();
 
-    setSelectedFeatures( ids );
+    selectByIds( ids );
   }
 
   updateExtents();

diff --git a/src/core/qgsvectorlayer.h b/src/core/qgsvectorlayer.h
@@ -667,19 +667,42 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer
      *
      * @see   invertSelectionInRectangle(QgsRectangle & rect)
      * @see selectByExpression()
+     * @deprecated use selectByRect() instead
      */
-    void select( QgsRectangle & rect, bool addToSelection );
+    Q_DECL_DEPRECATED void select( QgsRectangle & rect, bool addToSelection );
+
+    /**
+     * Select features found within the search rectangle (in layer's coordinates)
+     * @param rect search rectangle
+     * @param behaviour selection type, allows adding to current selection, removing
+     * from selection, etc.
+     * @see invertSelectionInRectangle(QgsRectangle & rect)
+     * @see selectByExpression()
+     * @see selectByIds()
+     */
+    void selectByRect( QgsRectangle & rect, SelectBehaviour behaviour = SetSelection );
 
     /** Select matching features using an expression.
      * @param expression expression to evaluate to select features
      * @param behaviour selection type, allows adding to current selection, removing
      * from selection, etc.
      * @note added in QGIS 2.16
-     * @see select()
-     * @see modifySelection()
+     * @see selectByRect()
+     * @see selectByIds()
      */
     void selectByExpression( const QString& expression, SelectBehaviour behaviour = SetSelection );
 
+    /** Select matching features using a list of feature IDs. Will emit the
+     * selectionChanged() signal with the clearAndSelect flag set.
+     * @param ids feature IDs to select
+     * @param behaviour selection type, allows adding to current selection, removing
+     * from selection, etc.
+     * @note added in QGIS 2.16
+     * @see selectByRect()
+     * @see selectByExpression()
+     */
+    void selectByIds( const QgsFeatureIds &ids, SelectBehaviour behaviour = SetSelection );
+
     /**
      * Modifies the current selection on this layer
      *
@@ -749,8 +772,9 @@ class CORE_EXPORT QgsVectorLayer : public QgsMapLayer
      * clearAndSelect flag set.
      *
      * @param ids   The ids which will be the new selection
+     * @deprecated use selectByIds() instead
      */
-    void setSelectedFeatures( const QgsFeatureIds &ids );
+    Q_DECL_DEPRECATED void setSelectedFeatures( const QgsFeatureIds &ids );
 
     /** Returns the bounding box of the selected features. If there is no selection, QgsRectangle(0,0,0,0) is returned */
     QgsRectangle boundingBoxOfSelected();

diff --git a/src/gui/attributetable/qgsvectorlayerselectionmanager.cpp b/src/gui/attributetable/qgsvectorlayerselectionmanager.cpp
@@ -41,7 +41,7 @@ void QgsVectorLayerSelectionManager::deselect( const QgsFeatureIds& ids )
 
 void QgsVectorLayerSelectionManager::setSelectedFeatures( const QgsFeatureIds& ids )
 {
-  mLayer->setSelectedFeatures( ids );
+  mLayer->selectByIds( ids );
 }
 
 const QgsFeatureIds& QgsVectorLayerSelectionManager::selectedFeaturesIds() const

diff --git a/src/plugins/evis/idtool/eviseventidtool.cpp b/src/plugins/evis/idtool/eviseventidtool.cpp
@@ -117,7 +117,7 @@ void eVisEventIdTool::select( const QgsPoint& thePoint )
     newSelectedFeatures.insert( f.id() );
   }
 
-  myLayer->setSelectedFeatures( newSelectedFeatures );
+  myLayer->selectByIds( newSelectedFeatures );
 
   //Launch a new event browser to view selected features
   mBrowser = new eVisGenericEventBrowserGui( mCanvas, mCanvas, nullptr );

diff --git a/src/plugins/geometry_checker/ui/qgsgeometrycheckersetuptab.cpp b/src/plugins/geometry_checker/ui/qgsgeometrycheckersetuptab.cpp
@@ -251,7 +251,7 @@ void QgsGeometryCheckerSetupTab::runChecks()
       newlayer->dataProvider()->addFeatures( features );
 
       // Set selected features
-      newlayer->setSelectedFeatures( selectedFeatures );
+      newlayer->selectByIds( selectedFeatures );
     }
     layer = newlayer;
   }

diff --git a/src/plugins/geometry_checker/utils/qgsfeaturepool.cpp b/src/plugins/geometry_checker/utils/qgsfeaturepool.cpp
@@ -86,7 +86,7 @@ void QgsFeaturePool::addFeature( QgsFeature& feature )
   {
     QgsFeatureIds selectedFeatureIds = mLayer->selectedFeaturesIds();
     selectedFeatureIds.insert( feature.id() );
-    mLayer->setSelectedFeatures( selectedFeatureIds );
+    mLayer->selectByIds( selectedFeatureIds );
   }
   mLayerMutex.unlock();
   mIndexMutex.lock();

diff --git a/src/plugins/geometry_snapper/qgsgeometrysnapperdialog.cpp b/src/plugins/geometry_snapper/qgsgeometrysnapperdialog.cpp
@@ -249,7 +249,7 @@ void QgsGeometrySnapperDialog::run()
       newlayer->dataProvider()->addFeatures( features );
 
       // Set selected features
-      newlayer->setSelectedFeatures( selectedFeatures );
+      newlayer->selectByIds( selectedFeatures );
     }
     layer = newlayer;
   }

diff --git a/src/plugins/spatialquery/qgsspatialquerydialog.cpp b/src/plugins/spatialquery/qgsspatialquerydialog.cpp
@@ -238,13 +238,13 @@ void QgsSpatialQueryDialog::showResultQuery( QDateTime *datetimeStart, QDateTime
     switch ( typeResultFor )
     {
       case selectedNew:
-        mLayerTarget->setSelectedFeatures( mFeatureResult );
+        mLayerTarget->selectByIds( mFeatureResult );
         break;
       case selectedAdd:
-        mLayerTarget->setSelectedFeatures( mLayerTarget->selectedFeaturesIds() + mFeatureResult );
+        mLayerTarget->selectByIds( mLayerTarget->selectedFeaturesIds() + mFeatureResult );
         break;
       case selectedRemove:
-        mLayerTarget->setSelectedFeatures( mLayerTarget->selectedFeaturesIds() - mFeatureResult );
+        mLayerTarget->selectByIds( mLayerTarget->selectedFeaturesIds() - mFeatureResult );
         break;
       default:
         return;

diff --git a/src/server/qgswfsserver.cpp b/src/server/qgswfsserver.cpp
@@ -1673,7 +1673,7 @@ QDomDocument QgsWFSServer::transaction( const QString& requestBody )
           }
 #endif
 
-          layer->setSelectedFeatures( fids );
+          layer->selectByIds( fids );
           layer->deleteSelectedFeatures();
         }
       }

diff --git a/src/server/qgswmsserver.cpp b/src/server/qgswmsserver.cpp
@@ -2802,7 +2802,7 @@ QStringList QgsWMSServer::applyFeatureSelections( const QStringList& layerList )
       selectedIds.insert( STRING_TO_FID( id ) );
     }
 
-    vLayer->setSelectedFeatures( selectedIds );
+    vLayer->selectByIds( selectedIds );
   }
 
 
@@ -2819,7 +2819,7 @@ void QgsWMSServer::clearFeatureSelections( const QStringList& layerIds ) const
     if ( !layer )
       continue;
 
-    layer->setSelectedFeatures( QgsFeatureIds() );
+    layer->selectByIds( QgsFeatureIds() );
   }
 
   return;

diff --git a/tests/src/core/testqgsvectorlayer.cpp b/tests/src/core/testqgsvectorlayer.cpp
@@ -222,7 +222,7 @@ void TestQgsVectorLayer::QgsVectorLayerGetValues()
   //make a selection
   QgsFeatureIds ids;
   ids << f2.id() << f3.id();
-  layer->setSelectedFeatures( ids );
+  layer->selectByIds( ids );
 
   bool ok;
   QList<QVariant> varList = layer->getValues( "col1", ok );

diff --git a/tests/src/gui/testqgsdualview.cpp b/tests/src/gui/testqgsdualview.cpp
@@ -137,7 +137,7 @@ void TestQgsDualView::testSelectAll()
   mDualView->mTableView->selectAll();
   QVERIFY( mPointsLayer->selectedFeatureCount() == 10 );
 
-  mPointsLayer->setSelectedFeatures( QgsFeatureIds() );
+  mPointsLayer->selectByIds( QgsFeatureIds() );
   mCanvas->setExtent( QgsRectangle( -110, 40, -100, 48 ) );
   mDualView->mTableView->selectAll();
   QVERIFY( mPointsLayer->selectedFeatureCount() == 1 );