4fb2eb663e
This includes `make_arc_3points`, `make_array`, `make_bezcurve`, `make_block`, `make_bspline`, `make_circle`, `make_circulararray`, `make_clone`, `make_copy`, `make_dimension`, `make_drawingview`, `make_ellipse`, `make_facebinder`, `make_fillet`, `make_label`, `make_line`, `make_orthoarray`, `make_patharray`, `make_point`, `make_pointarray`, `make_polararray`, `make_polygon`, `make_rectangle`, `make_shape2dview`, `make_shapestring`, `make_sketch`, `make_text`, `make_wire`, `make_wpproxy`. These are added to the `draftmake` Doxygen group so that the functions contained in each module are listed appropriately in the automatically generated documentation.
124 lines
4.2 KiB
Python
124 lines
4.2 KiB
Python
# ***************************************************************************
|
|
# * Copyright (c) 2009, 2010 Yorik van Havre <yorik@uncreated.net> *
|
|
# * Copyright (c) 2009, 2010 Ken Cline <cline@frii.com> *
|
|
# * *
|
|
# * 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 multipoint Wire objects."""
|
|
## @package make_wire
|
|
# \ingroup draftmake
|
|
# \brief Provides functions to create multipoint Wire objects.
|
|
|
|
## \addtogroup draftmake
|
|
# @{
|
|
import FreeCAD as App
|
|
import DraftGeomUtils
|
|
import draftutils.utils as utils
|
|
import draftutils.gui_utils as gui_utils
|
|
|
|
from draftobjects.wire import Wire
|
|
|
|
if App.GuiUp:
|
|
from draftviewproviders.view_wire import ViewProviderWire
|
|
|
|
|
|
def make_wire(pointslist, closed=False, placement=None, face=None, support=None, bs2wire=False):
|
|
"""makeWire(pointslist,[closed],[placement])
|
|
|
|
Creates a Wire object from the given list of vectors. If face is
|
|
true (and wire is closed), the wire will appear filled. Instead of
|
|
a pointslist, you can also pass a Part Wire.
|
|
|
|
Parameters
|
|
----------
|
|
pointlist : [Base.Vector]
|
|
List of points to create the polyline
|
|
|
|
closed : bool
|
|
If closed is True or first and last points are identical,
|
|
the created polyline will be closed.
|
|
|
|
placement : Base.Placement
|
|
If a placement is given, it is used.
|
|
|
|
face : Bool
|
|
If face is False, the rectangle is shown as a wireframe,
|
|
otherwise as a face.
|
|
|
|
support :
|
|
TODO: Describe
|
|
|
|
bs2wire : bool
|
|
TODO: Describe
|
|
"""
|
|
if not App.ActiveDocument:
|
|
App.Console.PrintError("No active document. Aborting\n")
|
|
return
|
|
|
|
import Part
|
|
|
|
if not isinstance(pointslist, list):
|
|
e = pointslist.Wires[0].Edges
|
|
pointslist = Part.Wire(Part.__sortEdges__(e))
|
|
nlist = []
|
|
for v in pointslist.Vertexes:
|
|
nlist.append(v.Point)
|
|
if DraftGeomUtils.isReallyClosed(pointslist):
|
|
closed = True
|
|
pointslist = nlist
|
|
|
|
if len(pointslist) == 0:
|
|
print("Invalid input points: ", pointslist)
|
|
#print(pointslist)
|
|
#print(closed)
|
|
|
|
if placement:
|
|
utils.type_check([(placement, App.Placement)], "make_wire")
|
|
ipl = placement.inverse()
|
|
if not bs2wire:
|
|
pointslist = [ipl.multVec(p) for p in pointslist]
|
|
|
|
if len(pointslist) == 2:
|
|
fname = "Line"
|
|
else:
|
|
fname = "Wire"
|
|
|
|
obj = App.ActiveDocument.addObject("Part::Part2DObjectPython", fname)
|
|
Wire(obj)
|
|
obj.Points = pointslist
|
|
obj.Closed = closed
|
|
obj.Support = support
|
|
|
|
if face != None:
|
|
obj.MakeFace = face
|
|
|
|
if placement:
|
|
obj.Placement = placement
|
|
|
|
if App.GuiUp:
|
|
ViewProviderWire(obj.ViewObject)
|
|
gui_utils.format_object(obj)
|
|
gui_utils.select(obj)
|
|
|
|
return obj
|
|
|
|
|
|
makeWire = make_wire
|
|
|
|
## @}
|