qgssnappingconfig.h

Go to the documentation of this file.

/***************************************************************************
  qgssnappingconfig.h - QgsSnappingConfig
 
 ---------------------
 begin                : 29.8.2016
 copyright            : (C) 2016 by Denis Rouzaud
 email                : [email protected]
 ***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSPROJECTSNAPPINGSETTINGS_H
#define QGSPROJECTSNAPPINGSETTINGS_H
 
#include <QHash>
#include "qgis_core.h"
#include "qgstolerance.h"
 
class QDomDocument;
class QgsProject;
class QgsVectorLayer;
 
 
class CORE_EXPORT QgsSnappingConfig
{
    Q_GADGET
 
    Q_PROPERTY( QgsProject *project READ project WRITE setProject )
 
  public:
 
    enum SnappingMode
    {
      ActiveLayer = 1, 
      AllLayers = 2, 
      AdvancedConfiguration = 3, 
    };
    Q_ENUM( SnappingMode )
 
    
    enum SnappingType
    {
      Vertex = 1, 
      VertexAndSegment = 2, 
      Segment = 3, 
    };
    // TODO QGIS 4: remove
    // this could not be tagged with Q_DECL_DEPRECATED due to Doxygen warning
    // might be fixed in newer Doxygen (does not on 1.8.15, might be ok on 1.8.16)
 
    enum SnappingTypes
    {
      NoSnapFlag = 0, 
      VertexFlag = 1, 
      SegmentFlag = 2, 
      AreaFlag = 4, 
      CentroidFlag = 8, 
      MiddleOfSegmentFlag = 16, 
    };
    Q_ENUM( SnappingTypes )
    Q_DECLARE_FLAGS( SnappingTypeFlag, SnappingTypes )
    Q_FLAG( SnappingTypeFlag )
 
    
    enum ScaleDependencyMode
    {
      Disabled = 0,
      Global = 1,
      PerLayer = 2
    };
    Q_ENUM( ScaleDependencyMode )
 
    
    static const QString snappingTypeFlagToString( SnappingTypeFlag type )
    {
      switch ( type )
      {
        case QgsSnappingConfig::NoSnapFlag: return QObject::tr( "No Snapping" );
        case QgsSnappingConfig::VertexFlag: return QObject::tr( "Vertex" );
        case QgsSnappingConfig::SegmentFlag: return QObject::tr( "Segment" );
        case QgsSnappingConfig::AreaFlag: return QObject::tr( "Area" );
        case QgsSnappingConfig::CentroidFlag: return QObject::tr( "Centroid" );
        case QgsSnappingConfig::MiddleOfSegmentFlag: return QObject::tr( "Middle of Segments" );
      }
      return QString();
    }
 
 
    class CORE_EXPORT IndividualLayerSettings
    {
      public:
 
        Q_DECL_DEPRECATED IndividualLayerSettings( bool enabled, SnappingType type, double tolerance, QgsTolerance::UnitType units ) SIP_DEPRECATED;
 
        IndividualLayerSettings( bool enabled, SnappingTypeFlag type, double tolerance, QgsTolerance::UnitType units, double minScale = 0.0, double maxScale = 0.0 );
 
        IndividualLayerSettings() = default;
 
        bool valid() const;
 
        bool enabled() const;
 
        void setEnabled( bool enabled );
 
        QgsSnappingConfig::SnappingTypeFlag typeFlag() const;
 
        Q_DECL_DEPRECATED QgsSnappingConfig::SnappingType type() const SIP_DEPRECATED;
 
        Q_DECL_DEPRECATED void setType( QgsSnappingConfig::SnappingType type ) SIP_DEPRECATED;
 
        void setTypeFlag( QgsSnappingConfig::SnappingTypeFlag type );
 
        double tolerance() const;
 
        void setTolerance( double tolerance );
 
        QgsTolerance::UnitType units() const;
 
        void setUnits( QgsTolerance::UnitType units );
 
        double minimumScale() const;
 
        void setMinimumScale( double minScale );
 
        double maximumScale() const;
 
        void setMaximumScale( double maxScale );
 
        bool operator!= ( const QgsSnappingConfig::IndividualLayerSettings &other ) const;
 
        bool operator== ( const QgsSnappingConfig::IndividualLayerSettings &other ) const;
 
      private:
        bool mValid = false;
        bool mEnabled = false;
        SnappingTypeFlag mType = VertexFlag;
        double mTolerance = 0;
        QgsTolerance::UnitType mUnits = QgsTolerance::Pixels;
        double mMinimumScale = 0.0;
        double mMaximumScale = 0.0;
    };
 
    explicit QgsSnappingConfig( QgsProject *project = nullptr );
 
    bool operator==( const QgsSnappingConfig &other ) const;
 
    void reset();
 
    bool enabled() const;
 
    void setEnabled( bool enabled );
 
    SnappingMode mode() const;
 
    void setMode( SnappingMode mode );
 
    QgsSnappingConfig::SnappingTypeFlag typeFlag() const;
 
    Q_DECL_DEPRECATED QgsSnappingConfig::SnappingType type() const SIP_DEPRECATED;
 
    Q_DECL_DEPRECATED void setType( QgsSnappingConfig::SnappingType type );
 
    void setTypeFlag( QgsSnappingConfig::SnappingTypeFlag type );
 
    double tolerance() const;
 
    void setTolerance( double tolerance );
 
    double minimumScale() const;
 
    void setMinimumScale( double minScale );
 
    double maximumScale() const;
 
    void setMaximumScale( double maxScale );
 
    void setScaleDependencyMode( ScaleDependencyMode mode );
 
    ScaleDependencyMode scaleDependencyMode() const;
 
    QgsTolerance::UnitType units() const;
 
    void setUnits( QgsTolerance::UnitType units );
 
    bool intersectionSnapping() const;
 
    void setIntersectionSnapping( bool enabled );
 
    bool selfSnapping() const;
 
    void setSelfSnapping( bool enabled );
 
#ifndef SIP_RUN
    QHash<QgsVectorLayer *, QgsSnappingConfig::IndividualLayerSettings> individualLayerSettings() const;
#else
    SIP_PYDICT individualLayerSettings() const;
    % MethodCode
    // Create the dictionary.
    PyObject *d = PyDict_New();
    if ( !d )
      return nullptr;
    // Set the dictionary elements.
    QHash<QgsVectorLayer *, QgsSnappingConfig::IndividualLayerSettings> container = sipCpp->individualLayerSettings();
    QHash<QgsVectorLayer *, QgsSnappingConfig::IndividualLayerSettings>::const_iterator i = container.constBegin();
    while ( i != container.constEnd() )
    {
      QgsVectorLayer *vl = i.key();
      QgsSnappingConfig::IndividualLayerSettings *ils = new QgsSnappingConfig::IndividualLayerSettings( i.value() );
 
      PyObject *vlobj = sipConvertFromType( vl, sipType_QgsVectorLayer, nullptr );
      PyObject *ilsobj = sipConvertFromType( ils, sipType_QgsSnappingConfig_IndividualLayerSettings, Py_None );
 
      if ( !vlobj || !ilsobj || PyDict_SetItem( d, vlobj, ilsobj ) < 0 )
      {
        Py_DECREF( d );
        if ( vlobj )
        {
          Py_DECREF( vlobj );
        }
        if ( ilsobj )
        {
          Py_DECREF( ilsobj );
        }
        else
        {
          delete ils;
        }
        PyErr_SetString( PyExc_StopIteration, "" );
      }
      Py_DECREF( vlobj );
      Py_DECREF( ilsobj );
      ++i;
    }
    sipRes = d;
    % End
#endif
 
    QgsSnappingConfig::IndividualLayerSettings individualLayerSettings( QgsVectorLayer *vl ) const;
 
    void setIndividualLayerSettings( QgsVectorLayer *vl, const QgsSnappingConfig::IndividualLayerSettings &individualLayerSettings );
 
    bool operator!= ( const QgsSnappingConfig &other ) const;
 
    void readProject( const QDomDocument &doc );
 
    void writeProject( QDomDocument &doc );
 
    bool addLayers( const QList<QgsMapLayer *> &layers );
 
 
    bool removeLayers( const QList<QgsMapLayer *> &layers );
 
    QgsProject *project() const;
 
    void setProject( QgsProject *project );
 
  private:
    void readLegacySettings();
 
    QgsProject *mProject = nullptr;
    bool mEnabled = false;
    SnappingMode mMode = ActiveLayer;
    SnappingTypeFlag mType = VertexFlag;
    double mTolerance = 0.0;
    ScaleDependencyMode mScaleDependencyMode = Disabled;
    double mMinimumScale = 0.0;
    double mMaximumScale = 0.0;
    QgsTolerance::UnitType mUnits = QgsTolerance::ProjectUnits;
    bool mIntersectionSnapping = false;
    bool mSelfSnapping = false;
 
    QHash<QgsVectorLayer *, IndividualLayerSettings> mIndividualLayerSettings;
 
};
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsSnappingConfig::SnappingTypeFlag )
 
#endif // QGSPROJECTSNAPPINGSETTINGS_H