/
PathOpGui.py
1345 lines (1124 loc) · 52.3 KB
/
PathOpGui.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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
# ***************************************************************************
# * Copyright (c) 2017 sliptonic <shopinthewoods@gmail.com> *
# * *
# * This program is free software; you can redistribute it and/or modify *
# * it under the terms of the GNU Lesser General Public License (LGPL) *
# * as published by the Free Software Foundation; either version 2 of *
# * the License, or (at your option) any later version. *
# * for detail see the LICENCE text file. *
# * *
# * This program is distributed in the hope that it will be useful, *
# * but WITHOUT ANY WARRANTY; without even the implied warranty of *
# * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
# * GNU Library General Public License for more details. *
# * *
# * You should have received a copy of the GNU Library General Public *
# * License along with this program; if not, write to the Free Software *
# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *
# * USA *
# * *
# ***************************************************************************
import FreeCAD
import FreeCADGui
import PathScripts.PathGeom as PathGeom
import PathScripts.PathGetPoint as PathGetPoint
import PathScripts.PathGui as PathGui
import PathScripts.PathJob as PathJob
import PathScripts.PathLog as PathLog
import PathScripts.PathOp as PathOp
import PathScripts.PathPreferences as PathPreferences
import PathScripts.PathSelection as PathSelection
import PathScripts.PathSetupSheet as PathSetupSheet
import PathScripts.PathUtil as PathUtil
import PathScripts.PathUtils as PathUtils
import importlib
from PySide import QtCore, QtGui
__title__ = "Path Operation UI base classes"
__author__ = "sliptonic (Brad Collette)"
__url__ = "https://www.freecadweb.org"
__doc__ = "Base classes and framework for Path operation's UI"
LOGLEVEL = False
if LOGLEVEL:
PathLog.setLevel(PathLog.Level.DEBUG, PathLog.thisModule())
PathLog.trackModule(PathLog.thisModule())
else:
PathLog.setLevel(PathLog.Level.INFO, PathLog.thisModule())
def translate(context, text, disambig=None):
return QtCore.QCoreApplication.translate(context, text, disambig)
class ViewProvider(object):
'''Generic view provider for path objects.
Deducts the icon name from operation name, brings up the TaskPanel
with pages corresponding to the operation's opFeatures() and forwards
property change notifications to the page controllers.
'''
def __init__(self, vobj, resources):
PathLog.track()
self.deleteOnReject = True
self.OpIcon = ":/icons/%s.svg" % resources.pixmap
self.OpName = resources.name
self.OpPageModule = resources.opPageClass.__module__
self.OpPageClass = resources.opPageClass.__name__
# initialized later
self.vobj = vobj
self.Object = None
self.panel = None
def attach(self, vobj):
PathLog.track()
self.vobj = vobj
self.Object = vobj.Object
self.panel = None
return
def deleteObjectsOnReject(self):
'''deleteObjectsOnReject() ... return true if all objects should
be created if the user hits cancel. This is used during the initial
edit session, if the user does not press OK, it is assumed they've
changed their mind about creating the operation.'''
PathLog.track()
return hasattr(self, 'deleteOnReject') and self.deleteOnReject
def setDeleteObjectsOnReject(self, state=False):
PathLog.track()
self.deleteOnReject = state
return self.deleteOnReject
def setEdit(self, vobj=None, mode=0):
'''setEdit(vobj, mode=0) ... initiate editing of receivers model.'''
PathLog.track()
if 0 == mode:
if vobj is None:
vobj = self.vobj
page = self.getTaskPanelOpPage(vobj.Object)
page.setTitle(self.OpName)
page.setIcon(self.OpIcon)
selection = self.getSelectionFactory()
self.setupTaskPanel(TaskPanel(vobj.Object, self.deleteObjectsOnReject(), page, selection))
self.deleteOnReject = False
return True
# no other editing possible
return False
def setupTaskPanel(self, panel):
'''setupTaskPanel(panel) ... internal function to start the editor.'''
self.panel = panel
FreeCADGui.Control.closeDialog()
FreeCADGui.Control.showDialog(panel)
panel.setupUi()
job = self.Object.Proxy.getJob(self.Object)
if job:
job.ViewObject.Proxy.setupEditVisibility(job)
else:
PathLog.info("did not find no job")
def clearTaskPanel(self):
'''clearTaskPanel() ... internal callback function when editing has finished.'''
self.panel = None
job = self.Object.Proxy.getJob(self.Object)
if job:
job.ViewObject.Proxy.resetEditVisibility(job)
def unsetEdit(self, arg1, arg2):
# pylint: disable=unused-argument
if self.panel:
self.panel.reject(False)
def __getstate__(self):
'''__getstate__() ... callback before receiver is saved to a file.
Returns a dictionary with the receiver's resources as strings.'''
PathLog.track()
state = {}
state['OpName'] = self.OpName
state['OpIcon'] = self.OpIcon
state['OpPageModule'] = self.OpPageModule
state['OpPageClass'] = self.OpPageClass
return state
def __setstate__(self, state):
'''__setstate__(state) ... callback on restoring a saved instance, pendant to __getstate__()
state is the dictionary returned by __getstate__().'''
self.OpName = state['OpName']
self.OpIcon = state['OpIcon']
self.OpPageModule = state['OpPageModule']
self.OpPageClass = state['OpPageClass']
def getIcon(self):
'''getIcon() ... the icon used in the object tree'''
if self.Object.Active:
return self.OpIcon
else:
return ":/icons/Path_OpActive.svg"
def getTaskPanelOpPage(self, obj):
'''getTaskPanelOpPage(obj) ... use the stored information to instantiate the receiver op's page controller.'''
mod = importlib.import_module(self.OpPageModule)
cls = getattr(mod, self.OpPageClass)
return cls(obj, 0)
def getSelectionFactory(self):
'''getSelectionFactory() ... return a factory function that can be used to create the selection observer.'''
return PathSelection.select(self.OpName)
def updateData(self, obj, prop):
'''updateData(obj, prop) ... callback whenever a property of the receiver's model is assigned.
The callback is forwarded to the task panel - in case an editing session is ongoing.'''
# PathLog.track(obj.Label, prop) # Creates a lot of noise
if self.panel:
self.panel.updateData(obj, prop)
def onDelete(self, vobj, arg2=None):
# pylint: disable=unused-argument
PathUtil.clearExpressionEngine(vobj.Object)
return True
def setupContextMenu(self, vobj, menu):
# pylint: disable=unused-argument
PathLog.track()
for action in menu.actions():
menu.removeAction(action)
action = QtGui.QAction(translate('Path', 'Edit'), menu)
action.triggered.connect(self.setEdit)
menu.addAction(action)
class TaskPanelPage(object):
'''Base class for all task panel pages.'''
# task panel interaction framework
def __init__(self, obj, features):
'''__init__(obj, features) ... framework initialisation.
Do not overwrite, implement initPage(obj) instead.'''
self.obj = obj
self.job = PathUtils.findParentJob(obj)
self.form = self.getForm() # pylint: disable=assignment-from-no-return
self.signalDirtyChanged = None
self.setClean()
self.setTitle('-')
self.setIcon(None)
self.features = features
self.isdirty = False
self.parent = None
self.panelTitle = 'Operation'
if hasattr(self.form, 'toolController'):
PathJob.Notification.updateTC.connect(self.resetToolController)
def setParent(self, parent):
'''setParent() ... used to transfer parent object link to child class.
Do not overwrite.'''
self.parent = parent
def onDirtyChanged(self, callback):
'''onDirtyChanged(callback) ... set callback when dirty state changes.'''
self.signalDirtyChanged = callback
def setDirty(self):
'''setDirty() ... mark receiver as dirty, causing the model to be recalculated if OK or Apply is pressed.'''
self.isdirty = True
if self.signalDirtyChanged:
self.signalDirtyChanged(self)
def setClean(self):
'''setClean() ... mark receiver as clean, indicating there is no need to recalculate the model even if the user presses OK or Apply.'''
self.isdirty = False
if self.signalDirtyChanged:
self.signalDirtyChanged(self)
def pageGetFields(self):
'''pageGetFields() ... internal callback.
Do not overwrite, implement getFields(obj) instead.'''
self.getFields(self.obj)
self.setDirty()
def pageSetFields(self):
'''pageSetFields() ... internal callback.
Do not overwrite, implement setFields(obj) instead.'''
self.setFields(self.obj)
def pageCleanup(self):
'''pageCleanup() ... internal callback.
Do not overwrite, implement cleanupPage(obj) instead.'''
self.cleanupPage(self.obj)
def pageRegisterSignalHandlers(self):
'''pageRegisterSignalHandlers() .. internal callback.
Registers a callback for all signals returned by getSignalsForUpdate(obj).
Do not overwrite, implement getSignalsForUpdate(obj) and/or registerSignalHandlers(obj) instead.'''
for signal in self.getSignalsForUpdate(self.obj):
signal.connect(self.pageGetFields)
self.registerSignalHandlers(self.obj)
def pageUpdateData(self, obj, prop):
'''pageUpdateData(obj, prop) ... internal callback.
Do not overwrite, implement updateData(obj) instead.'''
self.updateData(obj, prop)
def setTitle(self, title):
'''setTitle(title) ... sets a title for the page.'''
self.title = title
def getTitle(self, obj):
'''getTitle(obj) ... return title to be used for the receiver page.
The default implementation returns what was previously set with setTitle(title).
Can safely be overwritten by subclasses.'''
# pylint: disable=unused-argument
return self.title
def setIcon(self, icon):
'''setIcon(icon) ... sets the icon for the page.'''
self.icon = icon
def getIcon(self, obj):
'''getIcon(obj) ... return icon for page or None.
Can safely be overwritten by subclasses.'''
# pylint: disable=unused-argument
return self.icon
# subclass interface
def initPage(self, obj):
'''initPage(obj) ... overwrite to customize UI for specific model.
Note that this function is invoked after all page controllers have been created.
Should be overwritten by subclasses.'''
# pylint: disable=unused-argument
pass # pylint: disable=unnecessary-pass
def cleanupPage(self, obj):
'''cleanupPage(obj) ... overwrite to perform any cleanup tasks before page is destroyed.
Can safely be overwritten by subclasses.'''
pass # pylint: disable=unnecessary-pass
def modifyStandardButtons(self, buttonBox):
'''modifyStandardButtons(buttonBox) ... overwrite if the task panel standard buttons need to be modified.
Can safely be overwritten by subclasses.'''
pass # pylint: disable=unnecessary-pass
def getForm(self):
'''getForm() ... return UI form for this page.
Must be overwritten by subclasses.'''
pass # pylint: disable=unnecessary-pass
def getFields(self, obj):
'''getFields(obj) ... overwrite to transfer values from UI to obj's properties.
Can safely be overwritten by subclasses.'''
pass # pylint: disable=unnecessary-pass
def setFields(self, obj):
'''setFields(obj) ... overwrite to transfer obj's property values to UI.
Can safely be overwritten by subclasses.'''
pass # pylint: disable=unnecessary-pass
def getSignalsForUpdate(self, obj):
'''getSignalsForUpdate(obj) ... return signals which, when triggered, cause the receiver to update the model.
See also registerSignalHandlers(obj)
Can safely be overwritten by subclasses.'''
# pylint: disable=unused-argument
return []
def registerSignalHandlers(self, obj):
'''registerSignalHandlers(obj) ... overwrite to register custom signal handlers.
In case an update of a model is not the desired operation of a signal invocation
(see getSignalsForUpdate(obj)) this function can be used to register signal handlers
manually.
Can safely be overwritten by subclasses.'''
# pylint: disable=unused-argument
pass # pylint: disable=unnecessary-pass
def updateData(self, obj, prop):
'''updateData(obj, prop) ... overwrite if the receiver needs to react to property changes that might not have been caused by the receiver itself.
Sometimes a model will recalculate properties based on a change of another property. In order to keep the UI up to date with such changes this
function can be used.
Please note that the callback is synchronous with the property assignment operation. Also note that the notification is invoked regardless of the
actual value of the property assignment. In other words it also fires if a property gets assigned the same value it already has.
Taking above observations into account the implementation has to take care that it doesn't overwrite modified UI values by invoking setFields(obj).
This can happen if a subclass unconditionally transfers all values in getFields(obj) to the model and just calls setFields(obj) in this callback.
In such a scenario the first property assignment will cause all changes in the UI of the other fields to be overwritten by setFields(obj).
You have been warned.'''
# pylint: disable=unused-argument
pass # pylint: disable=unnecessary-pass
def updateSelection(self, obj, sel):
'''updateSelection(obj, sel) ...
overwrite to customize UI depending on current selection.
Can safely be overwritten by subclasses.'''
# pylint: disable=unused-argument
pass # pylint: disable=unnecessary-pass
# helpers
def selectInComboBox(self, name, combo):
'''selectInComboBox(name, combo) ...
helper function to select a specific value in a combo box.'''
index = combo.findText(name, QtCore.Qt.MatchFixedString)
if index >= 0:
combo.blockSignals(True)
combo.setCurrentIndex(index)
combo.blockSignals(False)
def resetToolController(self, job, tc):
if self.obj is not None:
self.obj.ToolController = tc
combo = self.form.toolController
self.setupToolController(self.obj, combo)
def setupToolController(self, obj, combo):
'''setupToolController(obj, combo) ...
helper function to setup obj's ToolController
in the given combo box.'''
controllers = PathUtils.getToolControllers(self.obj)
labels = [c.Label for c in controllers]
combo.blockSignals(True)
combo.clear()
combo.addItems(labels)
combo.blockSignals(False)
if obj.ToolController is None:
obj.ToolController = PathUtils.findToolController(obj, obj.Proxy)
if obj.ToolController is not None:
self.selectInComboBox(obj.ToolController.Label, combo)
def updateToolController(self, obj, combo):
'''updateToolController(obj, combo) ...
helper function to update obj's ToolController property if a different
one has been selected in the combo box.'''
tc = PathUtils.findToolController(obj, obj.Proxy, combo.currentText())
if obj.ToolController != tc:
obj.ToolController = tc
def setupCoolant(self, obj, combo):
'''setupCoolant(obj, combo) ...
helper function to setup obj's Coolant option.'''
job = PathUtils.findParentJob(obj)
options = job.SetupSheet.CoolantModes
combo.blockSignals(True)
combo.clear()
combo.addItems(options)
combo.blockSignals(False)
if hasattr(obj, 'CoolantMode'):
self.selectInComboBox(obj.CoolantMode, combo)
def updateCoolant(self, obj, combo):
'''updateCoolant(obj, combo) ...
helper function to update obj's Coolant property if a different
one has been selected in the combo box.'''
option = combo.currentText()
if hasattr(obj, 'CoolantMode'):
if obj.CoolantMode != option:
obj.CoolantMode = option
def updatePanelVisibility(self, panelTitle, obj):
'''updatePanelVisibility(panelTitle, obj) ...
Function to call the `updateVisibility()` GUI method of the
page whose panel title is as indicated.'''
if hasattr(self, 'parent'):
parent = getattr(self, 'parent')
if parent and hasattr(parent, 'featurePages'):
for page in parent.featurePages:
if hasattr(page, 'panelTitle'):
if page.panelTitle == panelTitle and hasattr(page, 'updateVisibility'):
page.updateVisibility()
break
class TaskPanelBaseGeometryPage(TaskPanelPage):
'''Page controller for the base geometry.'''
DataObject = QtCore.Qt.ItemDataRole.UserRole
DataObjectSub = QtCore.Qt.ItemDataRole.UserRole + 1
def __init__(self, obj, features):
super(TaskPanelBaseGeometryPage, self).__init__(obj, features)
self.panelTitle = 'Base Geometry'
self.OpIcon = ":/icons/Path_BaseGeometry.svg"
self.setIcon(self.OpIcon)
def getForm(self):
panel = FreeCADGui.PySideUic.loadUi(":/panels/PageBaseGeometryEdit.ui")
self.modifyPanel(panel)
return panel
def modifyPanel(self, panel):
'''modifyPanel(self, panel) ...
Helper method to modify the current form immediately after
it is loaded.'''
# Determine if Job operations are available with Base Geometry
availableOps = list()
ops = self.job.Operations.Group
for op in ops:
if hasattr(op, 'Base') and isinstance(op.Base, list):
if len(op.Base) > 0:
availableOps.append(op.Label)
# Load available operations into combobox
if len(availableOps) > 0:
# Populate the operations list
panel.geometryImportList.blockSignals(True)
panel.geometryImportList.clear()
availableOps.sort()
for opLbl in availableOps:
panel.geometryImportList.addItem(opLbl)
panel.geometryImportList.blockSignals(False)
else:
panel.geometryImportList.hide()
panel.geometryImportButton.hide()
def getTitle(self, obj):
return translate("PathOp", "Base Geometry")
def getFields(self, obj):
pass
def setFields(self, obj):
self.form.baseList.blockSignals(True)
self.form.baseList.clear()
for base in self.obj.Base:
for sub in base[1]:
item = QtGui.QListWidgetItem("%s.%s" % (base[0].Label, sub))
item.setData(self.DataObject, base[0])
item.setData(self.DataObjectSub, sub)
self.form.baseList.addItem(item)
self.form.baseList.blockSignals(False)
self.resizeBaseList()
def itemActivated(self):
FreeCADGui.Selection.clearSelection()
for item in self.form.baseList.selectedItems():
obj = item.data(self.DataObject)
sub = item.data(self.DataObjectSub)
if sub:
FreeCADGui.Selection.addSelection(obj, sub)
else:
FreeCADGui.Selection.addSelection(obj)
# FreeCADGui.updateGui()
def supportsVertexes(self):
return self.features & PathOp.FeatureBaseVertexes
def supportsEdges(self):
return self.features & PathOp.FeatureBaseEdges
def supportsFaces(self):
return self.features & PathOp.FeatureBaseFaces
def supportsPanels(self):
return self.features & PathOp.FeatureBasePanels
def featureName(self):
if self.supportsEdges() and self.supportsFaces():
return 'features'
if self.supportsFaces():
return 'faces'
if self.supportsEdges():
return 'edges'
return 'nothing'
def selectionSupportedAsBaseGeometry(self, selection, ignoreErrors):
if len(selection) != 1:
if not ignoreErrors:
msg = translate("PathProject", "Please select %s from a single solid" % self.featureName())
FreeCAD.Console.PrintError(msg + '\n')
PathLog.debug(msg)
return False
sel = selection[0]
if sel.HasSubObjects:
if not self.supportsVertexes() and selection[0].SubObjects[0].ShapeType == "Vertex":
if not ignoreErrors:
PathLog.error(translate("PathProject", "Vertexes are not supported"))
return False
if not self.supportsEdges() and selection[0].SubObjects[0].ShapeType == "Edge":
if not ignoreErrors:
PathLog.error(translate("PathProject", "Edges are not supported"))
return False
if not self.supportsFaces() and selection[0].SubObjects[0].ShapeType == "Face":
if not ignoreErrors:
PathLog.error(translate("PathProject", "Faces are not supported"))
return False
else:
if not self.supportsPanels() or 'Panel' not in sel.Object.Name:
if not ignoreErrors:
PathLog.error(translate("PathProject", "Please select %s of a solid" % self.featureName()))
return False
return True
def addBaseGeometry(self, selection):
PathLog.track(selection)
if self.selectionSupportedAsBaseGeometry(selection, False):
sel = selection[0]
for sub in sel.SubElementNames:
self.obj.Proxy.addBase(self.obj, sel.Object, sub)
return True
return False
def addBase(self):
if self.addBaseGeometry(FreeCADGui.Selection.getSelectionEx()):
# self.obj.Proxy.execute(self.obj)
self.setFields(self.obj)
self.setDirty()
self.updatePanelVisibility('Operation', self.obj)
def deleteBase(self):
PathLog.track()
selected = self.form.baseList.selectedItems()
for item in selected:
self.form.baseList.takeItem(self.form.baseList.row(item))
self.setDirty()
self.updateBase()
self.updatePanelVisibility('Operation', self.obj)
self.resizeBaseList()
def updateBase(self):
newlist = []
for i in range(self.form.baseList.count()):
item = self.form.baseList.item(i)
obj = item.data(self.DataObject)
sub = item.data(self.DataObjectSub)
if sub:
base = (obj, str(sub))
newlist.append(base)
PathLog.debug("Setting new base: %s -> %s" % (self.obj.Base, newlist))
self.obj.Base = newlist
# self.obj.Proxy.execute(self.obj)
# FreeCAD.ActiveDocument.recompute()
def clearBase(self):
self.obj.Base = []
self.setDirty()
self.updatePanelVisibility('Operation', self.obj)
self.resizeBaseList()
def importBaseGeometry(self):
opLabel = str(self.form.geometryImportList.currentText())
ops = FreeCAD.ActiveDocument.getObjectsByLabel(opLabel)
if ops.__len__() > 1:
msg = translate('PathOpGui', 'Mulitiple operations are labeled as')
msg += " {}\n".format(opLabel)
FreeCAD.Console.PrintWarning(msg)
for (base, subList) in ops[0].Base:
FreeCADGui.Selection.addSelection(base, subList)
self.addBase()
def registerSignalHandlers(self, obj):
self.form.baseList.itemSelectionChanged.connect(self.itemActivated)
self.form.addBase.clicked.connect(self.addBase)
self.form.deleteBase.clicked.connect(self.deleteBase)
self.form.clearBase.clicked.connect(self.clearBase)
self.form.geometryImportButton.clicked.connect(self.importBaseGeometry)
def pageUpdateData(self, obj, prop):
if prop in ['Base']:
self.setFields(obj)
def updateSelection(self, obj, sel):
if self.selectionSupportedAsBaseGeometry(sel, True):
self.form.addBase.setEnabled(True)
else:
self.form.addBase.setEnabled(False)
def resizeBaseList(self):
# Set base geometry list window to resize based on contents
# Code reference:
# https://stackoverflow.com/questions/6337589/qlistwidget-adjust-size-to-content
qList = self.form.baseList
# qList.setVerticalScrollBarPolicy(QtCore.Qt.ScrollBarAlwaysOff)
col = qList.width() # 300
row = (qList.count() + qList.frameWidth()) * 15
qList.setFixedSize(col, row)
class TaskPanelBaseLocationPage(TaskPanelPage):
'''Page controller for base locations. Uses PathGetPoint.'''
DataLocation = QtCore.Qt.ItemDataRole.UserRole
def __init__(self, obj, features):
super(TaskPanelBaseLocationPage, self).__init__(obj, features)
# members initialized later
self.editRow = None
self.panelTitle = 'Base Location'
def getForm(self):
self.formLoc = FreeCADGui.PySideUic.loadUi(":/panels/PageBaseLocationEdit.ui")
if QtCore.qVersion()[0] == '4':
self.formLoc.baseList.horizontalHeader().setResizeMode(QtGui.QHeaderView.Stretch)
else:
self.formLoc.baseList.horizontalHeader().setSectionResizeMode(QtGui.QHeaderView.Stretch)
self.getPoint = PathGetPoint.TaskPanel(self.formLoc.addRemoveEdit)
return self.formLoc
def modifyStandardButtons(self, buttonBox):
self.getPoint.buttonBox = buttonBox
def getTitle(self, obj):
return translate("PathOp", "Base Location")
def getFields(self, obj):
pass
def setFields(self, obj):
self.formLoc.baseList.blockSignals(True)
self.formLoc.baseList.clearContents()
self.formLoc.baseList.setRowCount(0)
for location in self.obj.Locations:
self.formLoc.baseList.insertRow(self.formLoc.baseList.rowCount())
item = QtGui.QTableWidgetItem("%.2f" % location.x)
item.setData(self.DataLocation, location.x)
self.formLoc.baseList.setItem(self.formLoc.baseList.rowCount()-1, 0, item)
item = QtGui.QTableWidgetItem("%.2f" % location.y)
item.setData(self.DataLocation, location.y)
self.formLoc.baseList.setItem(self.formLoc.baseList.rowCount()-1, 1, item)
self.formLoc.baseList.resizeColumnToContents(0)
self.formLoc.baseList.blockSignals(False)
self.itemActivated()
def removeLocation(self):
deletedRows = []
selected = self.formLoc.baseList.selectedItems()
for item in selected:
row = self.formLoc.baseList.row(item)
if row not in deletedRows:
deletedRows.append(row)
self.formLoc.baseList.removeRow(row)
self.updateLocations()
FreeCAD.ActiveDocument.recompute()
def updateLocations(self):
PathLog.track()
locations = []
for i in range(self.formLoc.baseList.rowCount()):
x = self.formLoc.baseList.item(i, 0).data(self.DataLocation)
y = self.formLoc.baseList.item(i, 1).data(self.DataLocation)
location = FreeCAD.Vector(x, y, 0)
locations.append(location)
self.obj.Locations = locations
def addLocation(self):
self.getPoint.getPoint(self.addLocationAt)
def addLocationAt(self, point, obj):
# pylint: disable=unused-argument
if point:
locations = self.obj.Locations
locations.append(point)
self.obj.Locations = locations
FreeCAD.ActiveDocument.recompute()
def editLocation(self):
selected = self.formLoc.baseList.selectedItems()
if selected:
row = self.formLoc.baseList.row(selected[0])
self.editRow = row
x = self.formLoc.baseList.item(row, 0).data(self.DataLocation)
y = self.formLoc.baseList.item(row, 1).data(self.DataLocation)
start = FreeCAD.Vector(x, y, 0)
self.getPoint.getPoint(self.editLocationAt, start)
def editLocationAt(self, point, obj):
# pylint: disable=unused-argument
if point:
self.formLoc.baseList.item(self.editRow, 0).setData(self.DataLocation, point.x)
self.formLoc.baseList.item(self.editRow, 1).setData(self.DataLocation, point.y)
self.updateLocations()
FreeCAD.ActiveDocument.recompute()
def itemActivated(self):
if self.formLoc.baseList.selectedItems():
self.form.removeLocation.setEnabled(True)
self.form.editLocation.setEnabled(True)
else:
self.form.removeLocation.setEnabled(False)
self.form.editLocation.setEnabled(False)
def registerSignalHandlers(self, obj):
self.form.baseList.itemSelectionChanged.connect(self.itemActivated)
self.formLoc.addLocation.clicked.connect(self.addLocation)
self.formLoc.removeLocation.clicked.connect(self.removeLocation)
self.formLoc.editLocation.clicked.connect(self.editLocation)
def pageUpdateData(self, obj, prop):
if prop in ['Locations']:
self.setFields(obj)
class TaskPanelHeightsPage(TaskPanelPage):
'''Page controller for heights.'''
def __init__(self, obj, features):
super(TaskPanelHeightsPage, self).__init__(obj, features)
# members initialized later
self.clearanceHeight = None
self.safeHeight = None
self.panelTitle = 'Heights'
self.OpIcon = ":/icons/Path_Heights.svg"
self.setIcon(self.OpIcon)
def getForm(self):
return FreeCADGui.PySideUic.loadUi(":/panels/PageHeightsEdit.ui")
def initPage(self, obj):
self.safeHeight = PathGui.QuantitySpinBox(self.form.safeHeight, obj, 'SafeHeight')
self.clearanceHeight = PathGui.QuantitySpinBox(self.form.clearanceHeight, obj, 'ClearanceHeight')
def getTitle(self, obj):
return translate("Path", "Heights")
def getFields(self, obj):
self.safeHeight.updateProperty()
self.clearanceHeight.updateProperty()
def setFields(self, obj):
self.safeHeight.updateSpinBox()
self.clearanceHeight.updateSpinBox()
def getSignalsForUpdate(self, obj):
signals = []
signals.append(self.form.safeHeight.editingFinished)
signals.append(self.form.clearanceHeight.editingFinished)
return signals
def pageUpdateData(self, obj, prop):
if prop in ['SafeHeight', 'ClearanceHeight']:
self.setFields(obj)
class TaskPanelDepthsPage(TaskPanelPage):
'''Page controller for depths.'''
def __init__(self, obj, features):
super(TaskPanelDepthsPage, self).__init__(obj, features)
# members initialized later
self.startDepth = None
self.finalDepth = None
self.finishDepth = None
self.stepDown = None
self.panelTitle = 'Depths'
self.OpIcon = ":/icons/Path_Depths.svg"
self.setIcon(self.OpIcon)
def getForm(self):
return FreeCADGui.PySideUic.loadUi(":/panels/PageDepthsEdit.ui")
def haveStartDepth(self):
return PathOp.FeatureDepths & self.features
def haveFinalDepth(self):
return PathOp.FeatureDepths & self.features and not PathOp.FeatureNoFinalDepth & self.features
def haveFinishDepth(self):
return PathOp.FeatureDepths & self.features and PathOp.FeatureFinishDepth & self.features
def haveStepDown(self):
return PathOp.FeatureStepDown & self. features
def initPage(self, obj):
if self.haveStartDepth():
self.startDepth = PathGui.QuantitySpinBox(self.form.startDepth, obj, 'StartDepth')
else:
self.form.startDepth.hide()
self.form.startDepthLabel.hide()
self.form.startDepthSet.hide()
if self.haveFinalDepth():
self.finalDepth = PathGui.QuantitySpinBox(self.form.finalDepth, obj, 'FinalDepth')
else:
if self.haveStartDepth():
self.form.finalDepth.setEnabled(False)
self.form.finalDepth.setToolTip(translate('PathOp', 'FinalDepth cannot be modified for this operation.\nIf it is necessary to set the FinalDepth manually please select a different operation.'))
else:
self.form.finalDepth.hide()
self.form.finalDepthLabel.hide()
self.form.finalDepthSet.hide()
if self.haveStepDown():
self.stepDown = PathGui.QuantitySpinBox(self.form.stepDown, obj, 'StepDown')
else:
self.form.stepDown.hide()
self.form.stepDownLabel.hide()
if self.haveFinishDepth():
self.finishDepth = PathGui.QuantitySpinBox(self.form.finishDepth, obj, 'FinishDepth')
else:
self.form.finishDepth.hide()
self.form.finishDepthLabel.hide()
def getTitle(self, obj):
return translate("PathOp", "Depths")
def getFields(self, obj):
if self.haveStartDepth():
self.startDepth.updateProperty()
if self.haveFinalDepth():
self.finalDepth.updateProperty()
if self.haveStepDown():
self.stepDown.updateProperty()
if self.haveFinishDepth():
self.finishDepth.updateProperty()
def setFields(self, obj):
if self.haveStartDepth():
self.startDepth.updateSpinBox()
if self.haveFinalDepth():
self.finalDepth.updateSpinBox()
if self.haveStepDown():
self.stepDown.updateSpinBox()
if self.haveFinishDepth():
self.finishDepth.updateSpinBox()
self.updateSelection(obj, FreeCADGui.Selection.getSelectionEx())
def getSignalsForUpdate(self, obj):
signals = []
if self.haveStartDepth():
signals.append(self.form.startDepth.editingFinished)
if self.haveFinalDepth():
signals.append(self.form.finalDepth.editingFinished)
if self.haveStepDown():
signals.append(self.form.stepDown.editingFinished)
if self.haveFinishDepth():
signals.append(self.form.finishDepth.editingFinished)
return signals
def registerSignalHandlers(self, obj):
if self.haveStartDepth():
self.form.startDepthSet.clicked.connect(lambda: self.depthSet(obj, self.startDepth, 'StartDepth'))
if self.haveFinalDepth():
self.form.finalDepthSet.clicked.connect(lambda: self.depthSet(obj, self.finalDepth, 'FinalDepth'))
def pageUpdateData(self, obj, prop):
if prop in ['StartDepth', 'FinalDepth', 'StepDown', 'FinishDepth']:
self.setFields(obj)
def depthSet(self, obj, spinbox, prop):
z = self.selectionZLevel(FreeCADGui.Selection.getSelectionEx())
if z is not None:
PathLog.debug("depthSet(%s, %s, %.2f)" % (obj.Label, prop, z))
if spinbox.expression():
obj.setExpression(prop, None)
self.setDirty()
spinbox.updateSpinBox(FreeCAD.Units.Quantity(z, FreeCAD.Units.Length))
if spinbox.updateProperty():
self.setDirty()
else:
PathLog.info("depthSet(-)")
def selectionZLevel(self, sel):
if len(sel) == 1 and len(sel[0].SubObjects) == 1:
sub = sel[0].SubObjects[0]
if 'Vertex' == sub.ShapeType:
return sub.Z
if PathGeom.isHorizontal(sub):
if 'Edge' == sub.ShapeType:
return sub.Vertexes[0].Z
if 'Face' == sub.ShapeType:
return sub.BoundBox.ZMax
return None
def updateSelection(self, obj, sel):
if self.selectionZLevel(sel) is not None:
self.form.startDepthSet.setEnabled(True)
self.form.finalDepthSet.setEnabled(True)
else:
self.form.startDepthSet.setEnabled(False)
self.form.finalDepthSet.setEnabled(False)
class TaskPanelDiametersPage(TaskPanelPage):
'''Page controller for diameters.'''
def __init__(self, obj, features):
super(TaskPanelDiametersPage, self).__init__(obj, features)
# members initialized later
self.clearanceHeight = None
self.safeHeight = None
def getForm(self):
return FreeCADGui.PySideUic.loadUi(":/panels/PageDiametersEdit.ui")
def initPage(self, obj):
self.minDiameter = PathGui.QuantitySpinBox(self.form.minDiameter, obj, 'MinDiameter')
self.maxDiameter = PathGui.QuantitySpinBox(self.form.maxDiameter, obj, 'MaxDiameter')
def getTitle(self, obj):
return translate("Path", "Diameters")
def getFields(self, obj):
self.minDiameter.updateProperty()
self.maxDiameter.updateProperty()
def setFields(self, obj):
self.minDiameter.updateSpinBox()
self.maxDiameter.updateSpinBox()
def getSignalsForUpdate(self, obj):
signals = []
signals.append(self.form.minDiameter.editingFinished)
signals.append(self.form.maxDiameter.editingFinished)
return signals
def pageUpdateData(self, obj, prop):
if prop in ['MinDiameter', 'MaxDiameter']:
self.setFields(obj)
class TaskPanel(object):
'''
Generic TaskPanel implementation handling the standard Path operation layout.
This class only implements the framework and takes care of bringing all pages up and down in a controller fashion.
It implements the standard editor behaviour for OK, Cancel and Apply and tracks if the model is still in sync with
the UI.
However, all display and processing of fields is handled by the page controllers which are managed in a list. All
event callbacks and framework actions are forwarded to the page controllers in turn and each page controller is
expected to process all events concerning the data it manages.
'''
def __init__(self, obj, deleteOnReject, opPage, selectionFactory):
PathLog.track(obj.Label, deleteOnReject, opPage, selectionFactory)
FreeCAD.ActiveDocument.openTransaction(translate("Path", "AreaOp Operation"))
self.deleteOnReject = deleteOnReject
self.featurePages = []
# members initialized later
self.clearanceHeight = None
self.safeHeight = None
self.startDepth = None
self.finishDepth = None