FreeCAD

1
# ***************************************************************************
2
# *   Copyright (c) 2009, 2010 Yorik van Havre <yorik@uncreated.net>        *
3
# *   Copyright (c) 2009, 2010 Ken Cline <cline@frii.com>                   *
4
# *   Copyright (c) 2020 FreeCAD Developers                                 *
5
# *                                                                         *
6
# *   This program is free software; you can redistribute it and/or modify  *
7
# *   it under the terms of the GNU Lesser General Public License (LGPL)    *
8
# *   as published by the Free Software Foundation; either version 2 of     *
9
# *   the License, or (at your option) any later version.                   *
10
# *   for detail see the LICENCE text file.                                 *
11
# *                                                                         *
12
# *   This program is distributed in the hope that it will be useful,       *
13
# *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
14
# *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
15
# *   GNU Library General Public License for more details.                  *
16
# *                                                                         *
17
# *   You should have received a copy of the GNU Library General Public     *
18
# *   License along with this program; if not, write to the Free Software   *
19
# *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
20
# *   USA                                                                   *
21
# *                                                                         *
22
# ***************************************************************************
23
"""Provides functions to create Facebinder objects."""
24
## @package make_facebinder
25
# \ingroup draftmake
26
# \brief Provides functions to create Facebinder objects.
27

28
## \addtogroup draftmake
29
# @{
30
import FreeCAD as App
31
import draftutils.gui_utils as gui_utils
32

33
from draftobjects.facebinder import Facebinder
34

35
if App.GuiUp:
36
    from draftviewproviders.view_facebinder import ViewProviderFacebinder
37

38

39
def make_facebinder(selectionset, name="Facebinder"):
40
    """make_facebinder(selectionset, [name])
41

42
    Creates a Facebinder object from a selection set.
43

44
    Parameters
45
    ----------
46
    selectionset :
47
        Only faces will be added.
48

49
    name : string (default = "Facebinder")
50
        Name of the created object
51
    """
52
    if not App.ActiveDocument:
53
        App.Console.PrintError("No active document. Aborting\n")
54
        return
55
    if not isinstance(selectionset,list):
56
        selectionset = [selectionset]
57
    fb = App.ActiveDocument.addObject("Part::FeaturePython",name)
58
    Facebinder(fb)
59
    if App.GuiUp:
60
        ViewProviderFacebinder(fb.ViewObject)
61
    faces = [] # unused variable?
62
    fb.Proxy.addSubobjects(fb, selectionset)
63
    gui_utils.select(fb)
64
    return fb
65

66

67
makeFacebinder = make_facebinder
68

69
## @}
70