In Python 3 `super()` can be used without an argument in order to get the parent class, `super()`. In Python 2 the present class must be used as an argument, `super(ThisClass, self)`. This commit is done to support Python 2, as without it all Gui Command tools will be broken and will fail to launch, even if the unit tests pass. Also, set the `__metaclass__` variable to `type`. This is done to turn all classes into "new style" classes in Python 2. This is required so `super()` works correctly in this version of Pyton. This commit can be reverted once Python 2 support is completely dropped, and only Python 3 compatible code is used.
130 lines
5.5 KiB
Python
130 lines
5.5 KiB
Python
# ***************************************************************************
|
|
# * (c) 2020 Eliud Cabrera Castillo <e.cabrera-castillo@tum.de> *
|
|
# * *
|
|
# * This file is part of the FreeCAD CAx development system. *
|
|
# * *
|
|
# * 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. *
|
|
# * *
|
|
# * FreeCAD 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 FreeCAD; if not, write to the Free Software *
|
|
# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *
|
|
# * USA *
|
|
# * *
|
|
# ***************************************************************************
|
|
"""Provides the Draft OrthoArray GuiCommand."""
|
|
## @package gui_orthoarray
|
|
# \ingroup DRAFT
|
|
# \brief Provides the Draft OrthoArray GuiCommand.
|
|
|
|
from pivy import coin
|
|
from PySide.QtCore import QT_TRANSLATE_NOOP
|
|
|
|
import FreeCAD as App
|
|
import FreeCADGui as Gui
|
|
import Draft
|
|
import Draft_rc # include resources, icons, ui files
|
|
from draftutils.messages import _msg, _log
|
|
from draftutils.translate import _tr
|
|
from draftguitools import gui_base
|
|
from drafttaskpanels import task_orthoarray
|
|
import draftutils.todo as todo
|
|
|
|
# The module is used to prevent complaints from code checkers (flake8)
|
|
bool(Draft_rc.__name__)
|
|
|
|
|
|
class OrthoArray(gui_base.GuiCommandBase):
|
|
"""Gui command for the OrthoArray tool."""
|
|
|
|
def __init__(self):
|
|
super(OrthoArray, self).__init__()
|
|
self.command_name = "Orthogonal array"
|
|
# self.location = None
|
|
self.mouse_event = None
|
|
self.view = None
|
|
# self.callback_move = None
|
|
self.callback_click = None
|
|
self.ui = None
|
|
self.point = App.Vector()
|
|
|
|
def GetResources(self):
|
|
"""Set icon, menu and tooltip."""
|
|
_tip = ("Creates copies of a selected object, "
|
|
"and places the copies in an orthogonal pattern.\n"
|
|
"The properties of the array can be further modified after "
|
|
"the new object is created, including turning it into "
|
|
"a different type of array.")
|
|
|
|
d = {'Pixmap': 'Draft_Array',
|
|
'MenuText': QT_TRANSLATE_NOOP("Draft", "Array"),
|
|
'ToolTip': QT_TRANSLATE_NOOP("Draft", _tip)}
|
|
return d
|
|
|
|
def Activated(self):
|
|
"""Execute when the command is called.
|
|
|
|
We add callbacks that connect the 3D view with
|
|
the widgets of the task panel.
|
|
"""
|
|
_log("GuiCommand: {}".format(_tr(self.command_name)))
|
|
_msg("{}".format(16*"-"))
|
|
_msg("GuiCommand: {}".format(_tr(self.command_name)))
|
|
|
|
# self.location = coin.SoLocation2Event.getClassTypeId()
|
|
self.mouse_event = coin.SoMouseButtonEvent.getClassTypeId()
|
|
self.view = Draft.get3DView()
|
|
# self.callback_move = \
|
|
# self.view.addEventCallbackPivy(self.location, self.move)
|
|
self.callback_click = \
|
|
self.view.addEventCallbackPivy(self.mouse_event, self.click)
|
|
|
|
self.ui = task_orthoarray.TaskPanelOrthoArray()
|
|
# The calling class (this one) is saved in the object
|
|
# of the interface, to be able to call a function from within it.
|
|
self.ui.source_command = self
|
|
# Gui.Control.showDialog(self.ui)
|
|
todo.ToDo.delay(Gui.Control.showDialog, self.ui)
|
|
|
|
def click(self, event_cb=None):
|
|
"""Execute as a callback when the pointer clicks on the 3D view.
|
|
|
|
It should act as if the Enter key was pressed, or the OK button
|
|
was pressed in the task panel.
|
|
"""
|
|
if event_cb:
|
|
event = event_cb.getEvent()
|
|
if (event.getState() != coin.SoMouseButtonEvent.DOWN
|
|
or event.getButton() != coin.SoMouseButtonEvent.BUTTON1):
|
|
return
|
|
if self.ui and self.point:
|
|
# The accept function of the interface
|
|
# should call the completed function
|
|
# of the calling class (this one).
|
|
self.ui.accept()
|
|
|
|
def completed(self):
|
|
"""Execute when the command is terminated.
|
|
|
|
We should remove the callbacks that were added to the 3D view
|
|
and then close the task panel.
|
|
"""
|
|
# self.view.removeEventCallbackPivy(self.location,
|
|
# self.callback_move)
|
|
self.view.removeEventCallbackPivy(self.mouse_event,
|
|
self.callback_click)
|
|
if Gui.Control.activeDialog():
|
|
Gui.Control.closeDialog()
|
|
super(OrthoArray, self).finish()
|
|
|
|
|
|
Gui.addCommand('Draft_OrthoArray', OrthoArray())
|