42599838f4
This includes `array`, `base`, `bezcurve`, `block`, `bspline`, `circle`, `clone`, `dimension`, `draft_annotation`, `draftlink`, `drawingview`, `ellipse`, `facebinder`, `fillet`, `label`, `patharray`, `point`, `pointarray`, `polygon`, `rectangle`, `shape2dview`, `shapestring`, `text`, `wire`, `wwproxy`. These are added to the `draftobjects` Doxygen group so that the functions and classes contained in each module are listed appropriately in the automatically generated documentation.
433 lines
18 KiB
Python
433 lines
18 KiB
Python
# -*- coding: utf-8 -*-
|
|
# ***************************************************************************
|
|
# * Copyright (c) 2009, 2010 Yorik van Havre <yorik@uncreated.net> *
|
|
# * Copyright (c) 2009, 2010 Ken Cline <cline@frii.com> *
|
|
# * Copyright (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 the object code for the Label object."""
|
|
## @package label
|
|
# \ingroup draftobjects
|
|
# \brief Provides the object code for the Label object.
|
|
|
|
## \addtogroup draftobjects
|
|
# @{
|
|
from PySide.QtCore import QT_TRANSLATE_NOOP
|
|
|
|
import FreeCAD as App
|
|
|
|
from FreeCAD import Units as U
|
|
from draftobjects.draft_annotation import DraftAnnotation
|
|
|
|
|
|
class Label(DraftAnnotation):
|
|
"""The Draft Label object."""
|
|
|
|
def __init__(self, obj):
|
|
super(Label, self).__init__(obj, "Label")
|
|
self.set_properties(obj)
|
|
obj.Proxy = self
|
|
|
|
def set_properties(self, obj):
|
|
"""Set properties only if they don't exist."""
|
|
self.set_target_properties(obj)
|
|
self.set_leader_properties(obj)
|
|
self.set_label_properties(obj)
|
|
|
|
def set_target_properties(self, obj):
|
|
"""Set position properties only if they don't exist."""
|
|
properties = obj.PropertiesList
|
|
|
|
if "TargetPoint" not in properties:
|
|
_tip = QT_TRANSLATE_NOOP("App::Property",
|
|
"The position of the tip of the leader "
|
|
"line.\n"
|
|
"This point can be decorated "
|
|
"with an arrow or another symbol.")
|
|
obj.addProperty("App::PropertyVector",
|
|
"TargetPoint",
|
|
"Target",
|
|
_tip)
|
|
obj.TargetPoint = App.Vector(2, -1, 0)
|
|
|
|
if "Target" not in properties:
|
|
_tip = QT_TRANSLATE_NOOP("App::Property",
|
|
"Object, and optionally subelement, "
|
|
"whose properties will be displayed\n"
|
|
"as 'Text', depending on 'Label Type'.\n"
|
|
"\n"
|
|
"'Target' won't be used "
|
|
"if 'Label Type' is set to 'Custom'.")
|
|
obj.addProperty("App::PropertyLinkSub",
|
|
"Target",
|
|
"Target",
|
|
_tip)
|
|
obj.Target = None
|
|
|
|
def set_leader_properties(self, obj):
|
|
"""Set leader properties only if they don't exist."""
|
|
properties = obj.PropertiesList
|
|
|
|
if "Points" not in properties:
|
|
_tip = QT_TRANSLATE_NOOP("App::Property",
|
|
"The list of points defining the leader "
|
|
"line; normally a list of three points.\n"
|
|
"\n"
|
|
"The first point should be the position "
|
|
"of the text, that is, the 'Placement',\n"
|
|
"and the last point should be "
|
|
"the tip of the line, that is, "
|
|
"the 'Target Point'.\n"
|
|
"The middle point is calculated "
|
|
"automatically depending on the chosen\n"
|
|
"'Straight Direction' "
|
|
"and the 'Straight Distance' value "
|
|
"and sign.\n"
|
|
"\n"
|
|
"If 'Straight Direction' is set to "
|
|
"'Custom', the 'Points' property\n"
|
|
"can be set as a list "
|
|
"of arbitrary points.")
|
|
obj.addProperty("App::PropertyVectorList",
|
|
"Points",
|
|
"Leader",
|
|
_tip)
|
|
obj.Points = []
|
|
|
|
if "StraightDirection" not in properties:
|
|
_tip = QT_TRANSLATE_NOOP("App::Property",
|
|
"The direction of the straight segment "
|
|
"of the leader line.\n"
|
|
"\n"
|
|
"If 'Custom' is chosen, the points "
|
|
"of the leader can be specified by\n"
|
|
"assigning a custom list "
|
|
"to the 'Points' attribute.")
|
|
obj.addProperty("App::PropertyEnumeration",
|
|
"StraightDirection",
|
|
"Leader",
|
|
_tip)
|
|
obj.StraightDirection = ["Horizontal", "Vertical", "Custom"]
|
|
|
|
if "StraightDistance" not in properties:
|
|
_tip = QT_TRANSLATE_NOOP("App::Property",
|
|
"The length of the straight segment "
|
|
"of the leader line.\n"
|
|
"\n"
|
|
"This is an oriented distance; "
|
|
"if it is negative, the line will "
|
|
"be drawn\n"
|
|
"to the left or below the 'Text', "
|
|
"otherwise to the right or above it,\n"
|
|
"depending on the value of "
|
|
"'Straight Direction'.")
|
|
obj.addProperty("App::PropertyDistance",
|
|
"StraightDistance",
|
|
"Leader",
|
|
_tip)
|
|
obj.StraightDistance = 1
|
|
|
|
def set_label_properties(self, obj):
|
|
"""Set label properties only if they don't exist."""
|
|
properties = obj.PropertiesList
|
|
|
|
if "Placement" not in properties:
|
|
_tip = QT_TRANSLATE_NOOP("App::Property",
|
|
"The placement of the 'Text' element "
|
|
"in 3D space")
|
|
obj.addProperty("App::PropertyPlacement",
|
|
"Placement",
|
|
"Label",
|
|
_tip)
|
|
obj.Placement = App.Placement()
|
|
|
|
if "CustomText" not in properties:
|
|
_tip = QT_TRANSLATE_NOOP("App::Property",
|
|
"The text to display when 'Label Type' "
|
|
"is set to 'Custom'")
|
|
obj.addProperty("App::PropertyStringList",
|
|
"CustomText",
|
|
"Label",
|
|
_tip)
|
|
obj.CustomText = "Label"
|
|
|
|
if "Text" not in properties:
|
|
_tip = QT_TRANSLATE_NOOP("App::Property",
|
|
"The text displayed by this label.\n"
|
|
"\n"
|
|
"This property is read-only, as the "
|
|
"final text depends on 'Label Type',\n"
|
|
"and the object defined in 'Target'.\n"
|
|
"The 'Custom Text' is displayed only "
|
|
"if 'Label Type' is set to 'Custom'.")
|
|
obj.addProperty("App::PropertyStringList",
|
|
"Text",
|
|
"Label",
|
|
_tip)
|
|
obj.setEditorMode("Text", 1) # Read only
|
|
|
|
# TODO: maybe here we can define a second and third 'label type'
|
|
# properties, so that the final displayed text is either
|
|
# the first type, or the combination of two or three types,
|
|
# if they are available.
|
|
# The current system has some labels combined, but these combinations
|
|
# are hard coded. By considering multiple properties, we could produce
|
|
# arbitrary combinations of labels.
|
|
# This would also require updating the `return_info` function
|
|
# to handle any combination that we want.
|
|
if "LabelType" not in properties:
|
|
_tip = QT_TRANSLATE_NOOP("App::Property",
|
|
"The type of information displayed "
|
|
"by this label.\n"
|
|
"\n"
|
|
"If 'Custom' is chosen, the contents of "
|
|
"'Custom Text' will be used.\n"
|
|
"For other types, the string will be "
|
|
"calculated automatically from the "
|
|
"object defined in 'Target'.\n"
|
|
"'Tag' and 'Material' only work "
|
|
"for objects that have these properties, "
|
|
"like Arch objects.\n"
|
|
"\n"
|
|
"For 'Position', 'Length', and 'Area' "
|
|
"these properties will be extracted "
|
|
"from the main object in 'Target',\n"
|
|
"or from the subelement "
|
|
"'VertexN', 'EdgeN', or 'FaceN', "
|
|
"respectively, if it is specified.")
|
|
obj.addProperty("App::PropertyEnumeration",
|
|
"LabelType",
|
|
"Label",
|
|
_tip)
|
|
obj.LabelType = ["Custom", "Name", "Label", "Position",
|
|
"Length", "Area", "Volume",
|
|
"Tag", "Material",
|
|
"Label + Position", "Label + Length",
|
|
"Label + Area", "Label + Volume",
|
|
"Label + Material"]
|
|
|
|
def onDocumentRestored(self, obj):
|
|
"""Execute code when the document is restored.
|
|
|
|
It calls the parent class to add missing annotation properties.
|
|
"""
|
|
super(Label, self).onDocumentRestored(obj)
|
|
|
|
def onChanged(self, obj, prop):
|
|
"""Execute when a property is changed."""
|
|
super(Label, self).onChanged(obj, prop)
|
|
self.show_and_hide(obj, prop)
|
|
|
|
def show_and_hide(self, obj, prop):
|
|
"""Show and hide the properties depending on the touched property."""
|
|
# The minus sign removes the Hidden property (show)
|
|
if prop == "LabelType":
|
|
if obj.LabelType != "Custom":
|
|
obj.setPropertyStatus("CustomText", "Hidden")
|
|
obj.setPropertyStatus("Target", "-Hidden")
|
|
else:
|
|
obj.setPropertyStatus("CustomText", "-Hidden")
|
|
obj.setPropertyStatus("Target", "Hidden")
|
|
|
|
def execute(self, obj):
|
|
"""Execute when the object is created or recomputed."""
|
|
if obj.StraightDirection != "Custom":
|
|
p1 = obj.Placement.Base
|
|
if obj.StraightDirection == "Horizontal":
|
|
p2 = App.Vector(obj.StraightDistance.Value, 0, 0)
|
|
elif obj.StraightDirection == "Vertical":
|
|
p2 = App.Vector(0, obj.StraightDistance.Value, 0)
|
|
|
|
p2 = obj.Placement.multVec(p2)
|
|
# p3 = obj.Placement.multVec(obj.TargetPoint)
|
|
p3 = obj.TargetPoint
|
|
obj.Points = [p1, p2, p3]
|
|
else:
|
|
# If StraightDirection is 'Custom'
|
|
# we can draw the leader line manually by specifying
|
|
# any number of vectors in the Points property.
|
|
# The first point should indicate the position of the text label,
|
|
# while the last one should be 'TargetPoint'
|
|
# obj.Points = [p1, p2, p3, p4, ...]
|
|
#
|
|
# The drawing of the line is done in the viewprovider
|
|
#
|
|
# However, as soon as StraightDirection is changed to
|
|
# 'Horizontal' or 'Vertical' this custom list of points
|
|
# will be overwritten
|
|
pass
|
|
|
|
# Reset the text, only change it depending on the options
|
|
obj.Text = ""
|
|
|
|
if obj.LabelType == "Custom":
|
|
if obj.CustomText:
|
|
obj.Text = obj.CustomText
|
|
|
|
elif obj.Target and obj.Target[0]:
|
|
target = obj.Target[0]
|
|
sub_list = obj.Target[1]
|
|
typ = obj.LabelType
|
|
|
|
# The sublist may be empty so we test it first
|
|
subelement = sub_list[0] if sub_list else None
|
|
|
|
text_list = return_info(target, typ, subelement)
|
|
obj.Text = text_list
|
|
|
|
|
|
# Alias for compatibility with v0.18 and earlier
|
|
DraftLabel = Label
|
|
|
|
|
|
def return_info(target, typ, subelement=None):
|
|
"""Return the text list from the target and the given type.
|
|
|
|
Parameters
|
|
----------
|
|
target: Part::Feature
|
|
The object targeted by the label.
|
|
|
|
typ: str
|
|
It is the type of information that we want to extract.
|
|
|
|
subelement: str, optional
|
|
A string indicating a subelement of the `target`;
|
|
it could be `'VertexN'`, `'EdgeN'`, or `'FaceN'`,
|
|
where `'N'` is a number that starts from `1` up to the maximum
|
|
number of subelements in that target.
|
|
"""
|
|
# print(obj, target, typ, subelement)
|
|
|
|
if typ == "Name":
|
|
return _get_name(target)
|
|
|
|
elif typ == "Label":
|
|
return _get_label(target)
|
|
|
|
elif typ == "Tag" and hasattr(target, "Tag"):
|
|
return _get_tag(target)
|
|
|
|
elif (typ == "Material"
|
|
and hasattr(target, "Material")
|
|
and hasattr(target.Material, "Label")):
|
|
return _get_material(target)
|
|
|
|
elif (typ == "Label + Material"
|
|
and hasattr(target, "Material")
|
|
and hasattr(target.Material, "Label")):
|
|
return _get_label(target) + _get_material(target)
|
|
|
|
elif typ == "Position":
|
|
return _get_position(target, subelement)
|
|
|
|
elif typ == "Label + Position":
|
|
return _get_label(target) + _get_position(target, subelement)
|
|
|
|
elif typ == "Length" and hasattr(target, 'Shape'):
|
|
return _get_length(target, subelement)
|
|
|
|
elif typ == "Label + Length" and hasattr(target, 'Shape'):
|
|
return _get_label(target) + _get_length(target, subelement)
|
|
|
|
elif typ == "Area" and hasattr(target, 'Shape'):
|
|
return _get_area(target, subelement)
|
|
|
|
elif typ == "Label + Area" and hasattr(target, 'Shape'):
|
|
return _get_label(target) + _get_area(target, subelement)
|
|
|
|
elif (typ == "Volume"
|
|
and hasattr(target, 'Shape')
|
|
and hasattr(target.Shape, "Volume")):
|
|
return _get_volume(target)
|
|
|
|
elif (typ == "Label + Volume"
|
|
and hasattr(target, 'Shape')
|
|
and hasattr(target.Shape, "Volume")):
|
|
return _get_label(target) + _get_volume(target)
|
|
|
|
# If the type is not the correct one, or the subelement doesn't have
|
|
# the required `Shape` and information underneath, it will return
|
|
# an empty list
|
|
return [""]
|
|
|
|
|
|
def _get_name(target):
|
|
return [target.Name]
|
|
|
|
|
|
def _get_label(target):
|
|
return [target.Label]
|
|
|
|
|
|
def _get_tag(target):
|
|
return [target.Tag]
|
|
|
|
|
|
def _get_material(target):
|
|
return [target.Material.Label]
|
|
|
|
|
|
def _get_position(target, subelement):
|
|
p = target.Placement.Base
|
|
|
|
# Position of the vertex if it is given as subelement
|
|
if subelement and "Vertex" in subelement:
|
|
p = target.Shape.Vertexes[int(subelement[6:]) - 1].Point
|
|
|
|
text_list = [U.Quantity(x, U.Length).UserString for x in tuple(p)]
|
|
return text_list
|
|
|
|
|
|
def _get_length(target, subelement):
|
|
text_list = ["No length"]
|
|
if hasattr(target.Shape, "Length"):
|
|
text_list = [U.Quantity(target.Shape.Length, U.Length).UserString]
|
|
|
|
# Length of the edge if it is given as subelement
|
|
if subelement and "Edge" in subelement:
|
|
edge = target.Shape.Edges[int(subelement[4:]) - 1]
|
|
text_list = [U.Quantity(edge.Length, U.Length).UserString]
|
|
|
|
return text_list
|
|
|
|
|
|
def _get_area(target, subelement):
|
|
text_list = ["No area"]
|
|
if hasattr(target.Shape, "Area"):
|
|
area = U.Quantity(target.Shape.Area, U.Area).UserString
|
|
text_list = [area.replace("^2", "²")]
|
|
|
|
# Area of the face if it is given as subelement
|
|
if subelement and "Face" in subelement:
|
|
face = target.Shape.Faces[int(subelement[4:]) - 1]
|
|
text_list = [U.Quantity(face.Area, U.Area).UserString]
|
|
|
|
return text_list
|
|
|
|
|
|
def _get_volume(target):
|
|
volume = U.Quantity(target.Shape.Volume, U.Volume).UserString
|
|
return [volume.replace("^3", "³")]
|
|
|
|
|
|
## @}
|