Skip to content

Commit

Permalink
Draft: clean up code, PEP8, and docstrings for PointArray
Browse files Browse the repository at this point in the history 
Test the inputs to the `make_point_array` function
and return `None` if there is a problem.

Now the make function accepts as input a `"String"` which must be
the `Label` of an object in the document, so it is easier to create
arrays quickly from the Python console.

Add a message deprecating the older call `makePointArray`.

Adjust the GuiCommand accordingly. Now it uses the commit
mechanism of the parent `Modifier` class so that the executed
functions are recorded in the Python console.

Clean up the `PointArray` class as well.
  • Loading branch information
@vocx-fc @yorikvanhavre
vocx-fc authored and yorikvanhavre committed Jun 3, 2020
1 parent 6ace3e9 commit 4b65440
Show file tree
Hide file tree
Showing 3 changed files with 327 additions and 127 deletions.
107 changes: 68 additions & 39 deletions src/Mod/Draft/draftguitools/gui_pointarray.py
View file
@@ -1,7 +1,8 @@
# ***************************************************************************
# * (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> *
# * Copyright (c) 2009, 2010 Yorik van Havre <yorik@uncreated.net> *
# * Copyright (c) 2009, 2010 Ken Cline <cline@frii.com> *
# * Copyright (c) 2018 Benjamin Alterauge (ageeye) *
# * Copyright (c) 2020 Eliud Cabrera Castillo <e.cabrera-castillo@tum.de> *
# * *
# * This file is part of the FreeCAD CAx development system. *
# * *
Expand All @@ -11,13 +12,13 @@
# * 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, *
# * This program 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 *
# * License along with this program; if not, write to the Free Software *
# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *
# * USA *
# * *
Expand All @@ -26,25 +27,27 @@
The copies will be created where various points are located.
The points need to be grouped under a compound of points
before using this tool.
To create this compound, select various points and then use the Upgrade tool
to create a `Block`.
The points need to be grouped under a compound before using this tool.
To create this compound, select various points and then use the Draft Upgrade
tool to create a `Block`, or use a `Part::Compound`.
You can also create a Sketch, and place explicit points.
Other geometrical objects may be contained inside the compounds but only
the explicit point and vertex objects will be used when creating
the point array.
"""
## @package gui_patharray
## @package gui_pointarray
# \ingroup DRAFT
# \brief Provides tools for creating path arrays with the Draft Workbench.
# \brief Provides tools for creating point arrays with the Draft Workbench.

from PySide.QtCore import QT_TRANSLATE_NOOP

import FreeCAD as App
import FreeCADGui as Gui
import Draft
import Draft_rc
import draftguitools.gui_base_original as gui_base_original
import draftguitools.gui_tool_utils as gui_tool_utils
from draftutils.messages import _msg
from draftutils.translate import translate, _tr

from draftutils.messages import _err
from draftutils.translate import _tr

# The module is used to prevent complaints from code checkers (flake8)
True if Draft_rc.__name__ else False
Expand All @@ -56,47 +59,73 @@ class PointArray(gui_base_original.Modifier):
def GetResources(self):
"""Set icon, menu and tooltip."""
_menu = "Point array"
_tip = ("Creates copies of a selected object at the position "
"of various points.\n"
_tip = ("Creates copies of the selected object, "
"and places the copies at the position of various points.\n"
"\n"
"The points need to be grouped under a compound of points "
"before using this tool.\n"
"To create this compound, select various points "
"and then use the Upgrade tool to create a 'Block'.\n"
"and then use the Part Compound tool,\n"
"or use the Draft Upgrade tool to create a 'Block', "
"or create a Sketch and add simple points to it.\n"
"\n"
"Select the base object, and then select the compound "
"to create the point array.")
"or the sketch to create the point array.")

return {'Pixmap': 'Draft_PointArray',
'MenuText': QT_TRANSLATE_NOOP("Draft_PointArray", _menu),
'ToolTip': QT_TRANSLATE_NOOP("Draft_PointArray", _tip)}

def Activated(self):
"""Execute when the command is called."""
super(PointArray, self).Activated(name=_tr("Point array"))
if not Gui.Selection.getSelectionEx():
if self.ui:
self.ui.selectUi()
_msg(translate("draft",
"Please select base and pointlist objects."))
self.call = \
self.view.addEventCallback("SoEvent",
gui_tool_utils.selectObject)
else:
self.proceed()
self.name = "Point array"
super(PointArray, self).Activated(name=_tr(self.name))
# This was deactivated because it doesn't work correctly;
# the selection needs to be made on two objects, but currently
# it only selects one.

# if not Gui.Selection.getSelectionEx():
# if self.ui:
# self.ui.selectUi()
# _msg(translate("draft",
# "Please select exactly two objects, "
# "the base object and the point object, "
# "before calling this command."))
# self.call = \
# self.view.addEventCallback("SoEvent",
# gui_tool_utils.selectObject)
# else:
# self.proceed()
self.proceed()

def proceed(self):
"""Proceed with the command if one object was selected."""
if self.call:
self.view.removeEventCallback("SoEvent", self.call)

sel = Gui.Selection.getSelectionEx()
if sel:
base = sel[0].Object
ptlst = sel[1].Object

App.ActiveDocument.openTransaction("PointArray")
Draft.makePointArray(base, ptlst)
App.ActiveDocument.commitTransaction()
App.ActiveDocument.recompute()
if len(sel) != 2:
_err(_tr("Please select exactly two objects, "
"the base object and the point object, "
"before calling this command."))
else:
base_object = sel[0].Object
point_object = sel[1].Object

Gui.addModule('Draft')
_cmd = "Draft.make_point_array"
_cmd += "("
_cmd += "App.ActiveDocument." + base_object.Name + ", "
_cmd += "App.ActiveDocument." + point_object.Name + ", "
_cmd += ")"

_cmd_list = ["_obj_ = " + _cmd,
"Draft.autogroup(_obj_)",
"App.ActiveDocument.recompute()"]
self.commit(_tr(self.name), _cmd_list)

# Commit the transaction and execute the comamnds
# through the parent class
self.finish()


Expand Down
132 changes: 109 additions & 23 deletions src/Mod/Draft/draftmake/make_pointarray.py
View file
@@ -1,7 +1,11 @@
# ***************************************************************************
# * Copyright (c) 2009, 2010 Yorik van Havre <yorik@uncreated.net> *
# * Copyright (c) 2009, 2010 Ken Cline <cline@frii.com> *
# * Copyright (c) 2020 FreeCAD Developers *
# * Copyright (c) 2018 Benjamin Alterauge (ageeye) *
# * Copyright (c) 2020 Carlo Pavan <carlopav@gmail.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) *
Expand All @@ -20,47 +24,129 @@
# * USA *
# * *
# ***************************************************************************
"""This module provides the code for Draft make_point_array function.
"""Provides functions for creating point arrays.
The copies will be placed along a list of points defined by a sketch,
a `Part::Compound`, or a `Draft Block`.
"""
## @package make_pointarray
# \ingroup DRAFT
# \brief This module provides the code for Draft make_point_array function.

import FreeCAD as App

import draftutils.utils as utils
import draftutils.gui_utils as gui_utils

from draftutils.messages import _msg, _err
from draftutils.translate import _tr
from draftobjects.pointarray import PointArray

if App.GuiUp:
from draftviewproviders.view_array import ViewProviderDraftArray


def make_point_array(base, ptlst):
"""make_point_array(base,pointlist)
def make_point_array(base_object, point_object):
"""Make a Draft PointArray object.
Make a Draft PointArray object.
Distribute copies of a `base_object` in the points
defined by `point_object`.
Parameters
----------
base :
TODO: describe
base_object: Part::Feature or str
Any of object that has a `Part::TopoShape` that can be duplicated.
This means most 2D and 3D objects produced with any workbench.
If it is a string, it must be the `Label` of that object.
Since a label is not guaranteed to be unique in a document,
it will use the first object found with this label.
point_object: Part::Feature or str
An object that is a type of container for holding points.
This object must have one of the following properties `Geometry`,
`Links`, or `Components`, which themselves must contain objects
with `X`, `Y`, and `Z` properties.
This object could be:
plist :
TODO: describe
- A `Sketcher::SketchObject`, as it has a `Geometry` property.
The sketch can contain different elements but it must contain
at least one `Part::GeomPoint`.
- A `Part::Compound`, as it has a `Links` property. The compound
can contain different elements but it must contain at least
one object that has `X`, `Y`, and `Z` properties,
like a `Draft Point` or a `Part::Vertex`.
- A `Draft Block`, as it has a `Components` property. This `Block`
behaves essentially the same as a `Part::Compound`. It must
contain at least a point or vertex object.
Returns
-------
Part::FeaturePython
A scripted object of type `'PointArray'`.
Its `Shape` is a compound of the copies of the original object.
None
If there is a problem it will return `None`.
"""
obj = App.ActiveDocument.addObject("Part::FeaturePython", "PointArray")
PointArray(obj, base, ptlst)
obj.Base = base
obj.PointList = ptlst
_name = "make_point_array"
utils.print_header(_name, "Point array")

found, doc = utils.find_doc(App.activeDocument())
if not found:
_err(_tr("No active document. Aborting."))
return None

if isinstance(base_object, str):
base_object_str = base_object

found, base_object = utils.find_object(base_object, doc)
if not found:
_msg("base_object: {}".format(base_object_str))
_err(_tr("Wrong input: object not in document."))
return None

_msg("base_object: {}".format(base_object.Label))

if isinstance(point_object, str):
point_object_str = point_object

found, point_object = utils.find_object(point_object, doc)
if not found:
_msg("point_object: {}".format(point_object_str))
_err(_tr("Wrong input: object not in document."))
return None

_msg("point_object: {}".format(point_object.Label))
if (not hasattr(point_object, "Geometry")
and not hasattr(point_object, "Links")
and not hasattr(point_object, "Components")):
_err(_tr("Wrong input: point object doesn't have "
"'Geometry', 'Links', or 'Components'."))
return None

new_obj = doc.addObject("Part::FeaturePython", "PointArray")
PointArray(new_obj)
new_obj.Base = base_object
new_obj.PointList = point_object

if App.GuiUp:
ViewProviderDraftArray(obj.ViewObject)
base.ViewObject.hide()
gui_utils.formatObject(obj,obj.Base)
if len(obj.Base.ViewObject.DiffuseColor) > 1:
obj.ViewObject.Proxy.resetColors(obj.ViewObject)
gui_utils.select(obj)
return obj
ViewProviderDraftArray(new_obj.ViewObject)
gui_utils.formatObject(new_obj, new_obj.Base)

if hasattr(new_obj.Base.ViewObject, "DiffuseColor"):
if len(new_obj.Base.ViewObject.DiffuseColor) > 1:
new_obj.ViewObject.Proxy.resetColors(new_obj.ViewObject)

new_obj.Base.ViewObject.hide()
gui_utils.select(new_obj)

return new_obj


def makePointArray(base, ptlst):
"""Create PointArray. DEPRECATED. Use 'make_point_array'."""
utils.use_instead('make_point_array')

makePointArray = make_point_array
return make_point_array(base, ptlst)

0 comments on commit 4b65440

Please sign in to comment.