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 "qgis.h"
#include "qgis_core.h"
#include "qgstolerance.h"
 
#include <QHash>
#include <QIcon>
 
class QDomDocument;
class QgsProject;
class QgsVectorLayer;
 

class CORE_EXPORT QgsSnappingConfig
{
    Q_GADGET
 
    Q_PROPERTY( QgsProject *project READ project WRITE setProject )
    Q_PROPERTY( bool enabled READ enabled WRITE setEnabled )
    Q_PROPERTY( Qgis::SnappingMode mode READ mode WRITE setMode )
 
  public:
    enum SnappingType
    {
      Vertex = 1,           
      VertexAndSegment = 2, 
      Segment = 3,          
    };
    // TODO QGIS 5: 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 ScaleDependencyMode
    {
      Disabled = 0, 
      Global = 1,   
      PerLayer = 2  
    };
    Q_ENUM( ScaleDependencyMode )
 
    
    static QString snappingTypeToString( Qgis::SnappingType type );

    Q_DECL_DEPRECATED static QString snappingTypeFlagToString( Qgis::SnappingType type ) SIP_DEPRECATED { return snappingTypeToString( type ); }
 

    static QIcon snappingTypeToIcon( Qgis::SnappingType type );

    Q_DECL_DEPRECATED static QIcon snappingTypeFlagToIcon( Qgis::SnappingType type ) SIP_DEPRECATED { return snappingTypeToIcon( type ); }

    class CORE_EXPORT IndividualLayerSettings
    {
      public:
        Q_DECL_DEPRECATED IndividualLayerSettings( bool enabled, SnappingType type, double tolerance, Qgis::MapToolUnit units ) SIP_DEPRECATED;

        IndividualLayerSettings( bool enabled, Qgis::SnappingTypes type, double tolerance, Qgis::MapToolUnit units, double minScale = 0.0, double maxScale = 0.0 );

        IndividualLayerSettings() = default;

        bool valid() const;

        bool enabled() const;

        void setEnabled( bool enabled );

        Qgis::SnappingTypes typeFlag() const;

        Q_DECL_DEPRECATED QgsSnappingConfig::SnappingType type() const SIP_DEPRECATED;

        Q_DECL_DEPRECATED void setType( SnappingType type ) SIP_DEPRECATED;

        void setTypeFlag( Qgis::SnappingTypes type );

        double tolerance() const;

        void setTolerance( double tolerance );

        Qgis::MapToolUnit units() const;

        void setUnits( Qgis::MapToolUnit units );

        double minimumScale() const;

        void setMinimumScale( double minScale );

        double maximumScale() const;

        void setMaximumScale( double maxScale );
 
        bool operator!=( const QgsSnappingConfig::IndividualLayerSettings &other ) const;
 
        // TODO c++20 - replace with = default
        bool operator==( const QgsSnappingConfig::IndividualLayerSettings &other ) const;
 
      private:
        bool mValid = false;
        bool mEnabled = false;
        Qgis::SnappingTypes mType = Qgis::SnappingType::Vertex;
        double mTolerance = 0;
        Qgis::MapToolUnit mUnits = Qgis::MapToolUnit::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 );

    Qgis::SnappingMode mode() const;

    void setMode( Qgis::SnappingMode mode );

    Qgis::SnappingTypes typeFlag() const;

    Q_DECL_DEPRECATED QgsSnappingConfig::SnappingType type() const SIP_DEPRECATED;

    Q_DECL_DEPRECATED void setType( QgsSnappingConfig::SnappingType type );

    void setTypeFlag( Qgis::SnappingTypes 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;

    Qgis::MapToolUnit units() const;

    void setUnits( Qgis::MapToolUnit 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
    // clang-format off
    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
// clang-format on
#endif

    QgsSnappingConfig::IndividualLayerSettings individualLayerSettings( QgsVectorLayer *vl ) const;

    void setIndividualLayerSettings( QgsVectorLayer *vl, const QgsSnappingConfig::IndividualLayerSettings &individualLayerSettings );

    void clearIndividualLayerSettings();
 
    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;
    Qgis::SnappingMode mMode = Qgis::SnappingMode::ActiveLayer;
    Qgis::SnappingTypes mType = Qgis::SnappingType::Vertex;
    double mTolerance = 0.0;
    ScaleDependencyMode mScaleDependencyMode = Disabled;
    double mMinimumScale = 0.0;
    double mMaximumScale = 0.0;
    Qgis::MapToolUnit mUnits = Qgis::MapToolUnit::Project;
    bool mIntersectionSnapping = false;
    bool mSelfSnapping = false;
 
    QHash<QgsVectorLayer *, IndividualLayerSettings> mIndividualLayerSettings;
};
 
#endif // QGSPROJECTSNAPPINGSETTINGS_H