Draft: set properties of the Dimension class through functions
There are three classes `DimensionBase`, `LinearDimension`, and `AngularDimension`, their properties are set only if they don't already exist. Provide also better documentation in the tooltips, and use `setPropertyStatus` to hide and show the intended properties in the property editor. The `Support` property is not used at all except as a way to store an object, so it should probably be removed in the future.
This commit is contained in:
vocx-fc
@@ -22,10 +22,17 @@
|
||||
# * USA *
|
||||
# * *
|
||||
# ***************************************************************************
|
||||
"""This module provides the object code for Draft Dimension."""
|
||||
"""Provides the object code for the Draft Dimensions.
|
||||
|
||||
This includes the `LinearDimension` and `AgularDimension`.
|
||||
The first one measures a distance between two points or vertices
|
||||
in an object; it includes radial dimensions of circular arcs.
|
||||
The second one creates an arc between two straight lines to measure
|
||||
the angle between both.
|
||||
"""
|
||||
## @package dimension
|
||||
# \ingroup DRAFT
|
||||
# \brief This module provides the object code for Draft Dimension.
|
||||
# \brief Provides the object code for the Draft Dimensions.
|
||||
|
||||
from PySide.QtCore import QT_TRANSLATE_NOOP
|
||||
|
||||
@@ -49,25 +56,81 @@ class DimensionBase(DraftAnnotation):
|
||||
|
||||
def __init__(self, obj, tp="Dimension"):
|
||||
super(DimensionBase, self).__init__(obj, tp)
|
||||
self.set_properties(obj)
|
||||
obj.Proxy = self
|
||||
|
||||
# Draft
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property", "The normal direction of this dimension")
|
||||
obj.addProperty("App::PropertyVector", "Normal", "Draft", _tip)
|
||||
def set_properties(self, obj):
|
||||
"""Set basic properties only if they don't exist."""
|
||||
properties = obj.PropertiesList
|
||||
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property", "The object measured by this dimension")
|
||||
obj.addProperty("App::PropertyLink", "Support", "Draft",_tip)
|
||||
if "Normal" not in properties:
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property",
|
||||
"The normal direction of the text "
|
||||
"of the dimension")
|
||||
obj.addProperty("App::PropertyVector",
|
||||
"Normal",
|
||||
"Dimension",
|
||||
_tip)
|
||||
obj.Normal = App.Vector(0, 0, 1)
|
||||
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property", "The geometry this dimension is linked to")
|
||||
obj.addProperty("App::PropertyLinkSubList", "LinkedGeometry", "Draft", _tip)
|
||||
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property",
|
||||
"Point on which the dimension\nline is placed.")
|
||||
obj.addProperty("App::PropertyVectorDistance", "Dimline", "Draft", _tip)
|
||||
|
||||
obj.Dimline = App.Vector(0,1,0)
|
||||
obj.Normal = App.Vector(0,0,1)
|
||||
# TODO: remove Support property as it is not used at all.
|
||||
# It is just set at creation time by the make_dimension function
|
||||
# but it is not used.
|
||||
if "Support" not in properties:
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property",
|
||||
"The object measured by this dimension "
|
||||
"object")
|
||||
obj.addProperty("App::PropertyLink",
|
||||
"Support",
|
||||
"Dimension",
|
||||
_tip)
|
||||
obj.Support = None
|
||||
|
||||
if "LinkedGeometry" not in properties:
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property",
|
||||
"The object, and specific subelements "
|
||||
"of it,\n"
|
||||
"that this dimension object "
|
||||
"is measuring.\n"
|
||||
"\n"
|
||||
"There are various possibilities:\n"
|
||||
"- An object, and one of its edges.\n"
|
||||
"- An object, and two of its vertices.\n"
|
||||
"- An arc object, and its edge.\n")
|
||||
obj.addProperty("App::PropertyLinkSubList",
|
||||
"LinkedGeometry",
|
||||
"Dimension",
|
||||
_tip)
|
||||
obj.LinkedGeometry = []
|
||||
|
||||
if "Dimline" not in properties:
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property",
|
||||
"A point through which the dimension "
|
||||
"line, or an extrapolation of it, "
|
||||
"will pass.\n"
|
||||
"\n"
|
||||
"- For linear dimensions, this property "
|
||||
"controls how close the dimension line\n"
|
||||
"is to the measured object.\n"
|
||||
"- For radial dimensions, this controls "
|
||||
"the direction of the dimension line\n"
|
||||
"that displays the measured radius or "
|
||||
"diameter.\n"
|
||||
"- For angular dimensions, "
|
||||
"this controls the radius of the "
|
||||
"dimension arc\n"
|
||||
"that displays the measured angle.")
|
||||
obj.addProperty("App::PropertyVectorDistance",
|
||||
"Dimline",
|
||||
"Dimension",
|
||||
_tip)
|
||||
obj.Dimline = App.Vector(0, 1, 0)
|
||||
|
||||
def onDocumentRestored(self, obj):
|
||||
"""Execute code when the document is restored.
|
||||
|
||||
It calls the parent class to add missing annotation properties.
|
||||
"""
|
||||
super(DimensionBase, self).onDocumentRestored(obj)
|
||||
|
||||
|
||||
@@ -76,60 +139,123 @@ class LinearDimension(DimensionBase):
|
||||
|
||||
This inherits `DimensionBase` to provide the basic functionality of
|
||||
a dimension.
|
||||
|
||||
This linear dimension includes measurements between two vertices,
|
||||
but also a radial dimension of a circular edge or arc.
|
||||
"""
|
||||
|
||||
def __init__(self, obj):
|
||||
|
||||
super(LinearDimension, self).__init__(obj, "LinearDimension")
|
||||
|
||||
super(LinearDimension, self).set_properties(obj)
|
||||
self.set_properties(obj)
|
||||
obj.Proxy = self
|
||||
|
||||
self.init_properties(obj)
|
||||
def set_properties(self, obj):
|
||||
"""Set basic properties only if they don't exist."""
|
||||
properties = obj.PropertiesList
|
||||
|
||||
if "Start" not in properties:
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property",
|
||||
"Starting point of the dimension line.\n"
|
||||
"\n"
|
||||
"If it is a radius dimension it will be "
|
||||
"the center of the arc.\n"
|
||||
"If it is a diameter dimension "
|
||||
"it will be a point that lies "
|
||||
"on the arc.")
|
||||
obj.addProperty("App::PropertyVectorDistance",
|
||||
"Start",
|
||||
"Linear/radial dimension",
|
||||
_tip)
|
||||
obj.Start = App.Vector(0, 0, 0)
|
||||
|
||||
def init_properties(self, obj):
|
||||
"""Add Linear Dimension specific properties to the object and set them"""
|
||||
if "End" not in properties:
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property",
|
||||
"Ending point of the dimension line.\n"
|
||||
"\n"
|
||||
"If it is a radius or diameter "
|
||||
"dimension\n"
|
||||
"it will be a point that lies "
|
||||
"on the arc.")
|
||||
obj.addProperty("App::PropertyVectorDistance",
|
||||
"End",
|
||||
"Linear/radial dimension",
|
||||
_tip)
|
||||
obj.End = App.Vector(1, 0, 0)
|
||||
|
||||
# Draft
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property", "Startpoint of dimension")
|
||||
obj.addProperty("App::PropertyVectorDistance", "Start", "Draft", _tip)
|
||||
if "Direction" not in properties:
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property",
|
||||
"The direction of the dimension line.\n"
|
||||
"If this remains '(0,0,0)', "
|
||||
"the direction will be calculated "
|
||||
"automatically.")
|
||||
obj.addProperty("App::PropertyVector",
|
||||
"Direction",
|
||||
"Linear/radial dimension",
|
||||
_tip)
|
||||
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property", "Endpoint of dimension")
|
||||
obj.addProperty("App::PropertyVectorDistance", "End", "Draft", _tip)
|
||||
if "Distance" not in properties:
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property",
|
||||
"The value of the measurement.\n"
|
||||
"\n"
|
||||
"This property is read-only because "
|
||||
"the value is calculated\n"
|
||||
"from the 'Start' and 'End' properties.\n"
|
||||
"\n"
|
||||
"If the 'Linked Geometry' "
|
||||
"is an arc or circle, this 'Distance'\n"
|
||||
"is the radius or diameter, depending "
|
||||
"on the 'Diameter' property.")
|
||||
obj.addProperty("App::PropertyLength",
|
||||
"Distance",
|
||||
"Linear/radial dimension",
|
||||
_tip)
|
||||
obj.Distance = 0
|
||||
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property", "The normal direction of this dimension")
|
||||
obj.addProperty("App::PropertyVector", "Direction", "Draft", _tip)
|
||||
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property", "The measurement of this dimension")
|
||||
obj.addProperty("App::PropertyLength", "Distance", "Draft", _tip)
|
||||
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property", "For arc/circle measurements, false = radius, true = diameter")
|
||||
obj.addProperty("App::PropertyBool", "Diameter", "Draft", _tip)
|
||||
|
||||
obj.Start = App.Vector(0,0,0)
|
||||
obj.End = App.Vector(1,0,0)
|
||||
if "Diameter" not in properties:
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property",
|
||||
"When measuring circular arcs, "
|
||||
"it determines whether to display\n"
|
||||
"the radius or the diameter value")
|
||||
obj.addProperty("App::PropertyBool",
|
||||
"Diameter",
|
||||
"Radial dimension",
|
||||
_tip)
|
||||
obj.Diameter = False
|
||||
|
||||
def onDocumentRestored(self, obj):
|
||||
"""Execute code when the document is restored.
|
||||
|
||||
It calls the parent class to add missing dimension properties.
|
||||
"""
|
||||
super(LinearDimension, self).onDocumentRestored(obj)
|
||||
|
||||
def onChanged(self,obj,prop):
|
||||
'''Do something when a property has changed'''
|
||||
def onChanged(self, obj, prop):
|
||||
"""Execute when a property is changed.
|
||||
|
||||
It just sets some properties to be read-only or hidden,
|
||||
as they aren't used.
|
||||
"""
|
||||
if hasattr(obj, "Distance"):
|
||||
obj.setEditorMode('Distance', 1)
|
||||
#if hasattr(obj,"Normal"):
|
||||
# obj.setEditorMode('Normal', 2)
|
||||
obj.setPropertyStatus('Distance', 'ReadOnly')
|
||||
|
||||
# if hasattr(obj, "Normal"):
|
||||
# obj.setPropertyStatus('Normal', 'Hidden')
|
||||
if hasattr(obj, "Support"):
|
||||
obj.setEditorMode('Support', 2)
|
||||
obj.setPropertyStatus('Support', 'Hidden')
|
||||
|
||||
def execute(self, obj):
|
||||
""" Set start point and end point according to the linked geometry"""
|
||||
"""Execute when the object is created or recomputed.
|
||||
|
||||
Set start point and end point according to the linked geometry.
|
||||
"""
|
||||
if obj.LinkedGeometry:
|
||||
if len(obj.LinkedGeometry) == 1:
|
||||
lobj = obj.LinkedGeometry[0][0]
|
||||
lsub = obj.LinkedGeometry[0][1]
|
||||
if len(lsub) == 1:
|
||||
if "Edge" in lsub[0]:
|
||||
n = int(lsub[0][4:])-1
|
||||
n = int(lsub[0][4:]) - 1
|
||||
edge = lobj.Shape.Edges[n]
|
||||
if DraftGeomUtils.geomType(edge) == "Line":
|
||||
obj.Start = edge.Vertexes[0].Point
|
||||
@@ -138,13 +264,13 @@ class LinearDimension(DimensionBase):
|
||||
c = edge.Curve.Center
|
||||
r = edge.Curve.Radius
|
||||
a = edge.Curve.Axis
|
||||
ray = obj.Dimline.sub(c).projectToPlane(App.Vector(0,0,0),a)
|
||||
if (ray.Length == 0):
|
||||
ray = a.cross(App.Vector(1,0,0))
|
||||
if (ray.Length == 0):
|
||||
ray = a.cross(App.Vector(0,1,0))
|
||||
ray = DraftVecUtils.scaleTo(ray,r)
|
||||
if hasattr(obj,"Diameter"):
|
||||
ray = obj.Dimline.sub(c).projectToPlane(App.Vector(0, 0, 0), a)
|
||||
if ray.Length == 0:
|
||||
ray = a.cross(App.Vector(1, 0, 0))
|
||||
if ray.Length == 0:
|
||||
ray = a.cross(App.Vector(0, 1, 0))
|
||||
ray = DraftVecUtils.scaleTo(ray, r)
|
||||
if hasattr(obj, "Diameter"):
|
||||
if obj.Diameter:
|
||||
obj.Start = c.add(ray.negative())
|
||||
obj.End = c.add(ray)
|
||||
@@ -153,8 +279,8 @@ class LinearDimension(DimensionBase):
|
||||
obj.End = c.add(ray)
|
||||
elif len(lsub) == 2:
|
||||
if ("Vertex" in lsub[0]) and ("Vertex" in lsub[1]):
|
||||
n1 = int(lsub[0][6:])-1
|
||||
n2 = int(lsub[1][6:])-1
|
||||
n1 = int(lsub[0][6:]) - 1
|
||||
n2 = int(lsub[1][6:]) - 1
|
||||
obj.Start = lobj.Shape.Vertexes[n1].Point
|
||||
obj.End = lobj.Shape.Vertexes[n2].Point
|
||||
elif len(obj.LinkedGeometry) == 2:
|
||||
@@ -164,17 +290,20 @@ class LinearDimension(DimensionBase):
|
||||
lsub2 = obj.LinkedGeometry[1][1]
|
||||
if (len(lsub1) == 1) and (len(lsub2) == 1):
|
||||
if ("Vertex" in lsub1[0]) and ("Vertex" in lsub2[1]):
|
||||
n1 = int(lsub1[0][6:])-1
|
||||
n2 = int(lsub2[0][6:])-1
|
||||
n1 = int(lsub1[0][6:]) - 1
|
||||
n2 = int(lsub2[0][6:]) - 1
|
||||
obj.Start = lobj1.Shape.Vertexes[n1].Point
|
||||
obj.End = lobj2.Shape.Vertexes[n2].Point
|
||||
|
||||
# set the distance property
|
||||
total_len = (obj.Start.sub(obj.End)).Length
|
||||
if round(obj.Distance.Value, utils.precision()) != round(total_len, utils.precision()):
|
||||
obj.Distance = total_len
|
||||
if App.GuiUp:
|
||||
if obj.ViewObject:
|
||||
obj.ViewObject.update()
|
||||
|
||||
# The lines and text are created in the viewprovider, so we should
|
||||
# update it whenever the object is recomputed
|
||||
if App.GuiUp and obj.ViewObject:
|
||||
obj.ViewObject.update()
|
||||
|
||||
|
||||
# Alias for compatibility with v0.18 and earlier
|
||||
@@ -190,47 +319,100 @@ class AngularDimension(DimensionBase):
|
||||
|
||||
def __init__(self, obj):
|
||||
super(AngularDimension, self).__init__(obj, "AngularDimension")
|
||||
self.init_properties(obj)
|
||||
super(AngularDimension, self).set_properties(obj)
|
||||
self.set_properties(obj)
|
||||
obj.Proxy = self
|
||||
|
||||
def init_properties(self, obj):
|
||||
"""Add Angular Dimension specific properties to the object and set them"""
|
||||
# Inherited properties from the parent class
|
||||
obj.Normal = App.Vector(0, 0, 1)
|
||||
obj.Dimline = App.Vector(0, 1, 0)
|
||||
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property","Start angle of the dimension")
|
||||
obj.addProperty("App::PropertyAngle", "FirstAngle", "Draft", )
|
||||
def set_properties(self, obj):
|
||||
"""Set basic properties only if they don't exist."""
|
||||
properties = obj.PropertiesList
|
||||
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property","End angle of the dimension")
|
||||
obj.addProperty("App::PropertyAngle", "LastAngle", "Draft", _tip)
|
||||
if "FirstAngle" not in properties:
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property",
|
||||
"Starting angle of the dimension line "
|
||||
"(circular arc).\n"
|
||||
"The arc is drawn counter-clockwise.")
|
||||
obj.addProperty("App::PropertyAngle",
|
||||
"FirstAngle",
|
||||
"Angular dimension",
|
||||
_tip)
|
||||
obj.FirstAngle = 0
|
||||
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property", "The center point of this dimension")
|
||||
obj.addProperty("App::PropertyVectorDistance", "Center", "Draft", _tip)
|
||||
if "LastAngle" not in properties:
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property",
|
||||
"Ending angle of the dimension line "
|
||||
"(circular arc).\n"
|
||||
"The arc is drawn counter-clockwise.")
|
||||
obj.addProperty("App::PropertyAngle",
|
||||
"LastAngle",
|
||||
"Angular dimension",
|
||||
_tip)
|
||||
obj.LastAngle = 90
|
||||
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property", "The measurement of this dimension")
|
||||
obj.addProperty("App::PropertyAngle", "Angle", "Draft", _tip)
|
||||
if "Center" not in properties:
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property",
|
||||
"The center point of the dimension "
|
||||
"line, which is a circular arc.\n"
|
||||
"\n"
|
||||
"This is normally the point where two "
|
||||
"line segments, or their extensions\n"
|
||||
"intersect, resulting in the "
|
||||
"measured 'Angle' between them.")
|
||||
obj.addProperty("App::PropertyVectorDistance",
|
||||
"Center",
|
||||
"Angular dimension",
|
||||
_tip)
|
||||
obj.Center = App.Vector(0, 0, 0)
|
||||
|
||||
obj.FirstAngle = 0
|
||||
obj.LastAngle = 90
|
||||
obj.Dimline = App.Vector(0,1,0)
|
||||
obj.Center = App.Vector(0,0,0)
|
||||
obj.Normal = App.Vector(0,0,1)
|
||||
if "Angle" not in properties:
|
||||
_tip = QT_TRANSLATE_NOOP("App::Property",
|
||||
"The value of the measurement.\n"
|
||||
"\n"
|
||||
"This property is read-only because "
|
||||
"the value is calculated from\n"
|
||||
"the 'First Angle' and "
|
||||
"'Last Angle' properties.")
|
||||
obj.addProperty("App::PropertyAngle",
|
||||
"Angle",
|
||||
"Angular dimension",
|
||||
_tip)
|
||||
obj.Angle = 0
|
||||
|
||||
def onDocumentRestored(self, obj):
|
||||
"""Execute code when the document is restored.
|
||||
|
||||
It calls the parent class to add missing dimension properties.
|
||||
"""
|
||||
super(AngularDimension, self).onDocumentRestored(obj)
|
||||
|
||||
def execute(self, fp):
|
||||
'''Do something when recompute object'''
|
||||
if fp.ViewObject:
|
||||
fp.ViewObject.update()
|
||||
def execute(self, obj):
|
||||
"""Execute when the object is created or recomputed.
|
||||
|
||||
def onChanged(self,obj,prop):
|
||||
'''Do something when a property has changed'''
|
||||
super(AngularDimension, self).onChanged(obj, prop)
|
||||
if hasattr(obj,"Angle"):
|
||||
obj.setEditorMode('Angle',1)
|
||||
if hasattr(obj,"Normal"):
|
||||
obj.setEditorMode('Normal',2)
|
||||
if hasattr(obj,"Support"):
|
||||
obj.setEditorMode('Support',2)
|
||||
Nothing is actually done here, except update the viewprovider,
|
||||
as the lines and text are created in the viewprovider.
|
||||
"""
|
||||
if App.GuiUp and obj.ViewObject:
|
||||
obj.ViewObject.update()
|
||||
|
||||
def onChanged(self, obj, prop):
|
||||
"""Execute when a property is changed.
|
||||
|
||||
It just sets some properties to be read-only or hidden,
|
||||
as they aren't used.
|
||||
"""
|
||||
if hasattr(obj, "Angle"):
|
||||
obj.setPropertyStatus('Angle', 'ReadOnly')
|
||||
|
||||
if hasattr(obj, "Normal"):
|
||||
obj.setPropertyStatus('Normal', 'Hidden')
|
||||
if hasattr(obj, "Support"):
|
||||
obj.setPropertyStatus('Support', 'Hidden')
|
||||
if hasattr(obj, "LinkedGeometry"):
|
||||
obj.setPropertyStatus('LinkedGeometry', 'Hidden')
|
||||
|
||||
|
||||
# Alias for compatibility with v0.18 and earlier
|
||||
|
||||
Reference in New Issue
Block a user