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

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

33
from draftobjects.shapestring import ShapeString
34

35
if App.GuiUp:
36
    from draftviewproviders.view_shapestring import ViewProviderShapeString
37

38

39
def make_shapestring(String, FontFile, Size=100, Tracking=0):
40
    """ShapeString(Text,FontFile,[Height],[Track])
41

42
    Turns a text string into a Compound Shape
43

44
    Parameters
45
    ----------
46
    majradius :
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

54
    obj = App.ActiveDocument.addObject("Part::Part2DObjectPython",
55
                                       "ShapeString")
56
    ShapeString(obj)
57
    obj.String = String
58
    obj.FontFile = FontFile
59
    obj.Size = Size
60
    obj.Tracking = Tracking
61

62
    if App.GuiUp:
63
        ViewProviderShapeString(obj.ViewObject)
64
        gui_utils.format_object(obj)
65
        obrep = obj.ViewObject
66
        if "PointSize" in obrep.PropertiesList: obrep.PointSize = 1 # hide the segment end points
67
        gui_utils.select(obj)
68
    obj.recompute()
69
    return obj
70

71

72
makeShapeString = make_shapestring
73

74
## @}
75