/
seilaplanPlugin.py
333 lines (273 loc) · 12.4 KB
/
seilaplanPlugin.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
# -*- coding: utf-8 -*-
"""
/***************************************************************************
SeilaplanPlugin
A QGIS plugin
Seilkran-Layoutplaner
-------------------
begin : 2013
copyright : (C) 2015 by ETH Zürich
email : seilaplanplugin@gmail.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. *
* *
***************************************************************************/
"""
import os
import sys
# Add shipped libraries to python path
libPath = os.path.join(os.path.dirname(__file__), 'lib')
if libPath not in sys.path:
sys.path.insert(-1, libPath)
from qgis.PyQt.QtCore import QSettings, QTranslator, qVersion, QCoreApplication
from qgis.PyQt.QtWidgets import QAction, QPushButton, QMessageBox
from qgis.PyQt.QtGui import QIcon
from qgis.core import QgsApplication, Qgis
# Initialize Qt resources from file resources.py
from .gui import resources_rc
# Before continuing, we check if scipy and scipy.interpolate can be imported.
# If not, we will not import the plugin files.
ERROR = False
try:
import scipy
except ModuleNotFoundError:
# On linux scipy isn't included in the standard qgis python
# interpreter so the user has to add it manually
ERROR = 1
try:
import scipy.interpolate
except ImportError:
# On QGIS Version 3.10.9 and 3.14.15 there is a bug that prevents
# importing scipy.interpolate.
ERROR = 1 if ERROR == 1 else 2
if not ERROR:
# Main dialog window
from .gui.seilaplanPluginDialog import SeilaplanPluginDialog
# Further dialog windows and helpers
from .gui.progressDialog import ProgressDialog
from .tools.configHandler import ConfigHandler
from .tools.processingThread import ProcessingTask
from .gui.adjustmentDialog import AdjustmentDialog
class SeilaplanPlugin(object):
"""QGIS Plugin Implementation."""
def __init__(self, iface):
# Save reference to the QGIS interface
self.iface = iface
# Initialize plugin directory
self.plugin_dir = os.path.dirname(__file__)
# Initialize locale
# Default locale is english
useLocale = os.path.join(self.plugin_dir, 'i18n',
'SeilaplanPlugin_en.qm')
# Get locale from QGIS settings
qgisLocale = QSettings().value("locale/userLocale")[0:2]
localePath = os.path.join(self.plugin_dir, 'i18n',
'SeilaplanPlugin_{}.qm'.format(qgisLocale))
if qgisLocale in ['de', 'en', 'fr', 'it'] and os.path.exists(localePath):
useLocale = localePath
self.translator = QTranslator()
self.translator.load(useLocale)
if qVersion() > '4.3.3':
QCoreApplication.installTranslator(self.translator)
self.actions = []
self.menu = self.tr('SEILAPLAN')
self.dlg = None
self.progressDialog = None
self.adjustmentWindow = None
self.result = None
# Check if plugin was started the first time in current QGIS session
# Must be set in initGui() to survive plugin reloads
self.first_start = None
# noinspection PyMethodMayBeStati
def tr(self, message):
"""Get the translation for a string using Qt translation API.
We implement this ourselves since we do not inherit QObject.
:param message: String for translation.
:type message: str, QString
:returns: Translated version of message.
:rtype: QString
"""
# noinspection PyTypeChecker,PyArgumentList,PyCallByClass
return QCoreApplication.translate(type(self).__name__, message)
def add_action(self, icon_path, text, callback, enabled_flag=True,
add_to_menu=True, add_to_toolbar=True, status_tip=None,
whats_this=None, parent=None):
"""Add a toolbar icon to the toolbar.
:param icon_path: Path to the icon for this action. Can be a resource
path (e.g. ':/plugins/foo/bar.png') or a normal file system path.
:type icon_path: str
:param text: Text that should be shown in menu items for this action.
:type text: str
:param callback: Function to be called when the action is triggered.
:type callback: function
:param enabled_flag: A flag indicating if the action should be enabled
by default. Defaults to True.
:type enabled_flag: bool
:param add_to_menu: Flag indicating whether the action should also
be added to the menu. Defaults to True.
:type add_to_menu: bool
:param add_to_toolbar: Flag indicating whether the action should also
be added to the toolbar. Defaults to True.
:type add_to_toolbar: bool
:param status_tip: Optional text to show in a popup when mouse pointer
hovers over the action.
:type status_tip: str
:param parent: Parent widget for the new action. Defaults None.
:type parent: QWidget
:param whats_this: Optional text to show in the status bar when the
mouse pointer hovers over the action.
:returns: The action that was created. Note that the action is also
added to self.actions list.
:rtype: QAction
"""
icon = QIcon(icon_path)
action = QAction(icon, text, parent)
action.triggered.connect(callback)
action.setEnabled(enabled_flag)
if status_tip is not None:
action.setStatusTip(status_tip)
if whats_this is not None:
action.setWhatsThis(whats_this)
if add_to_toolbar:
# Adds plugin icon to Plugins toolbar
self.iface.addToolBarIcon(action)
if add_to_menu:
self.iface.addPluginToMenu(
self.menu,
action)
self.actions.append(action)
return action
def initGui(self):
"""Create the menu entries and toolbar icons inside the QGIS GUI."""
icon_path = ':/plugins/SeilaplanPlugin/gui/icons/icon_app.png'
self.add_action(
icon_path,
text=self.tr('SEILAPLAN'),
callback=self.run,
parent=self.iface.mainWindow())
# will be set False in run()
self.first_start = True
def unload(self):
"""Removes the plugin menu item and icon from QGIS GUI."""
for action in self.actions:
self.iface.removePluginMenu(
self.tr('&SEILAPLAN'),
action)
self.iface.removeToolBarIcon(action)
def handleImportErrors(self):
def showError():
msgBox = QMessageBox()
msgBox.setIcon(QMessageBox.Information)
msgBox.setWindowTitle(shortMessage)
msgBox.setText(longMessage)
msgBox.setStandardButtons(QMessageBox.Ok)
msgBox.show()
msgBox.exec()
if ERROR == 1:
barTitle = self.tr('SEILAPLAN Fehler')
shortMessage = self.tr('Bibliothek scipy nicht vorhanden.')
longMessage = self.tr('Seilaplan benoetigt die Python Bibliothek scipy um Berechnungen durchzufuehren.')
else: # ERROR == 2
barTitle = self.tr('SEILAPLAN Fehler')
shortMessage = self.tr('Fehlerhafte QGIS Version.')
longMessage = self.tr('Aufgrund eines Fehlers in QGIS kann Seilaplan in der aktuell installierten Version nicht ausgefuehrt werden.')
widget = self.iface.messageBar().createMessage(barTitle, shortMessage)
button = QPushButton(widget)
button.setText(self.tr("Weitere Informationen"))
button.pressed.connect(showError)
widget.layout().addWidget(button)
self.iface.messageBar().pushWidget(widget, Qgis.Warning)
def run(self):
"""Run method that performs all the real work"""
# # Uncomment when debugging
# try:
# import pydevd_pycharm
# pydevd_pycharm.settrace('localhost', port=53100,
# stdoutToServer=True, stderrToServer=True)
# except ConnectionRefusedError:
# pass
# except ImportError:
# pass
# Check for import errors and show messages
if ERROR:
self.handleImportErrors()
return
# Check if plugin is already running
if self.dlg:
return
# Configuration handler
conf = ConfigHandler()
# Initialize dialog window
self.dlg = SeilaplanPluginDialog(self.iface, conf)
self.dlg.setupContentForFirstRun()
# Control variables for possible rerun of algorithm
reRun = True
firstRun = True
while reRun:
reRun = False
result = False
status = False
if not firstRun:
# Reset configuration from earlier optimization run
conf.reset()
# Setup start window
self.dlg.setupContent()
firstRun = False
# Start event loop
self.dlg.show()
self.dlg.exec()
# Uncomment the following code when trying to debug adjustment
# window directly without having to run the optimization
# algorithm. Comment out the two previous lines (self.dgl...) to
# stop first window from showing
# conf.loadFromJsonFile("/home/pi/Seilaplan/Testfälle_Diagramm/kurz_flach/Projekteinstellungen.json")
# conf.prepareForCalculation()
# result, status = conf.loadCableDataFromFile()
# self.adjustmentWindow = AdjustmentDialog(self.iface, conf)
# self.adjustmentWindow.initData(result, status)
# self.adjustmentWindow.unsavedChanges = False
# self.adjustmentWindow.show()
# self.adjustmentWindow.exec()
# return
# Begin with computation when user clicked on "Start calculations"
# and parameters are valid
if self.dlg.startAlgorithm:
# Create separate thread for calculations so QGIS stays responsive
workerThread = ProcessingTask(conf)
# To see progress, a new dialog window shows a progress bar
self.progressDialog = ProgressDialog(self.iface)
self.progressDialog.setThread(workerThread)
# Add task to task manager of QGIS and start the calculations
QgsApplication.taskManager().addTask(workerThread)
# Show progress bar and start event loop
self.progressDialog.show()
self.progressDialog.exec()
# Check if user wants a rerun
if self.progressDialog.doReRun:
reRun = True
# Save result if calculation was successful and user didn't
# cancel
if self.progressDialog.wasSuccessful:
result, status = workerThread.getResult()
del workerThread
del self.progressDialog
elif self.dlg.goToAdjustment:
result, status = conf.loadCableDataFromFile()
if result:
# Show adjustment window to modify calculated cable line
self.adjustmentWindow = AdjustmentDialog(self.iface, conf)
self.adjustmentWindow.initData(result, status)
self.adjustmentWindow.show()
self.adjustmentWindow.exec()
if self.adjustmentWindow.doReRun:
reRun = True
del self.adjustmentWindow
self.dlg.cleanUp()
self.dlg.deleteLater()
self.dlg = None
return