c7eab9c65e
Also perform several improvements such as PEP8 cleanup, writing complete docstrings, type checking the input arguments, and deprecating the older call. Update `Draft.py`, the Gui Command, the unit test, and test script as well.
251 lines
10 KiB
Python
251 lines
10 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 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 subelement.\n"
|
|
"\n"
|
|
"First select a vertex, an edge, or a face of an object, "
|
|
"then call this command,\n"
|
|
"and then set the position of the leader line "
|
|
"and the textual label.\n"
|
|
"The label will be able to display information "
|
|
"about this object, and about the selected subelement,\n"
|
|
"if any.\n"
|
|
"\n"
|
|
"If many objects or many subelements are selected, "
|
|
"only the first one in each case\n"
|
|
"will be used to provide information to the label.")
|
|
|
|
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(Label, self).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(Label, self).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 = DraftVecUtils.toString(targetpoint)
|
|
sel = ""
|
|
if self.sel:
|
|
if self.sel.SubElementNames:
|
|
sub = "'" + self.sel.SubElementNames[0] + "'"
|
|
else:
|
|
sub = "[]"
|
|
sel = "["
|
|
sel += "FreeCAD.ActiveDocument." + self.sel.Object.Name + ", "
|
|
sel += sub
|
|
sel += "]"
|
|
|
|
pl = "FreeCAD.Placement"
|
|
pl += "("
|
|
pl += DraftVecUtils.toString(basepoint) + ", "
|
|
pl += "FreeCAD.Rotation" + str(r.Q)
|
|
pl += ")"
|
|
|
|
Gui.addModule("Draft")
|
|
_cmd = "Draft.make_label"
|
|
_cmd += "("
|
|
_cmd += "target_point=" + tp + ", "
|
|
_cmd += "placement=" + pl + ", "
|
|
if sel:
|
|
_cmd += "target=" + sel + ", "
|
|
_cmd += "label_type=" + "'" + self.labeltype + "'" + ", "
|
|
# _cmd += "custom_text=" + "'Label'" + ", "
|
|
_cmd += "direction=" + "'" + direction + "'" + ", "
|
|
_cmd += "distance=" + str(dist)
|
|
_cmd += ")"
|
|
|
|
# Commit the creation instructions through the parent class,
|
|
# the Creator class
|
|
_cmd_list = ['_label_ = ' + _cmd,
|
|
'Draft.autogroup(_label_)',
|
|
'FreeCAD.ActiveDocument.recompute()']
|
|
self.commit(translate("draft", "Create Label"),
|
|
_cmd_list)
|
|
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())
|