File size: 9,638 Bytes
985c397 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 | # SPDX-License-Identifier: LGPL-2.1-or-later
# ***************************************************************************
# * (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 GUI tools to create Label objects.
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 draftguitools
# \brief Provides GUI tools to create Label objects.
## \addtogroup draftguitools
# @{
import math
from PySide.QtCore import QT_TRANSLATE_NOOP
import FreeCAD as App
import FreeCADGui as Gui
import Draft_rc
import DraftVecUtils
from draftguitools import gui_base_original
from draftguitools import gui_tool_utils
from draftguitools import gui_trackers as trackers
from draftutils import params
from draftutils.messages import _toolmsg
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."""
return {
"Pixmap": "Draft_Label",
"Accel": "D, L",
"MenuText": QT_TRANSLATE_NOOP("Draft_Label", "Label"),
"ToolTip": QT_TRANSLATE_NOOP(
"Draft_Label",
"Creates a label, optionally attached to a selected object or subelement",
),
}
def Activated(self):
"""Execute when the command is called."""
super().Activated(name="Label")
self.ghost = None
self.labeltype = params.get_param("labeltype")
self.sel = Gui.Selection.getSelectionEx()
if self.sel:
self.sel = self.sel[0]
self.ui.labelUi(title=translate("draft", self.featureName), callback=self.setmode)
self.ui.xValue.setFocus()
self.ui.xValue.selectAll()
self.ghost = trackers.lineTracker()
self.call = self.view.addEventCallback("SoEvent", self.action)
_toolmsg(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."""
from draftobjects.label import get_label_types
self.labeltype = get_label_types()[i]
params.set_param("labeltype", self.labeltype)
def finish(self, cont=False):
"""Finish the command."""
self.end_callbacks(self.call)
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
h = self.wp.u
n = self.wp.axis
r = self.wp.get_placement().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 = None
if self.sel:
sel = "FreeCAD.ActiveDocument." + self.sel.Object.Name
if self.sel.SubElementNames:
sub = "'" + self.sel.SubElementNames[0] + "'"
else:
sub = "None"
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_object=" + sel + ", "
_cmd += "subelements=" + sub + ", "
_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.get_mod_constrain_key(), 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()
_toolmsg(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()
_toolmsg(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()
_toolmsg(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()
_toolmsg(translate("draft", "Pick text position"))
else:
# third click
self.node.append(self.point)
self.create()
Draft_Label = Label
Gui.addCommand("Draft_Label", Label())
## @}
|