Draft: move BSpline GuiCommand to gui_splines module

This commit is contained in:
vocx-fc
2020-03-30 23:38:37 -06:00
committed by Yorik van Havre
parent 3df6dab640
commit cd72ba253b
3 changed files with 201 additions and 103 deletions

View File

@@ -85,6 +85,7 @@ SET(Draft_view_providers
SET(Creator_tools
draftguitools/gui_lines.py
draftguitools/gui_splines.py
)
SET(Draft_GUI_tools

View File

@@ -152,110 +152,9 @@ from draftguitools.gui_base_original import Creator
from draftguitools.gui_lines import Line
from draftguitools.gui_lines import Wire
from draftguitools.gui_splines import BSpline
class BSpline(Line):
"""a FreeCAD command for creating a B-spline"""
def __init__(self):
Line.__init__(self,wiremode=True)
def GetResources(self):
return {'Pixmap' : 'Draft_BSpline',
'Accel' : "B, S",
'MenuText': QtCore.QT_TRANSLATE_NOOP("Draft_BSpline", "B-spline"),
'ToolTip': QtCore.QT_TRANSLATE_NOOP("Draft_BSpline", "Creates a multiple-point B-spline. CTRL to snap, SHIFT to constrain")}
def Activated(self):
Line.Activated(self,name=translate("draft","BSpline"))
if self.doc:
self.bsplinetrack = trackers.bsplineTracker()
def action(self,arg):
"""scene event handler"""
if arg["Type"] == "SoKeyboardEvent":
if arg["Key"] == "ESCAPE":
self.finish()
elif arg["Type"] == "SoLocation2Event": #mouse movement detection
self.point,ctrlPoint,info = getPoint(self,arg,noTracker=True)
self.bsplinetrack.update(self.node + [self.point])
redraw3DView()
elif arg["Type"] == "SoMouseButtonEvent":
if (arg["State"] == "DOWN") and (arg["Button"] == "BUTTON1"):
if (arg["Position"] == self.pos):
self.finish(False,cont=True)
else:
if (not self.node) and (not self.support):
getSupport(arg)
self.point,ctrlPoint,info = getPoint(self,arg,noTracker=True)
if self.point:
self.ui.redraw()
self.pos = arg["Position"]
self.node.append(self.point)
self.drawUpdate(self.point)
if (not self.isWire and len(self.node) == 2):
self.finish(False,cont=True)
if (len(self.node) > 2):
# DNC: allows to close the curve
# by placing ends close to each other
# with tol = Draft tolerance
# old code has been to insensitive
if ((self.point-self.node[0]).Length < Draft.tolerance()):
self.undolast()
self.finish(True,cont=True)
FreeCAD.Console.PrintMessage(translate("draft", "Spline has been closed")+"\n")
def undolast(self):
"""undoes last line segment"""
import Part
if (len(self.node) > 1):
self.node.pop()
self.bsplinetrack.update(self.node)
spline = Part.BSplineCurve()
spline.interpolate(self.node, False)
self.obj.Shape = spline.toShape()
FreeCAD.Console.PrintMessage(translate("draft", "Last point has been removed")+"\n")
def drawUpdate(self,point):
import Part
if (len(self.node) == 1):
self.bsplinetrack.on()
if self.planetrack:
self.planetrack.set(self.node[0])
FreeCAD.Console.PrintMessage(translate("draft", "Pick next point")+"\n")
else:
spline = Part.BSplineCurve()
spline.interpolate(self.node, False)
self.obj.Shape = spline.toShape()
FreeCAD.Console.PrintMessage(translate("draft", "Pick next point, or Finish (shift-F) or close (o)")+"\n")
def finish(self,closed=False,cont=False):
"""terminates the operation and closes the poly if asked"""
if self.ui:
self.bsplinetrack.finalize()
if not Draft.getParam("UiMode",1):
FreeCADGui.Control.closeDialog()
if self.obj:
# remove temporary object, if any
old = self.obj.Name
ToDo.delay(self.doc.removeObject, old)
if (len(self.node) > 1):
try:
# building command string
rot,sup,pts,fil = self.getStrings()
FreeCADGui.addModule("Draft")
self.commit(translate("draft","Create B-spline"),
['points = '+pts,
'spline = Draft.makeBSpline(points,closed='+str(closed)+',face='+fil+',support='+sup+')',
'Draft.autogroup(spline)',
'FreeCAD.ActiveDocument.recompute()'])
except:
print("Draft: error delaying commit")
Creator.finish(self)
if self.ui:
if self.ui.continueMode:
self.Activated()
class BezCurve(Line):
"""a FreeCAD command for creating a Bezier Curve"""
@@ -4596,7 +4495,7 @@ FreeCADGui.addCommand('Draft_Text',Text())
FreeCADGui.addCommand('Draft_Rectangle',Rectangle())
FreeCADGui.addCommand('Draft_Dimension',Dimension())
FreeCADGui.addCommand('Draft_Polygon',Polygon())
FreeCADGui.addCommand('Draft_BSpline',BSpline())
class CommandBezierGroup:
def GetCommands(self):
return tuple(['Draft_CubicBezCurve', 'Draft_BezCurve'])

View File

@@ -0,0 +1,198 @@
# ***************************************************************************
# * (c) 2009 Yorik van Havre <yorik@uncreated.net> *
# * (c) 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 creating B-Splines with the Draft Workbench.
See https://en.wikipedia.org/wiki/B-spline
"""
## @package gui_splines
# \ingroup DRAFT
# \brief Provides tools for creating B-Splines with the Draft Workbench.
from PySide.QtCore import QT_TRANSLATE_NOOP
import FreeCADGui as Gui
import draftutils.utils as utils
import draftutils.todo as todo
import draftguitools.gui_base_original as gui_base_original
import draftguitools.gui_tool_utils as gui_tool_utils
import draftguitools.gui_lines as gui_lines
import draftguitools.gui_trackers as trackers
from draftutils.messages import _msg, _err
from draftutils.translate import translate
class BSpline(gui_lines.Line):
"""Gui command for the BSpline tool."""
def __init__(self):
super().__init__(wiremode=True)
def GetResources(self):
"""Set icon, menu and tooltip."""
_tip = ("Creates a multiple-point B-spline. "
"CTRL to snap, SHIFT to constrain.")
return {'Pixmap': 'Draft_BSpline',
'Accel': "B, S",
'MenuText': QT_TRANSLATE_NOOP("Draft_BSpline", "B-spline"),
'ToolTip': QT_TRANSLATE_NOOP("Draft_BSpline", _tip)}
def Activated(self):
"""Execute when the command is called.
Activate the specific BSpline tracker.
"""
super().Activated(name=translate("draft", "BSpline"))
if self.doc:
self.bsplinetrack = trackers.bsplineTracker()
def action(self, arg):
"""Handle the 3D scene events.
This is installed as an EventCallback in the Inventor view
by the `Activated` method of the parent class.
Parameters
----------
arg: dict
Dictionary with strings that indicates the type of event received
from the 3D view.
"""
if arg["Type"] == "SoKeyboardEvent":
if arg["Key"] == "ESCAPE":
self.finish()
elif arg["Type"] == "SoLocation2Event": # mouse movement detection
(self.point,
ctrlPoint, info) = gui_tool_utils.getPoint(self, arg,
noTracker=True)
self.bsplinetrack.update(self.node + [self.point])
gui_tool_utils.redraw3DView()
elif (arg["Type"] == "SoMouseButtonEvent"
and arg["State"] == "DOWN"
and arg["Button"] == "BUTTON1"):
if arg["Position"] == self.pos:
self.finish(False, cont=True)
if (not self.node) and (not self.support):
gui_tool_utils.getSupport(arg)
(self.point,
ctrlPoint, info) = gui_tool_utils.getPoint(self, arg,
noTracker=True)
if self.point:
self.ui.redraw()
self.pos = arg["Position"]
self.node.append(self.point)
self.drawUpdate(self.point)
if not self.isWire and len(self.node) == 2:
self.finish(False, cont=True)
if len(self.node) > 2:
# DNC: allows to close the curve
# by placing ends close to each other
# with tol = Draft tolerance
# old code has been to insensitive
if (self.point - self.node[0]).Length < utils.tolerance():
self.undolast()
self.finish(True, cont=True)
_msg(translate("draft",
"Spline has been closed"))
def undolast(self):
"""Undo last line segment."""
import Part
if len(self.node) > 1:
self.node.pop()
self.bsplinetrack.update(self.node)
spline = Part.BSplineCurve()
spline.interpolate(self.node, False)
self.obj.Shape = spline.toShape()
_msg(translate("draft", "Last point has been removed"))
def drawUpdate(self, point):
"""Draw and update to the spline."""
import Part
if len(self.node) == 1:
self.bsplinetrack.on()
if self.planetrack:
self.planetrack.set(self.node[0])
_msg(translate("draft", "Pick next point"))
else:
spline = Part.BSplineCurve()
spline.interpolate(self.node, False)
self.obj.Shape = spline.toShape()
_msg(translate("draft",
"Pick next point, "
"or finish (A) or close (O)"))
def finish(self, closed=False, cont=False):
"""Terminate the operation and close the spline if asked.
Parameters
----------
closed: bool, optional
Close the line if `True`.
"""
if self.ui:
self.bsplinetrack.finalize()
if not utils.getParam("UiMode", 1):
Gui.Control.closeDialog()
if self.obj:
# Remove temporary object, if any
old = self.obj.Name
todo.ToDo.delay(self.doc.removeObject, old)
if len(self.node) > 1:
# The command to run is built as a series of text strings
# to be commited through the `draftutils.todo.ToDo` class.
try:
rot, sup, pts, fil = self.getStrings()
Gui.addModule("Draft")
_cmd = 'Draft.makeBSpline'
_cmd += '('
_cmd += 'points, '
_cmd += 'closed=' + str(closed) + ', '
_cmd += 'face=' + fil + ', '
_cmd += 'support=' + sup
_cmd += ')'
_cmd_list = ['points = ' + pts,
'spline = ' + _cmd,
'Draft.autogroup(spline)',
'FreeCAD.ActiveDocument.recompute()']
self.commit(translate("draft", "Create B-spline"),
_cmd_list)
except Exception:
_err("Draft: error delaying commit")
# `Creator` is the grandfather class, the parent of `Line`;
# we need to call it to perform final cleanup tasks.
#
# Calling it directly like this is a bit messy; maybe we need
# another method that performs cleanup (superfinish)
# that is not re-implemented by any of the child classes.
gui_base_original.Creator.finish(self)
if self.ui and self.ui.continueMode:
self.Activated()
Gui.addCommand('Draft_BSpline', BSpline())