bfef06f580
This PR adds the Global mode option to the ShapeString task panel. Additionally: * Rounding of coordinates caused by reading values from the task panel is avoided. * Improved task panel layout: Height input above String input. * Some code reformatting.
280 lines
11 KiB
Python
280 lines
11 KiB
Python
# ***************************************************************************
|
|
# * Copyright (c) 2009 Yorik van Havre <yorik@uncreated.net> *
|
|
# * Copyright (c) 2020 Eliud Cabrera Castillo <e.cabrera-castillo@tum.de> *
|
|
# * Copyright (c) 2025 FreeCAD Project Association *
|
|
# * *
|
|
# * 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 the task panel code for the Draft ShapeString tool."""
|
|
## @package task_shapestring
|
|
# \ingroup drafttaskpanels
|
|
# \brief Provides the task panel code for the Draft ShapeString tool.
|
|
|
|
## \addtogroup drafttaskpanels
|
|
# @{
|
|
import PySide.QtCore as QtCore
|
|
import PySide.QtGui as QtGui
|
|
|
|
import FreeCAD as App
|
|
import FreeCADGui as Gui
|
|
import Draft_rc
|
|
import WorkingPlane
|
|
from draftguitools import gui_tool_utils
|
|
from draftutils import params
|
|
from draftutils.translate import translate
|
|
from DraftVecUtils import toString
|
|
|
|
# So the resource file doesn't trigger errors from code checkers (flake8)
|
|
True if Draft_rc.__name__ else False
|
|
|
|
|
|
class ShapeStringTaskPanel:
|
|
"""Base class for Draft_ShapeString task panel."""
|
|
|
|
def __init__(self, point=None, size=10, string="", font=""):
|
|
|
|
self.form = Gui.PySideUic.loadUi(":/ui/TaskShapeString.ui")
|
|
self.form.setObjectName("ShapeStringTaskPanel")
|
|
self.form.setWindowTitle(translate("draft", "ShapeString"))
|
|
self.form.setWindowIcon(QtGui.QIcon(":/icons/Draft_ShapeString.svg"))
|
|
|
|
unit_length = App.Units.Quantity(0.0, App.Units.Length).getUserPreferred()[2]
|
|
self.form.sbX.setProperty("unit", unit_length)
|
|
self.form.sbY.setProperty("unit", unit_length)
|
|
self.form.sbZ.setProperty("unit", unit_length)
|
|
self.form.sbHeight.setProperty("unit", unit_length)
|
|
|
|
self.global_mode = params.get_param("GlobalMode")
|
|
self.form.cbGlobalMode.setChecked(self.global_mode)
|
|
self.change_coord_labels()
|
|
|
|
self.wp = WorkingPlane.get_working_plane()
|
|
if point is not None:
|
|
self.point = point
|
|
elif self.global_mode:
|
|
self.point = App.Vector()
|
|
else:
|
|
self.point = self.wp.position
|
|
self.display_point(self.point)
|
|
self.pointPicked = False
|
|
|
|
self.form.sbHeight.setProperty("rawValue", size)
|
|
self.string = string if string else translate("draft", "Default")
|
|
self.form.leString.setText(self.string)
|
|
self.platform_win_dialog("Overwrite")
|
|
self.font_file = font if font else params.get_param("FontFile")
|
|
self.form.fcFontFile.setFileName(self.font_file)
|
|
# Prevent cyclic processing of point values:
|
|
self.display_point_active = False
|
|
# Default for the "DontUseNativeFontDialog" preference:
|
|
self.font_dialog_pref = False
|
|
# Dummy attribute used by gui_tool_utils.getPoint in action method
|
|
self.node = None
|
|
|
|
self.form.sbX.valueChanged.connect(self.set_point_x)
|
|
self.form.sbY.valueChanged.connect(self.set_point_y)
|
|
self.form.sbZ.valueChanged.connect(self.set_point_z)
|
|
self.form.cbGlobalMode.stateChanged.connect(self.set_global_mode)
|
|
self.form.fcFontFile.fileNameSelected.connect(self.set_file)
|
|
self.form.pbReset.clicked.connect(self.reset_point)
|
|
|
|
def action(self, arg):
|
|
"""scene event handler"""
|
|
if arg["Type"] == "SoKeyboardEvent":
|
|
if arg["Key"] == "ESCAPE":
|
|
self.reject()
|
|
elif arg["Type"] == "SoLocation2Event": # mouse movement detection
|
|
if not self.pointPicked:
|
|
self.point, ctrlPoint, info = gui_tool_utils.getPoint(self, arg, noTracker=True)
|
|
self.display_point(self.point)
|
|
elif arg["Type"] == "SoMouseButtonEvent":
|
|
if (arg["State"] == "DOWN") and (arg["Button"] == "BUTTON1"):
|
|
self.display_point(self.point)
|
|
self.pointPicked = True
|
|
|
|
def change_coord_labels(self):
|
|
if self.global_mode:
|
|
self.form.labelX.setText(translate("draft", "Global {}").format("X"))
|
|
self.form.labelY.setText(translate("draft", "Global {}").format("Y"))
|
|
self.form.labelZ.setText(translate("draft", "Global {}").format("Z"))
|
|
else:
|
|
self.form.labelX.setText(translate("draft", "Local {}").format("X"))
|
|
self.form.labelY.setText(translate("draft", "Local {}").format("Y"))
|
|
self.form.labelZ.setText(translate("draft", "Local {}").format("Z"))
|
|
|
|
def display_point(self, point):
|
|
"""Display the selected point."""
|
|
self.display_point_active = True
|
|
if not self.global_mode:
|
|
point = self.wp.get_local_coords(point)
|
|
self.form.sbX.setProperty("rawValue", point.x)
|
|
self.form.sbY.setProperty("rawValue", point.y)
|
|
self.form.sbZ.setProperty("rawValue", point.z)
|
|
self.display_point_active = False
|
|
|
|
def escape_string(self, string):
|
|
return string.replace("\\", "\\\\").replace("\"", "\\\"")
|
|
|
|
def platform_win_dialog(self, flag):
|
|
"""Handle the type of dialog depending on the platform."""
|
|
ParamGroup = App.ParamGet("User parameter:BaseApp/Preferences/Dialog")
|
|
if flag == "Overwrite":
|
|
if "DontUseNativeFontDialog" not in ParamGroup.GetBools():
|
|
# initialize nonexisting one
|
|
ParamGroup.SetBool("DontUseNativeFontDialog", True)
|
|
param = ParamGroup.GetBool("DontUseNativeFontDialog")
|
|
self.font_dialog_pref = ParamGroup.GetBool("DontUseNativeDialog")
|
|
ParamGroup.SetBool("DontUseNativeDialog", param)
|
|
elif flag == "Restore":
|
|
ParamGroup.SetBool("DontUseNativeDialog", self.font_dialog_pref)
|
|
|
|
def reset_point(self):
|
|
"""Reset the selected point and display new point in the task panel."""
|
|
if self.global_mode:
|
|
self.point = App.Vector()
|
|
else:
|
|
self.point = self.wp.position
|
|
self.pointPicked = False
|
|
self.display_point(self.point)
|
|
|
|
def set_file(self, val):
|
|
"""Assign the selected font file."""
|
|
self.font_file = val
|
|
|
|
def set_global_mode(self, val):
|
|
self.global_mode = bool(val)
|
|
params.set_param("GlobalMode", self.global_mode)
|
|
self.change_coord_labels()
|
|
self.display_point(self.point)
|
|
|
|
def set_point_coord(self, coord, val):
|
|
"""Change self.point based on X, Y or Z value entered in the task panel.
|
|
|
|
coord should be "x", "y" or "z".
|
|
"""
|
|
if self.display_point_active:
|
|
return
|
|
if self.global_mode:
|
|
point = self.point
|
|
else:
|
|
point = self.wp.get_local_coords(self.point)
|
|
setattr(point, coord, App.Units.Quantity(val).Value)
|
|
if self.global_mode:
|
|
self.point = point
|
|
else:
|
|
self.point = self.wp.get_global_coords(point)
|
|
|
|
def set_point_x(self, val):
|
|
self.set_point_coord("x", val)
|
|
|
|
def set_point_y(self, val):
|
|
self.set_point_coord("y", val)
|
|
|
|
def set_point_z(self, val):
|
|
self.set_point_coord("z", val)
|
|
|
|
|
|
class ShapeStringTaskPanelCmd(ShapeStringTaskPanel):
|
|
"""Task panel for Draft_ShapeString."""
|
|
|
|
def __init__(self, sourceCmd):
|
|
super().__init__()
|
|
self.sourceCmd = sourceCmd
|
|
|
|
def accept(self):
|
|
"""Execute when clicking the OK button."""
|
|
self.create_object()
|
|
self.reject()
|
|
return True
|
|
|
|
def create_object(self):
|
|
"""Create object in the current document."""
|
|
string = self.escape_string(self.form.leString.text())
|
|
size = App.Units.Quantity(self.form.sbHeight.text()).Value
|
|
|
|
Gui.addModule("Draft")
|
|
Gui.addModule("WorkingPlane")
|
|
cmd = "Draft.make_shapestring("
|
|
cmd += "String=\"" + string + "\", "
|
|
cmd += "FontFile=\"" + self.font_file + "\", "
|
|
cmd += "Size=" + str(size) + ", "
|
|
cmd += "Tracking=0.0"
|
|
cmd += ")"
|
|
self.sourceCmd.commit(
|
|
translate("draft", "Create ShapeString"),
|
|
["ss = " + cmd,
|
|
"pl = FreeCAD.Placement()",
|
|
"pl.Base = " + toString(self.point),
|
|
"pl.Rotation = WorkingPlane.get_working_plane().get_placement().Rotation",
|
|
"ss.Placement = pl",
|
|
"Draft.autogroup(ss)",
|
|
"FreeCAD.ActiveDocument.recompute()"]
|
|
)
|
|
|
|
def reject(self):
|
|
"""Run when clicking the Cancel button."""
|
|
self.sourceCmd.finish()
|
|
self.platform_win_dialog("Restore")
|
|
return True
|
|
|
|
|
|
class ShapeStringTaskPanelEdit(ShapeStringTaskPanel):
|
|
"""Task panel for Draft ShapeString object in edit mode."""
|
|
|
|
def __init__(self, vobj):
|
|
|
|
self.obj = vobj.Object
|
|
super().__init__(
|
|
self.obj.Placement.Base, self.obj.Size.Value, self.obj.String, self.obj.FontFile
|
|
)
|
|
self.pointPicked = True
|
|
self.call = Gui.activeView().addEventCallback("SoEvent", self.action)
|
|
|
|
def accept(self):
|
|
|
|
string = self.escape_string(self.form.leString.text())
|
|
size = App.Units.Quantity(self.form.sbHeight.text()).Value
|
|
|
|
Gui.doCommand("ss = FreeCAD.ActiveDocument.getObject(\"" + self.obj.Name + "\")")
|
|
Gui.doCommand("ss.String=\"" + string + "\"")
|
|
Gui.doCommand("ss.FontFile=\"" + self.font_file + "\"")
|
|
Gui.doCommand("ss.Size=" + str(size))
|
|
Gui.doCommand("ss.Placement.Base=" + toString(self.point))
|
|
Gui.doCommand("FreeCAD.ActiveDocument.recompute()")
|
|
|
|
self.reject()
|
|
return True
|
|
|
|
def finish(self):
|
|
|
|
Gui.activeView().removeEventCallback("SoEvent", self.call)
|
|
Gui.Snapper.off()
|
|
Gui.Control.closeDialog()
|
|
return None
|
|
|
|
def reject(self):
|
|
|
|
self.obj.ViewObject.Document.resetEdit()
|
|
self.platform_win_dialog("Restore")
|
|
return True
|
|
|
|
|
|
## @}
|