kindred/create
1
1
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects 9 Releases 2 Wiki Activity

Draft: move Label GuiCommand to gui_labels module

Browse Source 
Also include carlopav's commit ff3bdf86bc for the Draft_Label tool,
which runs the autogroup function on the created label.
This commit is contained in:
vocx-fc
2020-04-02 19:42:27 -06:00
committed by Yorik van Havre
parent d3646b0577
commit ace8c98aa8
3 changed files with 235 additions and 140 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/Mod/Draft/CMakeLists.txt
View File

@@ -97,6 +97,7 @@ SET(Creator_tools
draftguitools/gui_shapestrings.py
draftguitools/gui_points.py
draftguitools/gui_facebinders.py
draftguitools/gui_labels.py
)
SET(Draft_GUI_tools

145
src/Mod/Draft/DraftTools.py
View File

@@ -165,6 +165,7 @@ from draftguitools.gui_dimensions import Dimension
from draftguitools.gui_shapestrings import ShapeString
from draftguitools.gui_points import Point
from draftguitools.gui_facebinders import Draft_Facebinder
from draftguitools.gui_labels import Draft_Label
# ---------------------------------------------------------------------------
# Modifier functions
@@ -2596,144 +2597,9 @@ class Mirror(Modifier):
self.finish()
class Draft_Label(Creator):
"""The Draft_Label command definition"""
def GetResources(self):
return {'Pixmap' : 'Draft_Label',
'Accel' : "D, L",
'MenuText': QtCore.QT_TRANSLATE_NOOP("Draft_Label", "Label"),
'ToolTip': QtCore.QT_TRANSLATE_NOOP("Draft_Label", "Creates a label, optionally attached to a selected object or element")}
def Activated(self):
self.name = translate("draft","Label", utf8_decode=True)
Creator.Activated(self,self.name,noplanesetup=True)
self.ghost = None
self.labeltype = Draft.getParam("labeltype","Custom")
self.sel = FreeCADGui.Selection.getSelectionEx()
if self.sel:
self.sel = self.sel[0]
self.ui.labelUi(self.name,callback=self.setmode)
self.ui.xValue.setFocus()
self.ui.xValue.selectAll()
self.ghost = trackers.lineTracker()
self.call = self.view.addEventCallback("SoEvent",self.action)
FreeCAD.Console.PrintMessage(translate("draft", "Pick target point")+"\n")
self.ui.isCopy.hide()
def setmode(self,i):
self.labeltype = ["Custom","Name","Label","Position","Length","Area","Volume","Tag","Material"][i]
Draft.setParam("labeltype",self.labeltype)
def finish(self,closed=False,cont=False):
if self.ghost:
self.ghost.finalize()
Creator.finish(self)
def create(self):
if len(self.node) == 3:
targetpoint = self.node[0]
basepoint = self.node[2]
v = self.node[2].sub(self.node[1])
dist = v.Length
if hasattr(FreeCAD,"DraftWorkingPlane"):
h = FreeCAD.DraftWorkingPlane.u
n = FreeCAD.DraftWorkingPlane.axis
r = FreeCAD.DraftWorkingPlane.getRotation().Rotation
else:
h = Vector(1,0,0)
n = Vector(0,0,1)
r = FreeCAD.Rotation()
if abs(DraftVecUtils.angle(v,h,n)) <= math.pi/4:
direction = "Horizontal"
dist = -dist
elif abs(DraftVecUtils.angle(v,h,n)) >= math.pi*3/4:
direction = "Horizontal"
elif DraftVecUtils.angle(v,h,n) > 0:
direction = "Vertical"
else:
direction = "Vertical"
dist = -dist
tp = "targetpoint=FreeCAD."+str(targetpoint)+","
sel = ""
if self.sel:
if self.sel.SubElementNames:
sub = "'"+self.sel.SubElementNames[0]+"'"
else:
sub = "()"
sel="target=(FreeCAD.ActiveDocument."+self.sel.Object.Name+","+sub+"),"
pl = "placement=FreeCAD.Placement(FreeCAD."+str(basepoint)+",FreeCAD.Rotation"+str(r.Q)+")"
FreeCAD.ActiveDocument.openTransaction("Create Label")
FreeCADGui.addModule("Draft")
FreeCADGui.doCommand("l = Draft.makeLabel("+tp+sel+"direction='"+direction+"',distance="+str(dist)+",labeltype='"+self.labeltype+"',"+pl+")")
FreeCADGui.doCommand("Draft.autogroup(l)")
FreeCAD.ActiveDocument.recompute()
FreeCAD.ActiveDocument.commitTransaction()
self.finish()
def action(self,arg):
"""scene event handler"""
if arg["Type"] == "SoKeyboardEvent":
if arg["Key"] == "ESCAPE":
self.finish()
elif arg["Type"] == "SoLocation2Event":
if hasattr(FreeCADGui,"Snapper"):
FreeCADGui.Snapper.affinity = None # don't keep affinity
if len(self.node) == 2:
setMod(arg,MODCONSTRAIN,True)
self.point,ctrlPoint,info = getPoint(self,arg)
redraw3DView()
elif arg["Type"] == "SoMouseButtonEvent":
if (arg["State"] == "DOWN") and (arg["Button"] == "BUTTON1"):
if self.point:
self.ui.redraw()
if not self.node:
# first click
self.node.append(self.point)
self.ui.isRelative.show()
FreeCAD.Console.PrintMessage(translate("draft", "Pick endpoint of leader line")+"\n")
if self.planetrack:
self.planetrack.set(self.point)
elif len(self.node) == 1:
# second click
self.node.append(self.point)
if self.ghost:
self.ghost.p1(self.node[0])
self.ghost.p2(self.node[1])
self.ghost.on()
FreeCAD.Console.PrintMessage(translate("draft", "Pick text position")+"\n")
else:
# third click
self.node.append(self.point)
self.create()
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)
if not self.node:
# first click
self.node.append(self.point)
self.ui.isRelative.show()
FreeCAD.Console.PrintMessage(translate("draft", "Pick endpoint of leader line")+"\n")
if self.planetrack:
self.planetrack.set(self.point)
elif len(self.node) == 1:
# second click
self.node.append(self.point)
if self.ghost:
self.ghost.p1(self.node[0])
self.ghost.p2(self.node[1])
self.ghost.on()
FreeCAD.Console.PrintMessage(translate("draft", "Pick text position")+"\n")
else:
# third click
self.node.append(self.point)
self.create()
#---------------------------------------------------------------------------
# ---------------------------------------------------------------------------
# Snap tools
#---------------------------------------------------------------------------
# ---------------------------------------------------------------------------
from draftguitools.gui_snaps import Draft_Snap_Lock
from draftguitools.gui_snaps import Draft_Snap_Midpoint
from draftguitools.gui_snaps import Draft_Snap_Perpendicular
@@ -2751,12 +2617,11 @@ from draftguitools.gui_snaps import Draft_Snap_Dimensions
from draftguitools.gui_snaps import Draft_Snap_WorkingPlane
from draftguitools.gui_snaps import ShowSnapBar
#---------------------------------------------------------------------------
# ---------------------------------------------------------------------------
# Adds the icons & commands to the FreeCAD command manager, and sets defaults
#---------------------------------------------------------------------------
# ---------------------------------------------------------------------------
# drawing commands
FreeCADGui.addCommand('Draft_Label',Draft_Label())
# modification commands
FreeCADGui.addCommand('Draft_Move',Move())

229
src/Mod/Draft/draftguitools/gui_labels.py Normal file
View File

@@ -0,0 +1,229 @@
# ***************************************************************************
# * (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 creating labels with the Draft Workbench.
Labels are similar to text annotations but include a leader line
and an arrow in order to point to an object and indicate some of its
properties.
"""
## @package gui_labels
# \ingroup DRAFT
# \brief Provides tools for creating labels with the Draft Workbench.
import math
from PySide.QtCore import QT_TRANSLATE_NOOP
import FreeCAD as App
import FreeCADGui as Gui
import Draft_rc
import DraftVecUtils
import draftguitools.gui_base_original as gui_base_original
import draftguitools.gui_tool_utils as gui_tool_utils
import draftguitools.gui_trackers as trackers
import draftutils.utils as utils
from draftutils.messages import _msg
from draftutils.translate import translate
# The module is used to prevent complaints from code checkers (flake8)
True if Draft_rc.__name__ else False
class Label(gui_base_original.Creator):
"""Gui Command for the Label tool."""
def GetResources(self):
"""Set icon, menu and tooltip."""
_tip = ("Creates a label, "
"optionally attached to a selected object or element.")
return {'Pixmap': 'Draft_Label',
'Accel': "D, L",
'MenuText': QT_TRANSLATE_NOOP("Draft_Label", "Label"),
'ToolTip': QT_TRANSLATE_NOOP("Draft_Label", _tip)}
def Activated(self):
"""Execute when the command is called."""
self.name = translate("draft", "Label")
super().Activated(self.name, noplanesetup=True)
self.ghost = None
self.labeltype = utils.getParam("labeltype", "Custom")
self.sel = Gui.Selection.getSelectionEx()
if self.sel:
self.sel = self.sel[0]
self.ui.labelUi(self.name, callback=self.setmode)
self.ui.xValue.setFocus()
self.ui.xValue.selectAll()
self.ghost = trackers.lineTracker()
self.call = self.view.addEventCallback("SoEvent", self.action)
_msg(translate("draft", "Pick target point"))
self.ui.isCopy.hide()
def setmode(self, i):
"""Set the type of label, if it is associated to an object."""
self.labeltype = ["Custom", "Name", "Label", "Position",
"Length", "Area", "Volume", "Tag", "Material"][i]
utils.setParam("labeltype", self.labeltype)
def finish(self, closed=False, cont=False):
"""Finish the command."""
if self.ghost:
self.ghost.finalize()
super().finish()
def create(self):
"""Create the actual object."""
if len(self.node) == 3:
targetpoint = self.node[0]
basepoint = self.node[2]
v = self.node[2].sub(self.node[1])
dist = v.Length
if hasattr(App, "DraftWorkingPlane"):
h = App.DraftWorkingPlane.u
n = App.DraftWorkingPlane.axis
r = App.DraftWorkingPlane.getRotation().Rotation
else:
h = App.Vector(1, 0, 0)
n = App.Vector(0, 0, 1)
r = App.Rotation()
if abs(DraftVecUtils.angle(v, h, n)) <= math.pi/4:
direction = "Horizontal"
dist = -dist
elif abs(DraftVecUtils.angle(v, h, n)) >= math.pi*3/4:
direction = "Horizontal"
elif DraftVecUtils.angle(v, h, n) > 0:
direction = "Vertical"
else:
direction = "Vertical"
dist = -dist
tp = "targetpoint=FreeCAD." + str(targetpoint) + ", "
sel = ""
if self.sel:
if self.sel.SubElementNames:
sub = "'" + self.sel.SubElementNames[0] + "'"
else:
sub = "()"
sel = "target="
sel += "("
sel += "FreeCAD.ActiveDocument." + self.sel.Object.Name + ", "
sel += sub
sel += "),"
pl = "placement=FreeCAD.Placement"
pl += "("
pl += "FreeCAD." + str(basepoint) + ", "
pl += "FreeCAD.Rotation" + str(r.Q)
pl += ")"
App.ActiveDocument.openTransaction("Create Label")
Gui.addModule("Draft")
_cmd = "Draft.makeLabel"
_cmd += "("
_cmd += tp
_cmd += sel
_cmd += "direction='" + direction + "', "
_cmd += "distance=" + str(dist) + ", "
_cmd += "labeltype='" + self.labeltype + "', "
_cmd += pl
_cmd += ")"
Gui.doCommand("l = " + _cmd)
Gui.doCommand("Draft.autogroup(l)")
App.ActiveDocument.recompute()
App.ActiveDocument.commitTransaction()
self.finish()
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":
if hasattr(Gui, "Snapper"):
Gui.Snapper.affinity = None # don't keep affinity
if len(self.node) == 2:
gui_tool_utils.setMod(arg, gui_tool_utils.MODCONSTRAIN, True)
self.point, ctrlPoint, info = gui_tool_utils.getPoint(self, arg)
gui_tool_utils.redraw3DView()
elif arg["Type"] == "SoMouseButtonEvent":
if (arg["State"] == "DOWN") and (arg["Button"] == "BUTTON1"):
if self.point:
self.ui.redraw()
if not self.node:
# first click
self.node.append(self.point)
self.ui.isRelative.show()
_msg(translate("draft",
"Pick endpoint of leader line"))
if self.planetrack:
self.planetrack.set(self.point)
elif len(self.node) == 1:
# second click
self.node.append(self.point)
if self.ghost:
self.ghost.p1(self.node[0])
self.ghost.p2(self.node[1])
self.ghost.on()
_msg(translate("draft", "Pick text position"))
else:
# third click
self.node.append(self.point)
self.create()
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)
if not self.node:
# first click
self.node.append(self.point)
self.ui.isRelative.show()
_msg(translate("draft", "Pick endpoint of leader line"))
if self.planetrack:
self.planetrack.set(self.point)
elif len(self.node) == 1:
# second click
self.node.append(self.point)
if self.ghost:
self.ghost.p1(self.node[0])
self.ghost.p2(self.node[1])
self.ghost.on()
_msg(translate("draft", "Pick text position"))
else:
# third click
self.node.append(self.point)
self.create()
Draft_Label = Label
Gui.addCommand('Draft_Label', Label())