Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :     qgsgeometrycheckcontext.h
       3                 :            :     ---------------------
       4                 :            :     begin                : September 2018
       5                 :            :     copyright            : (C) 2018 Matthias Kuhn
       6                 :            :     email                : matthias@opengis.ch
       7                 :            :  ***************************************************************************
       8                 :            :  *                                                                         *
       9                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      10                 :            :  *   it under the terms of the GNU General Public License as published by  *
      11                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      12                 :            :  *   (at your option) any later version.                                   *
      13                 :            :  *                                                                         *
      14                 :            :  ***************************************************************************/
      15                 :            : 
      16                 :            : #ifndef QGSGEOMETRYCHECKCONTEXT_H
      17                 :            : #define QGSGEOMETRYCHECKCONTEXT_H
      18                 :            : 
      19                 :            : #include "qgis_analysis.h"
      20                 :            : #include "qgscoordinatereferencesystem.h"
      21                 :            : #include "qgscoordinatetransformcontext.h"
      22                 :            : #include "qgsfeaturepool.h"
      23                 :            : 
      24                 :            : /**
      25                 :            :  * \ingroup analysis
      26                 :            :  * \brief Base configuration for geometry checks.
      27                 :            :  *
      28                 :            :  * \note This class is a technology preview and unstable API.
      29                 :            :  * \since QGIS 3.4
      30                 :            :  */
      31                 :         25 : class ANALYSIS_EXPORT QgsGeometryCheckContext
      32                 :            : {
      33                 :            :   public:
      34                 :            : 
      35                 :            :     /**
      36                 :            :      * Creates a new QgsGeometryCheckContext.
      37                 :            :      */
      38                 :            :     QgsGeometryCheckContext( int precision,
      39                 :            :                              const QgsCoordinateReferenceSystem &mapCrs,
      40                 :            :                              const QgsCoordinateTransformContext &transformContext,
      41                 :            :                              const QgsProject *mProject );
      42                 :            : 
      43                 :            :     /**
      44                 :            :      * The tolerance to allow for in geometry checks.
      45                 :            :      * Will be calculated as pow(10, -precision) in the constructor.
      46                 :            :      * I.e. if the precision is 4 (decimal digits), this will be 0.0001.
      47                 :            :      */
      48                 :            :     const double tolerance;
      49                 :            : 
      50                 :            :     /**
      51                 :            :      * The tolerance to allow for in geometry checks.
      52                 :            :      * Will be calculated as pow(10, -precision/2) in the constructor.
      53                 :            :      * I.e. if the precision is 4 (decimal digits), this will be 0.01.
      54                 :            :      * Should be used for areas, where the precision is squared.
      55                 :            :      */
      56                 :            :     const double reducedTolerance;
      57                 :            : 
      58                 :            :     /**
      59                 :            :      * The coordinate system in which calculations should be done.
      60                 :            :      */
      61                 :            :     const QgsCoordinateReferenceSystem mapCrs;
      62                 :            : 
      63                 :            :     /**
      64                 :            :      * The coordinate transform context with which transformations will be done.
      65                 :            :      */
      66                 :            :     const QgsCoordinateTransformContext transformContext;
      67                 :            : 
      68                 :            :     /**
      69                 :            :      * The project can be used to resolve additional layers.
      70                 :            :      *
      71                 :            :      * This must only be accessed from the main thread (i.e. do not access from the collectError method)
      72                 :            :      *
      73                 :            :      * \since QGIS 3.10
      74                 :            :      */
      75                 :            :     const QgsProject *project() const;
      76                 :            : 
      77                 :            :   private:
      78                 :            :     const QgsProject *mProject;
      79                 :            : 
      80                 :            :   private:
      81                 :            : #ifdef SIP_RUN
      82                 :            :     QgsGeometryCheckContext( const QgsGeometryCheckContext &rh )
      83                 :            :     {}
      84                 :            : #endif
      85                 :            : };
      86                 :            : 
      87                 :            : #endif // QGSGEOMETRYCHECKCONTEXT_H