160 lines
6.5 KiB
Python
160 lines
6.5 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 to create PointArray objects.
|
|
|
|
The copies will be created at the points of a point object.
|
|
"""
|
|
## @package make_pointarray
|
|
# \ingroup draftmake
|
|
# \brief Provides functions to create PointArray objects.
|
|
|
|
## \addtogroup draftmake
|
|
# @{
|
|
import FreeCAD as App
|
|
import draftutils.utils as utils
|
|
import draftutils.gui_utils as gui_utils
|
|
|
|
from draftutils.messages import _err
|
|
from draftutils.translate import translate
|
|
from draftobjects.pointarray import PointArray
|
|
|
|
if App.GuiUp:
|
|
from draftviewproviders.view_array import ViewProviderDraftArray
|
|
from draftviewproviders.view_draftlink import ViewProviderDraftLink
|
|
|
|
|
|
def make_point_array(base_object, point_object, extra=None, use_link=True):
|
|
"""Make a Draft PointArray object.
|
|
|
|
Create copies of a `base_object` at the points defined by
|
|
a `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, Sketcher::SketchObject, Mesh::Feature,
|
|
Points::FeatureCustom or str
|
|
The object must have vertices and/or points.
|
|
|
|
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"
|
|
|
|
found, doc = utils.find_doc(App.activeDocument())
|
|
if not found:
|
|
_err(translate("draft", "No active document. Aborting."))
|
|
return None
|
|
|
|
found, base_object = utils.find_object(base_object, doc)
|
|
if not found:
|
|
_err(translate("draft", "Wrong input: base_object not in document."))
|
|
return None
|
|
|
|
found, point_object = utils.find_object(point_object, doc)
|
|
if not found:
|
|
_err(translate("draft", "Wrong input: point_object not in document."))
|
|
return None
|
|
|
|
if not ((hasattr(point_object, "Shape") and hasattr(point_object.Shape, "Vertexes"))
|
|
or hasattr(point_object, "Mesh")
|
|
or hasattr(point_object, "Points")):
|
|
_err(translate("draft", "Wrong input: object has the wrong type."))
|
|
return None
|
|
|
|
if not extra:
|
|
extra = App.Placement()
|
|
|
|
try:
|
|
utils.type_check([(extra, (App.Placement,
|
|
App.Vector,
|
|
App.Rotation))],
|
|
name=_name)
|
|
except TypeError:
|
|
_err(translate("draft", "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)
|
|
|
|
if use_link:
|
|
# The PointArray class must be called in this special way
|
|
# to make it a LinkArray
|
|
new_obj = doc.addObject("Part::FeaturePython", "PointArray",
|
|
PointArray(None), None, True)
|
|
else:
|
|
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:
|
|
if use_link:
|
|
ViewProviderDraftLink(new_obj.ViewObject)
|
|
else:
|
|
new_obj.Proxy.execute(new_obj) # Updates Count which is required for correct DiffuseColor.
|
|
ViewProviderDraftArray(new_obj.ViewObject)
|
|
gui_utils.format_object(new_obj, new_obj.Base)
|
|
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)
|
|
|
|
## @}
|