Draft: move Join GuiCommand to gui_join module

Occasionally it fails to join lines even if the lines
visually share a point.

This is a rounding error in the comparison of the shared point;
a small distance will result in the points being considered
different and thus the lines not joining.

The solution is to test properly the two points using
`DraftVecUtils.equals` which considers the value of
the `precision` set in the Draft preferences.
This commit is contained in:
vocx-fc
2020-04-07 18:57:44 -05:00
committed by Yorik van Havre
parent 58812ebbbf
commit 56f2885cb3
4 changed files with 127 additions and 32 deletions

View File

@@ -107,6 +107,7 @@ SET(Modifier_tools
draftguitools/gui_rotate.py
draftguitools/gui_offset.py
draftguitools/gui_stretch.py
draftguitools/gui_join.py
)
SET(Draft_GUI_tools

View File

@@ -801,7 +801,16 @@ def joinWires(wires, joinAttempts = 0):
def joinTwoWires(wire1, wire2):
"""joinTwoWires(object, object): joins two wires if they share a common
point as a start or an end"""
point as a start or an end.
BUG: it occasionally fails to join lines even if the lines
visually share a point.
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.
"""
wire1AbsPoints = [wire1.Placement.multVec(point) for point in wire1.Points]
wire2AbsPoints = [wire2.Placement.multVec(point) for point in wire2.Points]
if (wire1AbsPoints[0] == wire2AbsPoints[-1] and wire1AbsPoints[-1] == wire2AbsPoints[0]) \

View File

@@ -179,38 +179,9 @@ from draftguitools.gui_styles import ApplyStyle
from draftguitools.gui_rotate import Rotate
from draftguitools.gui_offset import Offset
from draftguitools.gui_stretch import Stretch
from draftguitools.gui_join import Join
class Join(Modifier):
'''The Draft_Join FreeCAD command definition.'''
def GetResources(self):
return {'Pixmap' : 'Draft_Join',
'Accel' : "J, O",
'MenuText': QtCore.QT_TRANSLATE_NOOP("Draft_Join", "Join"),
'ToolTip': QtCore.QT_TRANSLATE_NOOP("Draft_Join", "Joins two wires together")}
def Activated(self):
Modifier.Activated(self,"Join")
if not self.ui:
return
if not FreeCADGui.Selection.getSelection():
self.ui.selectUi()
FreeCAD.Console.PrintMessage(translate("draft", "Select an object to join")+"\n")
self.call = self.view.addEventCallback("SoEvent",selectObject)
else:
self.proceed()
def proceed(self):
if self.call:
self.view.removeEventCallback("SoEvent",self.call)
if FreeCADGui.Selection.getSelection():
print(FreeCADGui.Selection.getSelection())
FreeCADGui.addModule("Draft")
self.commit(translate("draft","Join"),
['Draft.joinWires(FreeCADGui.Selection.getSelection())', 'FreeCAD.ActiveDocument.recompute()'])
self.finish()
class Split(Modifier):
'''The Draft_Split FreeCAD command definition.'''
@@ -1521,7 +1492,6 @@ from draftguitools.gui_snaps import ShowSnapBar
# drawing commands
# modification commands
FreeCADGui.addCommand('Draft_Join',Join())
FreeCADGui.addCommand('Draft_Split',Split())
FreeCADGui.addCommand('Draft_Upgrade',Upgrade())
FreeCADGui.addCommand('Draft_Downgrade',Downgrade())

View File

@@ -0,0 +1,115 @@
# ***************************************************************************
# * (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 tools for joining lines with the Draft Workbench.
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 DRAFT
# \brief Provides tools for joining lines with the Draft Workbench.
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().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())