This includes `gui_annotationstyleeditor`, `gui_arcs`, `gui_array_simple`, `gui_arrays`, `gui_base`, `gui_base_original`, `gui_beziers`, `gui_circles`, `gui_circulararray`, `gui_clone`, `gui_circulararray`, `gui_clone`, `gui_dimension_ops`, `gui_dimensions`, `gui_downgrade`, `gui_draft2sketch`, `gui_drawing`, `gui_edit`, `gui_edit_arch_objects`, `gui_edit_draft_objects`, `gui_edit_part_objects`, `gui_edit_sketcher_objects`, `gui_ellipses`, `gui_facebinders`, `gui_fillets`, `gui_grid`, `gui_groups`, `gui_heal`, `gui_join`, `gui_labels`, `gui_line_add_delete`, `gui_lineops`, `gui_lines`, `gui_lineslope`, `gui_mirror`, `gui_move`, `gui_offset`, `gui_orthoarray`, `gui_patharray`, `gui_planeproxy`, `gui_pointarray`, `gui_points`, `gui_polararray`, `gui_polygons`, `gui_rectangles`, `gui_rotate`, `gui_scale`, `gui_selectplane`, `gui_shape2dview`, `gui_shapestrings`, `gui_snapper`, `gui_snaps`, `gui_splines`, `gui_split`, `gui_stretch`, `gui_styles`, `gui_subeleemnts`, `gui_texts`, `gui_togglemodes`, `gui_tools_utils`, `gui_trackers`, `gui_trimex`, `gui_upgrade`, `gui_wire2spline`. These are added to the `draftguitools` Doxygen group so that the functions and classes contained in each module are listed appropriately in the automatically generated documentation.
121 lines
5.0 KiB
Python
121 lines
5.0 KiB
Python
# ***************************************************************************
|
|
# * (c) 2009, 2010 Yorik van Havre <yorik@uncreated.net> *
|
|
# * (c) 2009, 2010 Ken Cline <cline@frii.com> *
|
|
# * (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 GUI tools to join lines and wires.
|
|
|
|
It occasionally fails to join lines even if the lines
|
|
visually share a point. This is due to the underlying `joinWires` method
|
|
not handling the points correctly.
|
|
|
|
This is a rounding error in the comparison of the shared point;
|
|
a small difference will result in the points being considered different
|
|
and thus the lines not joining.
|
|
|
|
Test properly using `DraftVecUtils.equals` because then it will consider
|
|
the precision set in the Draft preferences.
|
|
"""
|
|
## @package gui_join
|
|
# \ingroup draftguitools
|
|
# \brief Provides GUI tools to join lines and wires.
|
|
|
|
## \addtogroup draftguitools
|
|
# @{
|
|
from PySide.QtCore import QT_TRANSLATE_NOOP
|
|
|
|
import FreeCADGui as Gui
|
|
import Draft_rc
|
|
import draftguitools.gui_base_original as gui_base_original
|
|
import draftguitools.gui_tool_utils as gui_tool_utils
|
|
|
|
from draftutils.messages import _msg
|
|
from draftutils.translate import translate, _tr
|
|
|
|
# The module is used to prevent complaints from code checkers (flake8)
|
|
True if Draft_rc.__name__ else False
|
|
|
|
|
|
class Join(gui_base_original.Modifier):
|
|
"""Gui Command for the Join tool."""
|
|
|
|
def GetResources(self):
|
|
"""Set icon, menu and tooltip."""
|
|
_tip = ("Joins the selected lines or polylines "
|
|
"into a single object.\n"
|
|
"The lines must share a common point at the start "
|
|
"or at the end for the operation to succeed.")
|
|
|
|
return {'Pixmap': 'Draft_Join',
|
|
'Accel': "J, O",
|
|
'MenuText': QT_TRANSLATE_NOOP("Draft_Join", "Join"),
|
|
'ToolTip': QT_TRANSLATE_NOOP("Draft_Join", _tip)}
|
|
|
|
def Activated(self):
|
|
"""Execute when the command is called."""
|
|
super(Join, self).Activated(name=_tr("Join"))
|
|
if not self.ui:
|
|
return
|
|
if not Gui.Selection.getSelection():
|
|
self.ui.selectUi()
|
|
_msg(translate("draft", "Select an object to join"))
|
|
self.call = self.view.addEventCallback("SoEvent",
|
|
gui_tool_utils.selectObject)
|
|
else:
|
|
self.proceed()
|
|
|
|
def proceed(self):
|
|
"""Proceed with execution of the command after proper selection.
|
|
|
|
BUG: It occasionally fails to join lines even if the lines
|
|
visually share a point. This is due to the underlying `joinWires`
|
|
method not handling the points correctly.
|
|
"""
|
|
if self.call:
|
|
self.view.removeEventCallback("SoEvent", self.call)
|
|
if Gui.Selection.getSelection():
|
|
self.print_selection()
|
|
Gui.addModule("Draft")
|
|
_cmd = "Draft.joinWires"
|
|
_cmd += "("
|
|
_cmd += "FreeCADGui.Selection.getSelection()"
|
|
_cmd += ")"
|
|
_cmd_list = ['j = ' + _cmd,
|
|
'FreeCAD.ActiveDocument.recompute()']
|
|
self.commit(translate("draft", "Join lines"),
|
|
_cmd_list)
|
|
self.finish()
|
|
|
|
def print_selection(self):
|
|
"""Print the selected items."""
|
|
labels = []
|
|
for obj in Gui.Selection.getSelection():
|
|
labels.append(obj.Label)
|
|
|
|
labels = ", ".join(labels)
|
|
_msg(_tr("Selection:") + " {}".format(labels))
|
|
|
|
|
|
Gui.addCommand('Draft_Join', Join())
|
|
|
|
## @}
|