Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                              qgsspatialindexkdbushdata.h
       3                 :            :                              -----------------
       4                 :            :     begin                : July 2018
       5                 :            :     copyright            : (C) 2018 by Nyall Dawson
       6                 :            :     email                : nyall dot dawson at gmail dot com
       7                 :            :  ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : 
      18                 :            : #ifndef QGSSPATIALINDEXKDBUSHDATA_H
      19                 :            : #define QGSSPATIALINDEXKDBUSHDATA_H
      20                 :            : 
      21                 :            : #include "qgsfeatureid.h"
      22                 :            : #include "qgspointxy.h"
      23                 :            : 
      24                 :            : /**
      25                 :            :  * \class QgsSpatialIndexKDBushData
      26                 :            :  * \ingroup core
      27                 :            :  *
      28                 :            :  * \brief A container for data stored inside a QgsSpatialIndexKDBush index.
      29                 :            :  *
      30                 :            :  * \since QGIS 3.4
      31                 :            : */
      32                 :          0 : class CORE_EXPORT QgsSpatialIndexKDBushData
      33                 :            : {
      34                 :            :   public:
      35                 :            : 
      36                 :            :     /**
      37                 :            :      * Constructor for QgsSpatialIndexKDBushData, for a feature with the
      38                 :            :      * given \a id and \a x, \a y coordinate.
      39                 :            :      */
      40                 :          0 :     QgsSpatialIndexKDBushData( QgsFeatureId id, double x, double y )
      41                 :          0 :       : coords( std::make_pair( x, y ) )
      42                 :          0 :       , id( id )
      43                 :          0 :     {}
      44                 :            : 
      45                 :            :     /**
      46                 :            :      * Pair of coordinate data.
      47                 :            :      * \note Not available in Python bindings.
      48                 :            :      */
      49                 :            :     std::pair<double, double> coords SIP_SKIP;
      50                 :            : 
      51                 :            :     /**
      52                 :            :      * Returns the indexed point.
      53                 :            :      */
      54                 :          0 :     QgsPointXY point() const
      55                 :            :     {
      56                 :          0 :       return QgsPointXY( coords.first, coords.second );
      57                 :            :     }
      58                 :            : 
      59                 :            :     //! Feature ID
      60                 :            :     QgsFeatureId id;
      61                 :            : };
      62                 :            : 
      63                 :            : #endif // QGSSPATIALINDEXKDBUSHDATA_H