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 Block objects."""
24
## @package make_block
25
# \ingroup draftmake
26
# \brief Provides functions to create Block objects.
27

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

33
from draftobjects.block import Block
34

35
if App.GuiUp:
36
    from draftviewproviders.view_base import ViewProviderDraftPart
37

38

39
def make_block(objectslist):
40
    """make_block(objectslist)
41

42
    Creates a Draft Block from the given objects.
43

44
    Parameters
45
    ----------
46
    objectlist : list
47
        Major radius of the ellipse.
48

49
    """
50
    if not App.ActiveDocument:
51
        App.Console.PrintError("No active document. Aborting\n")
52
        return
53
    obj = App.ActiveDocument.addObject("Part::Part2DObjectPython","Block")
54
    Block(obj)
55
    obj.Components = objectslist
56
    if App.GuiUp:
57
        ViewProviderDraftPart(obj.ViewObject)
58
        for o in objectslist:
59
            o.ViewObject.Visibility = False
60
        gui_utils.select(obj)
61
    return obj
62

63

64
makeBlock = make_block
65

66
## @}
67