qgsmaptooledit.cpp

Go to the documentation of this file.

/***************************************************************************
    qgsmaptooledit.cpp  -  base class for editing map tools
    ---------------------
    begin                : Juli 2007
    copyright            : (C) 2007 by Marco Hugentobler
    email                : marco dot hugentobler at karto dot baug dot ethz dot ch
 ***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgsmaptooledit.h"
 
#include "qgsgeometryrubberband.h"
#include "qgsmapcanvas.h"
#include "qgsproject.h"
#include "qgsrubberband.h"
#include "qgsrubberband_impl.h"
#include "qgssettingsentryimpl.h"
#include "qgssettingsregistrycore.h"
#include "qgsvectorlayer.h"
 
#include <QKeyEvent>
 
#include "moc_qgsmaptooledit.cpp"
 
QgsMapToolEdit::QgsMapToolEdit( QgsMapCanvas *canvas )
  : QgsMapTool( canvas )
{
  if ( mCanvas->project() )
  {
    connect( mCanvas->project(), &QgsProject::layersAdded, this, &QgsMapToolEdit::connectLayers );
    connectLayers( mCanvas->project()->mapLayers().values() ); // Connect existing layers
  }
}
 
double QgsMapToolEdit::defaultZValue()
{
  return QgsSettingsRegistryCore::settingsDigitizingDefaultZValue->value();
}
 
double QgsMapToolEdit::defaultMValue()
{
  return QgsSettingsRegistryCore::settingsDigitizingDefaultMValue->value();
}
 
QColor QgsMapToolEdit::digitizingStrokeColor()
{
  return QgsSettingsRegistryCore::settingsDigitizingLineColor->value();
}
 
int QgsMapToolEdit::digitizingStrokeWidth()
{
  return QgsSettingsRegistryCore::settingsDigitizingLineWidth->value();
}
 
QColor QgsMapToolEdit::digitizingFillColor()
{
  return QgsSettingsRegistryCore::settingsDigitizingFillColor->value();
}
 
 
QgsRubberBand *QgsMapToolEdit::createRubberBand( Qgis::GeometryType geometryType, bool alternativeBand )
{
  QgsRubberBand *rb = new QgsRubberBand( mCanvas, geometryType );
  rb->setWidth( digitizingStrokeWidth() );
  QColor color = digitizingStrokeColor();
  if ( alternativeBand )
  {
    const double alphaScale = QgsSettingsRegistryCore::settingsDigitizingLineColorAlphaScale->value();
    color.setAlphaF( color.alphaF() * alphaScale );
    rb->setLineStyle( Qt::DotLine );
  }
  rb->setStrokeColor( color );
 
  const QColor fillColor = digitizingFillColor();
  rb->setFillColor( fillColor );
 
  rb->show();
  return rb;
}
 
QgsRubberBand *QgsMapToolEdit::createRubberBandForLayer( QgsVectorLayer *layer, const QList< QgsFeatureId > &fids, bool alternativeBand )
{
  QgsVectorLayer *vlayer = layer ? layer : currentVectorLayer();
  Qgis::GeometryType geomType = vlayer ? vlayer->geometryType() : Qgis::GeometryType::Line;
 
  QgsRubberBand *rb = createRubberBand( geomType, alternativeBand );
  prepareRubberBandForLayer( rb, vlayer, fids );
 
  return rb;
}
 
void QgsMapToolEdit::prepareRubberBandForLayer( QgsRubberBand *rubberBand, QgsVectorLayer *layer, const QList< QgsFeatureId > &fids )
{
  if ( !rubberBand )
    return;
 
  if ( QgsVectorLayer *vlayer = layer ? layer : currentVectorLayer() )
  {
    // attach label preview decorator if the layer has labeling enabled and a valid feature was provided
    if ( !fids.isEmpty() && vlayer->labelsEnabled() && vlayer->labeling() )
    {
      rubberBand->addPreviewItem( new QgsVectorLayerLabelRubberBandPreview( rubberBand, fids, vlayer ) );
    }
  }
}
 
QgsVectorLayer *QgsMapToolEdit::currentVectorLayer()
{
  return mCanvas ? qobject_cast<QgsVectorLayer *>( mCanvas->currentLayer() ) : nullptr;
}
 
 
QgsMapToolEdit::TopologicalResult QgsMapToolEdit::addTopologicalPoints( const QVector<QgsPoint> &vertices )
{
  if ( !mCanvas )
  {
    return QgsMapToolEdit::InvalidCanvas;
  }
 
  //find out current vector layer
  QgsVectorLayer *vlayer = currentVectorLayer();
 
  if ( !vlayer )
  {
    return QgsMapToolEdit::InvalidLayer;
  }
 
  QVector<QgsPoint>::const_iterator list_it = vertices.constBegin();
  for ( ; list_it != vertices.constEnd(); ++list_it )
  {
    vlayer->addTopologicalPoints( *list_it );
  }
  return QgsMapToolEdit::Success;
}
 
QgsMapToolEdit::TopologicalResult QgsMapToolEdit::addTopologicalPoints( const QVector<QgsPointXY> &vertices )
{
  if ( !mCanvas )
  {
    return QgsMapToolEdit::InvalidCanvas;
  }
 
  //find out current vector layer
  QgsVectorLayer *vlayer = currentVectorLayer();
 
  if ( !vlayer )
  {
    return QgsMapToolEdit::InvalidLayer;
  }
 
  Q_NOWARN_DEPRECATED_PUSH
  QVector<QgsPointXY>::const_iterator list_it = vertices.constBegin();
  for ( ; list_it != vertices.constEnd(); ++list_it )
  {
    vlayer->addTopologicalPoints( *list_it );
  }
  Q_NOWARN_DEPRECATED_POP
 
  return QgsMapToolEdit::Success;
}
 
QgsGeometryRubberBand *QgsMapToolEdit::createGeometryRubberBand( Qgis::GeometryType geometryType, bool alternativeBand ) const
{
  QgsGeometryRubberBand *rb = new QgsGeometryRubberBand( mCanvas, geometryType );
  QColor color = QgsSettingsRegistryCore::settingsDigitizingLineColor->value();
  if ( alternativeBand )
  {
    double alpha = color.alpha() / 255.0 * QgsSettingsRegistryCore::settingsDigitizingLineColorAlphaScale->value();
    rb->setLineStyle( Qt::DotLine );
    color.setAlphaF( alpha );
  }
  rb->setStrokeColor( color );
  rb->setFillColor( color );
  rb->setStrokeWidth( digitizingStrokeWidth() );
  rb->show();
  return rb;
}
 
void QgsMapToolEdit::notifyNotVectorLayer()
{
  emit messageEmitted( tr( "No active vector layer" ) );
}
 
void QgsMapToolEdit::notifyNotEditableLayer()
{
  emit messageEmitted( tr( "Layer not editable" ) );
}
 
void QgsMapToolEdit::connectLayers( const QList<QgsMapLayer *> &layers )
{
  for ( QgsMapLayer *layer : layers )
  {
    QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( layer );
    if ( vlayer )
    {
      connect( vlayer, &QgsVectorLayer::editingStopped, this, &QgsMapToolEdit::cleanCanvas );
    }
  }
}
 
void QgsMapToolEdit::cleanCanvas()
{
  if ( editableVectorLayers().isEmpty() )
  {
    clean();
  }
}
 
QList<QgsVectorLayer *> QgsMapToolEdit::editableVectorLayers()
{
  QList<QgsVectorLayer *> editableLayers;
  if ( mCanvas->project() )
  {
    const auto layers = mCanvas->project()->mapLayers().values();
    for ( QgsMapLayer *layer : layers )
    {
      QgsVectorLayer *vlayer = qobject_cast<QgsVectorLayer *>( layer );
      if ( vlayer && vlayer->isEditable() && vlayer->isSpatial() )
        editableLayers << vlayer;
    }
  }
  return editableLayers;
}