Draft: move Rectangle GuiCommand to gui_rectangles module

This commit is contained in:
vocx-fc
2020-03-31 16:39:00 -06:00
committed by Yorik van Havre
parent 689324fe22
commit 0d891a85e3
3 changed files with 211 additions and 122 deletions

View File

@@ -87,6 +87,7 @@ SET(Creator_tools
draftguitools/gui_lines.py
draftguitools/gui_splines.py
draftguitools/gui_beziers.py
draftguitools/gui_rectangles.py
)
SET(Draft_GUI_tools

View File

@@ -156,127 +156,7 @@ from draftguitools.gui_splines import BSpline
from draftguitools.gui_beziers import BezCurve
from draftguitools.gui_beziers import CubicBezCurve
from draftguitools.gui_beziers import BezierGroup
class Rectangle(Creator):
"""the Draft_Rectangle FreeCAD command definition"""
def GetResources(self):
return {'Pixmap' : 'Draft_Rectangle',
'Accel' : "R, E",
'MenuText': QtCore.QT_TRANSLATE_NOOP("Draft_Rectangle", "Rectangle"),
'ToolTip': QtCore.QT_TRANSLATE_NOOP("Draft_Rectangle", "Creates a 2-point rectangle. CTRL to snap")}
def Activated(self):
name = translate("draft","Rectangle")
Creator.Activated(self,name)
if self.ui:
self.refpoint = None
self.ui.pointUi(name)
self.ui.extUi()
if Draft.getParam("UsePartPrimitives",False):
self.fillstate = self.ui.hasFill.isChecked()
self.ui.hasFill.setChecked(True)
self.call = self.view.addEventCallback("SoEvent",self.action)
self.rect = trackers.rectangleTracker()
FreeCAD.Console.PrintMessage(translate("draft", "Pick first point")+"\n")
def finish(self,closed=False,cont=False):
"""terminates the operation and closes the poly if asked"""
Creator.finish(self)
if self.ui:
if hasattr(self,"fillstate"):
self.ui.hasFill.setChecked(self.fillstate)
del self.fillstate
self.rect.off()
self.rect.finalize()
if self.ui.continueMode:
self.Activated()
def createObject(self):
"""creates the final object in the current doc"""
p1 = self.node[0]
p3 = self.node[-1]
diagonal = p3.sub(p1)
p2 = p1.add(DraftVecUtils.project(diagonal, plane.v))
p4 = p1.add(DraftVecUtils.project(diagonal, plane.u))
length = p4.sub(p1).Length
if abs(DraftVecUtils.angle(p4.sub(p1),plane.u,plane.axis)) > 1: length = -length
height = p2.sub(p1).Length
if abs(DraftVecUtils.angle(p2.sub(p1),plane.v,plane.axis)) > 1: height = -height
try:
# building command string
rot,sup,pts,fil = self.getStrings()
base = p1
if length < 0:
length = -length
base = base.add((p1.sub(p4)).negative())
if height < 0:
height = -height
base = base.add((p1.sub(p2)).negative())
FreeCADGui.addModule("Draft")
if Draft.getParam("UsePartPrimitives",False):
# Use Part Primitive
self.commit(translate("draft","Create Plane"),
['plane = FreeCAD.ActiveDocument.addObject("Part::Plane","Plane")',
'plane.Length = '+str(length),
'plane.Width = '+str(height),
'pl = FreeCAD.Placement()',
'pl.Rotation.Q='+rot,
'pl.Base = '+DraftVecUtils.toString(base),
'plane.Placement = pl',
'Draft.autogroup(plane)',
'FreeCAD.ActiveDocument.recompute()'])
else:
self.commit(translate("draft","Create Rectangle"),
['pl = FreeCAD.Placement()',
'pl.Rotation.Q = '+rot,
'pl.Base = '+DraftVecUtils.toString(base),
'rec = Draft.makeRectangle(length='+str(length)+',height='+str(height)+',placement=pl,face='+fil+',support='+sup+')',
'Draft.autogroup(rec)',
'FreeCAD.ActiveDocument.recompute()'])
except:
print("Draft: error delaying commit")
self.finish(cont=True)
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,mobile=True,noTracker=True)
self.rect.update(self.point)
redraw3DView()
elif arg["Type"] == "SoMouseButtonEvent":
if (arg["State"] == "DOWN") and (arg["Button"] == "BUTTON1"):
if (arg["Position"] == self.pos):
self.finish()
else:
if (not self.node) and (not self.support):
getSupport(arg)
self.point,ctrlPoint,info = getPoint(self,arg,mobile=True,noTracker=True)
if self.point:
self.ui.redraw()
self.appendPoint(self.point)
def numericInput(self,numx,numy,numz):
"""this function gets called by the toolbar when valid x, y, and z have been entered there"""
self.point = Vector(numx,numy,numz)
self.appendPoint(self.point)
def appendPoint(self,point):
self.node.append(point)
if (len(self.node) > 1):
self.rect.update(point)
self.createObject()
else:
FreeCAD.Console.PrintMessage(translate("draft", "Pick opposite point")+"\n")
self.ui.setRelative()
self.rect.setorigin(point)
self.rect.on()
if self.planetrack:
self.planetrack.set(point)
from draftguitools.gui_rectangles import Rectangle
class Arc(Creator):
@@ -4209,7 +4089,6 @@ class CommandArcGroup:
FreeCADGui.addCommand('Draft_Arc',Arc())
FreeCADGui.addCommand('Draft_ArcTools', CommandArcGroup())
FreeCADGui.addCommand('Draft_Text',Text())
FreeCADGui.addCommand('Draft_Rectangle',Rectangle())
FreeCADGui.addCommand('Draft_Dimension',Dimension())
FreeCADGui.addCommand('Draft_Polygon',Polygon())

View File

@@ -0,0 +1,209 @@
# ***************************************************************************
# * (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 rectangles with the Draft Workbench."""
## @package gui_rectangles
# \ingroup DRAFT
# \brief Provides tools for creating rectangles with the Draft Workbench.
from PySide.QtCore import QT_TRANSLATE_NOOP
import FreeCAD as App
import FreeCADGui as Gui
import DraftVecUtils
import draftutils.utils as utils
import draftguitools.gui_base_original as gui_base_original
import draftguitools.gui_tool_utils as gui_tool_utils
import draftguitools.gui_trackers as trackers
from draftutils.messages import _msg, _err
from draftutils.translate import translate
class Rectangle(gui_base_original.Creator):
"""Gui command for the Rectangle tool."""
def GetResources(self):
"""Set icon, menu and tooltip."""
_tip = "Creates a 2-point rectangle. CTRL to snap."
return {'Pixmap': 'Draft_Rectangle',
'Accel': "R, E",
'MenuText': QT_TRANSLATE_NOOP("Draft_Rectangle", "Rectangle"),
'ToolTip': QT_TRANSLATE_NOOP("Draft_Rectangle", _tip)}
def Activated(self):
"""Execute when the command is called."""
name = translate("draft", "Rectangle")
super().Activated(name)
if self.ui:
self.refpoint = None
self.ui.pointUi(name)
self.ui.extUi()
if utils.getParam("UsePartPrimitives", False):
self.fillstate = self.ui.hasFill.isChecked()
self.ui.hasFill.setChecked(True)
self.call = self.view.addEventCallback("SoEvent", self.action)
self.rect = trackers.rectangleTracker()
_msg(translate("draft", "Pick first point"))
def finish(self, closed=False, cont=False):
"""Terminate the operation.
The arguments of this function are not used and should be removed.
"""
super().finish()
if self.ui:
if hasattr(self, "fillstate"):
self.ui.hasFill.setChecked(self.fillstate)
del self.fillstate
self.rect.off()
self.rect.finalize()
if self.ui.continueMode:
self.Activated()
def createObject(self):
"""Create the final object in the current document."""
plane = App.DraftWorkingPlane
p1 = self.node[0]
p3 = self.node[-1]
diagonal = p3.sub(p1)
p2 = p1.add(DraftVecUtils.project(diagonal, plane.v))
p4 = p1.add(DraftVecUtils.project(diagonal, plane.u))
length = p4.sub(p1).Length
if abs(DraftVecUtils.angle(p4.sub(p1), plane.u, plane.axis)) > 1:
length = -length
height = p2.sub(p1).Length
if abs(DraftVecUtils.angle(p2.sub(p1), plane.v, plane.axis)) > 1:
height = -height
try:
# The command to run is built as a series of text strings
# to be commited through the `draftutils.todo.ToDo` class.
rot, sup, pts, fil = self.getStrings()
base = p1
if length < 0:
length = -length
base = base.add((p1.sub(p4)).negative())
if height < 0:
height = -height
base = base.add((p1.sub(p2)).negative())
Gui.addModule("Draft")
if utils.getParam("UsePartPrimitives", False):
# Insert a Part::Primitive object
_cmd = 'FreeCAD.ActiveDocument.'
_cmd += 'addObject("Part::Plane", "Plane")'
_cmd_list = ['plane = ' + _cmd,
'plane.Length = ' + str(length),
'plane.Width = ' + str(height),
'pl = FreeCAD.Placement()',
'pl.Rotation.Q=' + rot,
'pl.Base = ' + DraftVecUtils.toString(base),
'plane.Placement = pl',
'Draft.autogroup(plane)',
'FreeCAD.ActiveDocument.recompute()']
self.commit(translate("draft", "Create Plane"),
_cmd_list)
else:
_cmd = 'Draft.makeRectangle'
_cmd += '('
_cmd += 'length=' + str(length) + ', '
_cmd += 'height=' + str(height) + ', '
_cmd += 'placement=pl, '
_cmd += 'face=' + fil + ', '
_cmd += 'support=' + sup
_cmd += ')'
_cmd_list = ['pl = FreeCAD.Placement()',
'pl.Rotation.Q = ' + rot,
'pl.Base = ' + DraftVecUtils.toString(base),
'rec = ' + _cmd,
'Draft.autogroup(rec)',
'FreeCAD.ActiveDocument.recompute()']
self.commit(translate("draft", "Create Rectangle"),
_cmd_list)
except Exception:
_err("Draft: error delaying commit")
self.finish(cont=True)
def action(self, arg):
"""Handle the 3D scene events.
This is installed as an EventCallback in the Inventor view.
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,
mobile=True,
noTracker=True)
self.rect.update(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()
if (not self.node) and (not self.support):
gui_tool_utils.getSupport(arg)
(self.point,
ctrlPoint, info) = gui_tool_utils.getPoint(self, arg,
mobile=True,
noTracker=True)
if self.point:
self.ui.redraw()
self.appendPoint(self.point)
def numericInput(self, numx, numy, numz):
"""Validate the entry fields in the user interface.
This function is called by the toolbar or taskpanel interface
when valid x, y, and z have been entered in the input fields.
"""
self.point = App.Vector(numx, numy, numz)
self.appendPoint(self.point)
def appendPoint(self, point):
"""Append a point to the list of nodes."""
self.node.append(point)
if len(self.node) > 1:
self.rect.update(point)
self.createObject()
else:
_msg(translate("draft", "Pick opposite point"))
self.ui.setRelative()
self.rect.setorigin(point)
self.rect.on()
if self.planetrack:
self.planetrack.set(point)
Gui.addCommand('Draft_Rectangle', Rectangle())