96736db93a
It supports a new parameter `extra` that is used to provide `ExtraPlacement` for the copies of the array. Adjust the GuiCommand properly.
180 lines
7.3 KiB
Python
180 lines
7.3 KiB
Python
# ***************************************************************************
|
|
# * 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 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) *
|
|
# * 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. *
|
|
# * *
|
|
# * 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 this program; if not, write to the Free Software *
|
|
# * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 *
|
|
# * USA *
|
|
# * *
|
|
# ***************************************************************************
|
|
"""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_object, point_object, extra=None):
|
|
"""Make a Draft PointArray object.
|
|
|
|
Distribute copies of a `base_object` in the points
|
|
defined by `point_object`.
|
|
|
|
Parameters
|
|
----------
|
|
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:
|
|
|
|
- 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.
|
|
|
|
extra: Base::Placement, Base::Vector3, or Base::Rotation, optional
|
|
It defaults to `None`.
|
|
If it is provided, it is an additional placement that is applied
|
|
to each copy of the array.
|
|
The input could be a full placement, just a vector indicating
|
|
the additional translation, or just a rotation.
|
|
|
|
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`.
|
|
"""
|
|
_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
|
|
|
|
_msg("extra: {}".format(extra))
|
|
if not extra:
|
|
extra = App.Placement()
|
|
try:
|
|
utils.type_check([(extra, (App.Placement,
|
|
App.Vector,
|
|
App.Rotation))],
|
|
name=_name)
|
|
except TypeError:
|
|
_err(_tr("Wrong input: must be a placement, a vector, "
|
|
"or a rotation."))
|
|
return None
|
|
|
|
# Convert the vector or rotation to a full placement
|
|
if isinstance(extra, App.Vector):
|
|
extra = App.Placement(extra, App.Rotation())
|
|
elif isinstance(extra, App.Rotation):
|
|
extra = App.Placement(App.Vector(), extra)
|
|
|
|
new_obj = doc.addObject("Part::FeaturePython", "PointArray")
|
|
PointArray(new_obj)
|
|
new_obj.Base = base_object
|
|
new_obj.PointObject = point_object
|
|
new_obj.ExtraPlacement = extra
|
|
|
|
if App.GuiUp:
|
|
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')
|
|
|
|
return make_point_array(base, ptlst)
|