mirror of
https://github.com/qgis/QGIS.git
synced 2025-03-19 00:04:46 -04:00
6a2625664e
This is a subclass of QgsProcessingParameterNumber, but specifically for numeric parameters which represent distances. It is linked to a parent parameter, from which the distance unit will be determined, and is shown using a dedicated distance widget within the processing parameters panel. This widget shows the distance unit. This avoids the confusion when running algorithms which use distances where the unit depends on a layer or CRS parameter - e.g. the distance parameter in the buffer algorithm gives the distance in layer units... so now we can show those units directly within the dialog. Hopefully this leads to less user confusion and accidental "1000 degree buffers"! Additionally - if the unit is in degrees, a small warning icon is shown next to the parameter. The tooltip for this icon advises users to reproject data into a suitable projected local coordinate system. Initially implemented for the native buffer and single sided buffer algorithm only - but more will be added. Fixes #16290
432 lines
23 KiB
Python
Executable File
432 lines
23 KiB
Python
Executable File
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
***************************************************************************
|
|
ModelerParameterDefinitionDialog.py
|
|
---------------------
|
|
Date : August 2012
|
|
Copyright : (C) 2012 by Victor Olaya
|
|
Email : volayaf at gmail dot com
|
|
***************************************************************************
|
|
* *
|
|
* 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. *
|
|
* *
|
|
***************************************************************************
|
|
"""
|
|
from processing.modeler.exceptions import UndefinedParameterException
|
|
|
|
__author__ = 'Victor Olaya'
|
|
__date__ = 'August 2012'
|
|
__copyright__ = '(C) 2012, Victor Olaya'
|
|
|
|
# This will get replaced with a git SHA1 when you do a git archive
|
|
|
|
__revision__ = '$Format:%H$'
|
|
|
|
import math
|
|
|
|
from qgis.gui import QgsExpressionLineEdit, QgsProjectionSelectionWidget
|
|
from qgis.core import (QgsApplication,
|
|
QgsSettings,
|
|
QgsProcessing,
|
|
QgsCoordinateReferenceSystem,
|
|
QgsProcessingParameterDefinition,
|
|
QgsProcessingParameterBoolean,
|
|
QgsProcessingParameterCrs,
|
|
QgsProcessingParameterMapLayer,
|
|
QgsProcessingParameterExtent,
|
|
QgsProcessingParameterPoint,
|
|
QgsProcessingParameterFile,
|
|
QgsProcessingParameterMatrix,
|
|
QgsProcessingParameterMultipleLayers,
|
|
QgsProcessingParameterNumber,
|
|
QgsProcessingParameterDistance,
|
|
QgsProcessingParameterRange,
|
|
QgsProcessingParameterRasterLayer,
|
|
QgsProcessingParameterEnum,
|
|
QgsProcessingParameterString,
|
|
QgsProcessingParameterExpression,
|
|
QgsProcessingParameterVectorLayer,
|
|
QgsProcessingParameterField,
|
|
QgsProcessingParameterFeatureSource,
|
|
QgsProcessingParameterBand
|
|
)
|
|
from qgis.PyQt.QtCore import (Qt,
|
|
QByteArray,
|
|
QCoreApplication)
|
|
from qgis.PyQt.QtWidgets import (QDialog,
|
|
QVBoxLayout,
|
|
QLabel,
|
|
QLineEdit,
|
|
QComboBox,
|
|
QCheckBox,
|
|
QDialogButtonBox,
|
|
QMessageBox)
|
|
|
|
from processing.core import parameters
|
|
|
|
|
|
class ModelerParameterDefinitionDialog(QDialog):
|
|
|
|
def __init__(self, alg, paramType=None, param=None):
|
|
self.alg = alg
|
|
self.paramType = paramType
|
|
self.param = param
|
|
QDialog.__init__(self)
|
|
self.setModal(True)
|
|
self.setupUi()
|
|
settings = QgsSettings()
|
|
self.restoreGeometry(settings.value("/Processing/modelParametersDefinitionDialogGeometry", QByteArray()))
|
|
|
|
def closeEvent(self, event):
|
|
settings = QgsSettings()
|
|
settings.setValue("/Processing/modelParametersDefinitionDialogGeometry", self.saveGeometry())
|
|
super(ModelerParameterDefinitionDialog, self).closeEvent(event)
|
|
|
|
def setupUi(self):
|
|
self.setWindowTitle(self.tr('Parameter Definition'))
|
|
self.setMinimumWidth(300)
|
|
|
|
self.verticalLayout = QVBoxLayout(self)
|
|
self.verticalLayout.setMargin(20)
|
|
|
|
self.label = QLabel(self.tr('Parameter name'))
|
|
self.verticalLayout.addWidget(self.label)
|
|
self.nameTextBox = QLineEdit()
|
|
self.verticalLayout.addWidget(self.nameTextBox)
|
|
|
|
if isinstance(self.param, QgsProcessingParameterDefinition):
|
|
self.nameTextBox.setText(self.param.description())
|
|
|
|
if self.paramType == parameters.PARAMETER_BOOLEAN or \
|
|
isinstance(self.param, QgsProcessingParameterBoolean):
|
|
self.state = QCheckBox()
|
|
self.state.setText(self.tr('Checked'))
|
|
self.state.setChecked(False)
|
|
if self.param is not None:
|
|
self.state.setChecked(bool(self.param.defaultValue()))
|
|
self.verticalLayout.addWidget(self.state)
|
|
elif self.paramType == parameters.PARAMETER_TABLE_FIELD or \
|
|
isinstance(self.param, QgsProcessingParameterField):
|
|
self.verticalLayout.addWidget(QLabel(self.tr('Parent layer')))
|
|
self.parentCombo = QComboBox()
|
|
idx = 0
|
|
for param in list(self.alg.parameterComponents().values()):
|
|
definition = self.alg.parameterDefinition(param.parameterName())
|
|
if isinstance(definition, (QgsProcessingParameterFeatureSource, QgsProcessingParameterVectorLayer)):
|
|
self.parentCombo.addItem(definition.description(), definition.name())
|
|
if self.param is not None:
|
|
if self.param.parentLayerParameterName() == definition.name():
|
|
self.parentCombo.setCurrentIndex(idx)
|
|
idx += 1
|
|
self.verticalLayout.addWidget(self.parentCombo)
|
|
|
|
# add the datatype selector
|
|
self.verticalLayout.addWidget(QLabel(self.tr('Allowed data type')))
|
|
self.datatypeCombo = QComboBox()
|
|
self.datatypeCombo.addItem(self.tr('Any'), -1)
|
|
self.datatypeCombo.addItem(self.tr('Number'), 0)
|
|
self.datatypeCombo.addItem(self.tr('String'), 1)
|
|
self.datatypeCombo.addItem(self.tr('Date/time'), 2)
|
|
self.verticalLayout.addWidget(self.datatypeCombo)
|
|
|
|
if self.param is not None and self.param.dataType() is not None:
|
|
# QComboBoxes indexes start at 0,
|
|
# self.param.datatype start with -1 that is why I need to do +1
|
|
datatypeIndex = self.param.dataType() + 1
|
|
self.datatypeCombo.setCurrentIndex(datatypeIndex)
|
|
|
|
self.multipleCheck = QCheckBox()
|
|
self.multipleCheck.setText(self.tr('Accept multiple fields'))
|
|
self.multipleCheck.setChecked(False)
|
|
if self.param is not None:
|
|
self.multipleCheck.setChecked(self.param.allowMultiple())
|
|
self.verticalLayout.addWidget(self.multipleCheck)
|
|
|
|
self.verticalLayout.addWidget(QLabel(self.tr('Default value')))
|
|
self.defaultTextBox = QLineEdit()
|
|
self.defaultTextBox.setToolTip(
|
|
self.tr('Default field name, or ; separated list of field names for multiple field parameters'))
|
|
if self.param is not None:
|
|
default = self.param.defaultValue()
|
|
if default is not None:
|
|
self.defaultTextBox.setText(str(default))
|
|
self.verticalLayout.addWidget(self.defaultTextBox)
|
|
|
|
elif self.paramType == parameters.PARAMETER_BAND or \
|
|
isinstance(self.param, QgsProcessingParameterBand):
|
|
self.verticalLayout.addWidget(QLabel(self.tr('Parent layer')))
|
|
self.parentCombo = QComboBox()
|
|
idx = 0
|
|
for param in list(self.alg.parameterComponents().values()):
|
|
definition = self.alg.parameterDefinition(param.parameterName())
|
|
if isinstance(definition, (QgsProcessingParameterRasterLayer)):
|
|
self.parentCombo.addItem(definition.description(), definition.name())
|
|
if self.param is not None:
|
|
if self.param.parentLayerParameterName() == definition.name():
|
|
self.parentCombo.setCurrentIndex(idx)
|
|
idx += 1
|
|
self.verticalLayout.addWidget(self.parentCombo)
|
|
elif (self.paramType in (
|
|
parameters.PARAMETER_VECTOR, parameters.PARAMETER_TABLE) or
|
|
isinstance(self.param, (QgsProcessingParameterFeatureSource, QgsProcessingParameterVectorLayer))):
|
|
self.verticalLayout.addWidget(QLabel(self.tr('Geometry type')))
|
|
self.shapetypeCombo = QComboBox()
|
|
self.shapetypeCombo.addItem(self.tr('Geometry Not Required'), QgsProcessing.TypeVector)
|
|
self.shapetypeCombo.addItem(self.tr('Point'), QgsProcessing.TypeVectorPoint)
|
|
self.shapetypeCombo.addItem(self.tr('Line'), QgsProcessing.TypeVectorLine)
|
|
self.shapetypeCombo.addItem(self.tr('Polygon'), QgsProcessing.TypeVectorPolygon)
|
|
self.shapetypeCombo.addItem(self.tr('Any Geometry Type'), QgsProcessing.TypeVectorAnyGeometry)
|
|
if self.param is not None:
|
|
self.shapetypeCombo.setCurrentIndex(self.shapetypeCombo.findData(self.param.dataTypes()[0]))
|
|
self.verticalLayout.addWidget(self.shapetypeCombo)
|
|
elif (self.paramType == parameters.PARAMETER_MULTIPLE or
|
|
isinstance(self.param, QgsProcessingParameterMultipleLayers)):
|
|
self.verticalLayout.addWidget(QLabel(self.tr('Data type')))
|
|
self.datatypeCombo = QComboBox()
|
|
self.datatypeCombo.addItem(self.tr('Any Map Layer'), QgsProcessing.TypeMapLayer)
|
|
self.datatypeCombo.addItem(self.tr('Vector (No Geometry Required)'), QgsProcessing.TypeVector)
|
|
self.datatypeCombo.addItem(self.tr('Vector (Point)'), QgsProcessing.TypeVectorPoint)
|
|
self.datatypeCombo.addItem(self.tr('Vector (Line)'), QgsProcessing.TypeVectorLine)
|
|
self.datatypeCombo.addItem(self.tr('Vector (Polygon)'), QgsProcessing.TypeVectorPolygon)
|
|
self.datatypeCombo.addItem(self.tr('Vector (Any Geometry Type)'), QgsProcessing.TypeVectorAnyGeometry)
|
|
self.datatypeCombo.addItem(self.tr('Raster'), QgsProcessing.TypeRaster)
|
|
self.datatypeCombo.addItem(self.tr('File'), QgsProcessing.TypeFile)
|
|
if self.param is not None:
|
|
self.datatypeCombo.setCurrentIndex(self.datatypeCombo.findData(self.param.layerType()))
|
|
self.verticalLayout.addWidget(self.datatypeCombo)
|
|
elif (self.paramType == parameters.PARAMETER_NUMBER or self.paramType == parameters.PARAMETER_DISTANCE or
|
|
isinstance(self.param, (QgsProcessingParameterNumber, QgsProcessingParameterDistance))):
|
|
self.verticalLayout.addWidget(QLabel(self.tr('Min value')))
|
|
self.minTextBox = QLineEdit()
|
|
self.verticalLayout.addWidget(self.minTextBox)
|
|
self.verticalLayout.addWidget(QLabel(self.tr('Max value')))
|
|
self.maxTextBox = QLineEdit()
|
|
self.verticalLayout.addWidget(self.maxTextBox)
|
|
if self.param is not None:
|
|
self.minTextBox.setText(str(self.param.minimum()))
|
|
self.maxTextBox.setText(str(self.param.maximum()))
|
|
self.verticalLayout.addWidget(QLabel(self.tr('Default value')))
|
|
self.defaultTextBox = QLineEdit()
|
|
self.defaultTextBox.setText(self.tr('0'))
|
|
if self.param is not None:
|
|
default = self.param.defaultValue()
|
|
if self.param.dataType() == QgsProcessingParameterNumber.Integer:
|
|
default = int(math.floor(default))
|
|
if default:
|
|
self.defaultTextBox.setText(str(default))
|
|
self.verticalLayout.addWidget(self.defaultTextBox)
|
|
elif (self.paramType == parameters.PARAMETER_EXPRESSION or
|
|
isinstance(self.param, QgsProcessingParameterExpression)):
|
|
self.verticalLayout.addWidget(QLabel(self.tr('Default value')))
|
|
self.defaultEdit = QgsExpressionLineEdit()
|
|
if self.param is not None:
|
|
self.defaultEdit.setExpression(self.param.defaultValue())
|
|
self.verticalLayout.addWidget(self.defaultEdit)
|
|
|
|
self.verticalLayout.addWidget(QLabel(self.tr('Parent layer')))
|
|
self.parentCombo = QComboBox()
|
|
self.parentCombo.addItem(self.tr("None"), None)
|
|
idx = 1
|
|
for param in list(self.alg.parameterComponents().values()):
|
|
definition = self.alg.parameterDefinition(param.parameterName())
|
|
if isinstance(definition, (QgsProcessingParameterFeatureSource, QgsProcessingParameterVectorLayer)):
|
|
self.parentCombo.addItem(definition.description(), definition.name())
|
|
if self.param is not None:
|
|
if self.param.parentLayerParameterName() == definition.name():
|
|
self.parentCombo.setCurrentIndex(idx)
|
|
idx += 1
|
|
self.verticalLayout.addWidget(self.parentCombo)
|
|
elif (self.paramType == parameters.PARAMETER_STRING or
|
|
isinstance(self.param, QgsProcessingParameterString)):
|
|
self.verticalLayout.addWidget(QLabel(self.tr('Default value')))
|
|
self.defaultTextBox = QLineEdit()
|
|
if self.param is not None:
|
|
self.defaultTextBox.setText(self.param.defaultValue())
|
|
self.verticalLayout.addWidget(self.defaultTextBox)
|
|
elif (self.paramType == parameters.PARAMETER_FILE or
|
|
isinstance(self.param, QgsProcessingParameterFile)):
|
|
self.verticalLayout.addWidget(QLabel(self.tr('Type')))
|
|
self.fileFolderCombo = QComboBox()
|
|
self.fileFolderCombo.addItem(self.tr('File'))
|
|
self.fileFolderCombo.addItem(self.tr('Folder'))
|
|
if self.param is not None:
|
|
self.fileFolderCombo.setCurrentIndex(
|
|
1 if self.param.behavior() == QgsProcessingParameterFile.Folder else 0)
|
|
self.verticalLayout.addWidget(self.fileFolderCombo)
|
|
elif (self.paramType == parameters.PARAMETER_POINT or
|
|
isinstance(self.param, QgsProcessingParameterPoint)):
|
|
self.verticalLayout.addWidget(QLabel(self.tr('Default value')))
|
|
self.defaultTextBox = QLineEdit()
|
|
if self.param is not None:
|
|
self.defaultTextBox.setText(self.param.defaultValue())
|
|
self.verticalLayout.addWidget(self.defaultTextBox)
|
|
elif (self.paramType == parameters.PARAMETER_CRS or
|
|
isinstance(self.param, QgsProcessingParameterCrs)):
|
|
self.verticalLayout.addWidget(QLabel(self.tr('Default value')))
|
|
self.selector = QgsProjectionSelectionWidget()
|
|
if self.param is not None:
|
|
self.selector.setCrs(QgsCoordinateReferenceSystem(self.param.defaultValue()))
|
|
else:
|
|
self.selector.setCrs(QgsCoordinateReferenceSystem('EPSG:4326'))
|
|
self.verticalLayout.addWidget(self.selector)
|
|
|
|
self.verticalLayout.addSpacing(20)
|
|
self.requiredCheck = QCheckBox()
|
|
self.requiredCheck.setText(self.tr('Mandatory'))
|
|
self.requiredCheck.setChecked(True)
|
|
if self.param is not None:
|
|
self.requiredCheck.setChecked(not self.param.flags() & QgsProcessingParameterDefinition.FlagOptional)
|
|
self.verticalLayout.addWidget(self.requiredCheck)
|
|
|
|
self.buttonBox = QDialogButtonBox(self)
|
|
self.buttonBox.setOrientation(Qt.Horizontal)
|
|
self.buttonBox.setStandardButtons(QDialogButtonBox.Cancel |
|
|
QDialogButtonBox.Ok)
|
|
self.buttonBox.setObjectName('buttonBox')
|
|
self.buttonBox.accepted.connect(self.accept)
|
|
self.buttonBox.rejected.connect(self.reject)
|
|
|
|
self.verticalLayout.addStretch()
|
|
self.verticalLayout.addWidget(self.buttonBox)
|
|
|
|
self.setLayout(self.verticalLayout)
|
|
|
|
def accept(self):
|
|
description = self.nameTextBox.text()
|
|
if description.strip() == '':
|
|
QMessageBox.warning(self, self.tr('Unable to define parameter'),
|
|
self.tr('Invalid parameter name'))
|
|
return
|
|
if self.param is None:
|
|
validChars = \
|
|
'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'
|
|
safeName = ''.join(c for c in description if c in validChars)
|
|
name = safeName.lower()
|
|
i = 2
|
|
while self.alg.parameterDefinition(name):
|
|
name = safeName.lower() + str(i)
|
|
i += 1
|
|
else:
|
|
name = self.param.name()
|
|
if (self.paramType == parameters.PARAMETER_BOOLEAN or
|
|
isinstance(self.param, QgsProcessingParameterBoolean)):
|
|
self.param = QgsProcessingParameterBoolean(name, description, self.state.isChecked())
|
|
elif (self.paramType == parameters.PARAMETER_TABLE_FIELD or
|
|
isinstance(self.param, QgsProcessingParameterField)):
|
|
if self.parentCombo.currentIndex() < 0:
|
|
QMessageBox.warning(self, self.tr('Unable to define parameter'),
|
|
self.tr('Wrong or missing parameter values'))
|
|
return
|
|
parent = self.parentCombo.currentData()
|
|
datatype = self.datatypeCombo.currentData()
|
|
default = self.defaultTextBox.text()
|
|
if not default:
|
|
default = None
|
|
self.param = QgsProcessingParameterField(name, description, defaultValue=default,
|
|
parentLayerParameterName=parent, type=datatype,
|
|
allowMultiple=self.multipleCheck.isChecked())
|
|
elif (self.paramType == parameters.PARAMETER_BAND or
|
|
isinstance(self.param, QgsProcessingParameterBand)):
|
|
if self.parentCombo.currentIndex() < 0:
|
|
QMessageBox.warning(self, self.tr('Unable to define parameter'),
|
|
self.tr('Wrong or missing parameter values'))
|
|
return
|
|
parent = self.parentCombo.currentData()
|
|
self.param = QgsProcessingParameterBand(name, description, None, parent)
|
|
elif (self.paramType == parameters.PARAMETER_MAP_LAYER or
|
|
isinstance(self.param, QgsProcessingParameterMapLayer)):
|
|
self.param = QgsProcessingParameterMapLayer(
|
|
name, description)
|
|
elif (self.paramType == parameters.PARAMETER_RASTER or
|
|
isinstance(self.param, QgsProcessingParameterRasterLayer)):
|
|
self.param = QgsProcessingParameterRasterLayer(
|
|
name, description)
|
|
elif (self.paramType == parameters.PARAMETER_TABLE or
|
|
isinstance(self.param, QgsProcessingParameterVectorLayer)):
|
|
self.param = QgsProcessingParameterVectorLayer(
|
|
name, description,
|
|
[self.shapetypeCombo.currentData()])
|
|
elif (self.paramType == parameters.PARAMETER_VECTOR or
|
|
isinstance(self.param, QgsProcessingParameterFeatureSource)):
|
|
self.param = QgsProcessingParameterFeatureSource(
|
|
name, description,
|
|
[self.shapetypeCombo.currentData()])
|
|
elif (self.paramType == parameters.PARAMETER_MULTIPLE or
|
|
isinstance(self.param, QgsProcessingParameterMultipleLayers)):
|
|
self.param = QgsProcessingParameterMultipleLayers(
|
|
name, description,
|
|
self.datatypeCombo.currentData())
|
|
elif (self.paramType == parameters.PARAMETER_NUMBER or
|
|
isinstance(self.param, (QgsProcessingParameterNumber, QgsProcessingParameterDistance))):
|
|
try:
|
|
self.param = QgsProcessingParameterNumber(name, description, QgsProcessingParameterNumber.Double,
|
|
self.defaultTextBox.text())
|
|
vmin = self.minTextBox.text().strip()
|
|
if not vmin == '':
|
|
self.param.setMinimum(float(vmin))
|
|
vmax = self.maxTextBox.text().strip()
|
|
if not vmax == '':
|
|
self.param.setMaximum(float(vmax))
|
|
except:
|
|
QMessageBox.warning(self, self.tr('Unable to define parameter'),
|
|
self.tr('Wrong or missing parameter values'))
|
|
return
|
|
elif (self.paramType == parameters.PARAMETER_EXPRESSION or
|
|
isinstance(self.param, QgsProcessingParameterExpression)):
|
|
parent = self.parentCombo.currentData()
|
|
self.param = QgsProcessingParameterExpression(name, description,
|
|
str(self.defaultEdit.expression()),
|
|
parent)
|
|
elif (self.paramType == parameters.PARAMETER_STRING or
|
|
isinstance(self.param, QgsProcessingParameterString)):
|
|
self.param = QgsProcessingParameterString(name, description,
|
|
str(self.defaultTextBox.text()))
|
|
elif (self.paramType == parameters.PARAMETER_EXTENT or
|
|
isinstance(self.param, QgsProcessingParameterExtent)):
|
|
self.param = QgsProcessingParameterExtent(name, description)
|
|
elif (self.paramType == parameters.PARAMETER_FILE or
|
|
isinstance(self.param, QgsProcessingParameterFile)):
|
|
isFolder = self.fileFolderCombo.currentIndex() == 1
|
|
self.param = QgsProcessingParameterFile(name, description,
|
|
QgsProcessingParameterFile.Folder if isFolder else QgsProcessingParameterFile.File)
|
|
elif (self.paramType == parameters.PARAMETER_POINT or
|
|
isinstance(self.param, QgsProcessingParameterPoint)):
|
|
self.param = QgsProcessingParameterPoint(name, description,
|
|
str(self.defaultTextBox.text()))
|
|
elif (self.paramType == parameters.PARAMETER_CRS or
|
|
isinstance(self.param, QgsProcessingParameterCrs)):
|
|
self.param = QgsProcessingParameterCrs(name, description, self.selector.crs().authid())
|
|
else:
|
|
if self.paramType:
|
|
typeId = self.paramType
|
|
else:
|
|
typeId = self.param.type()
|
|
|
|
paramTypeDef = QgsApplication.instance().processingRegistry().parameterType(typeId)
|
|
if not paramTypeDef:
|
|
msg = self.tr('The parameter `{}` is not registered, are you missing a required plugin?'.format(typeId))
|
|
raise UndefinedParameterException(msg)
|
|
self.param = paramTypeDef.create(name)
|
|
self.param.setDescription(description)
|
|
self.param.setMetadata(paramTypeDef.metadata())
|
|
|
|
if not self.requiredCheck.isChecked():
|
|
self.param.setFlags(self.param.flags() | QgsProcessingParameterDefinition.FlagOptional)
|
|
|
|
settings = QgsSettings()
|
|
settings.setValue("/Processing/modelParametersDefinitionDialogGeometry", self.saveGeometry())
|
|
|
|
QDialog.accept(self)
|
|
|
|
def reject(self):
|
|
self.param = None
|
|
|
|
settings = QgsSettings()
|
|
settings.setValue("/Processing/modelParametersDefinitionDialogGeometry", self.saveGeometry())
|
|
|
|
QDialog.reject(self)
|